Skip to content
Snippets Groups Projects
Commit f91e1878 authored by mattwire's avatar mattwire
Browse files

Add skeleton docs

parent 30fe27e1
No related branches found
No related tags found
No related merge requests found
# Stripe Import
Provides a set of API functions to import Stripe Customers / Subscriptions / Charges.
These can be used in scripts, manually or as a scheduled job.
The extension is licensed under [AGPL-3.0](LICENSE.txt).
## Installation
Learn more about installing CiviCRM extensions in the [CiviCRM Sysadmin Guide](https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/).
### You must use the "import" branch of the Stripe extension:
https://lab.civicrm.org/extensions/stripe/-/tree/import
### You must apply API4 MembershipLog patch:
https://github.com/civicrm/civicrm-core/pull/28220
### To disable membership updates make sure you have applied:
https://github.com/civicrm/civicrm-core/pull/28607
## Getting Started
## Known Issues
### Subscription import for memberships renews the membership.
This is because Payment.create triggers a "Contribution Completion"
which in turn triggers a membership renewal.
Workaround: https://github.com/civicrm/civicrm-core/pull/28607
But we'll need a way to conditionally enable/disable this as in "normal" operation
we *should* renew the membership. But for initial import we don't want to.
## Customisation
You can listen to the following events to customise the import process:
### civi.stripeimport.startimport
*Currently only implemented for subscription import*
This event is dispatched at the start of each import.
It can be used to setup or change things before processing import.
For example, you could remove the default listener for `civi.stripeimport.membershipauto` in order to modify the default processing.
### civi.stripeimport.membershipauto
*Currently only implemented for subscription import*
This event is dispatched if membershipauto is selected as an input parameter and no membership ID is specified.
A default listener is implemented in `\Civi\StripeImport\MembershipSubscriber` which will
select the membership linked to the recur if available or the latest current membership by ID.
## Information
Releases use the following numbering system:
**{major}.{minor}.{incremental}**
* major: Major refactoring or rewrite - make sure you read and test very carefully!
* minor: Breaking change in some circumstances, or a new feature. Read carefully and make sure you understand the impact of the change.
* incremental: A "safe" change / improvement. Should *always* be safe to upgrade.
* **[BC]**: Items marked with [BC] indicate a breaking change that will require updates to your code if you are using that code in your extension.
## Release 1.0 (not yet released)
Initial release.
......@@ -13,11 +13,11 @@
<url desc="Support">https://mjw.pt/stripeimport</url>
<url desc="Licensing">http://www.gnu.org/licenses/agpl-3.0.html</url>
</urls>
<releaseDate>2023-12-11</releaseDate>
<version>0.2</version>
<releaseDate>2024-01-18</releaseDate>
<version>0.3</version>
<develStage>beta</develStage>
<compatibility>
<ver>5.65</ver>
<ver>5.68</ver>
</compatibility>
<classloader>
<psr0 prefix="CRM_" path="."/>
......
site_name: Importers for Stripe Payment Processor
repo_url: https://lab.civicrm.org/extensions/stripeimport
theme:
name: material
markdown_extensions:
- attr_list
- admonition
- def_list
- codehilite
- toc:
permalink: true
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.tilde
- pymdownx.betterem
- pymdownx.mark
nav:
- About: index.md
- Release Notes: releasenotes.md
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment