Recurring Contributions¶
A CiviCRM Recurring Contribution is the equivalent of a Stripe Subscription.
The CiviCRM Recurring Contribution trxn_id
= Stripe subscription ID
.
When you create a recurring contribution in CiviCRM using the Stripe payment processor it is linked via the trxn_id to a Stripe subscription.
If you are using recurring contributions make sure you have webhooks configured correctly
See Webhooks
Starting a Recurring contribution in the future¶
If you would like your users to be able to specify a future recurring start date you can enable
Enable public selection of future recurring start dates for intervals
in Administer->CiviContribute->Stripe Settings.
Then your users will see an option to select a start date for the contribution:
Or if memberships are enabled on the form (example here for a single future start date on the 1st of the month):
Cancelling Recurring Contributions¶
You can cancel a recurring contribution from the Stripe Dashboard or from within CiviCRM.
In Stripe¶
- Go to Customers and then to the specific customer.
- Inside the customer you will see a Subscriptions section.
- Click Cancel on the subscription you want to cancel.
- Stripe.com will cancel the subscription, send a webhook to your site and the recurring contribution will be marked as "Cancelled" in CiviCRM.
In CiviCRM¶
- Click the "Cancel" link next to the recurring contribution.
- Select the option to Send cancellation request to Stripe? and click Cancel.
- Stripe.com will cancel the subscription, send a webhook to your site and the recurring contribution will be marked as "Cancelled" in CiviCRM.
Recurring statuses¶
Recurring contributions start in the status "Pending".
The Stripe subscription status is mapped to the recurring contribution status as follows:
- STATUS_INCOMPLETE => Pending
- STATUS_ACTIVE => In Progress
- STATUS_TRIALING => In Progress
- STATUS_PAST_DUE => Overdue
- STATUS_CANCELED / STATUS_UNPAID / STATUS_INCOMPLETE_EXPIRED => Cancelled