How to get started with the API
Use the eCurring dashboard to add your subscription plans (products) through a simple interface. The subscription plans are fully customizable, for example:
- Set the amount for each payment in a subscription plan
- Set the interval for the payment (monthly, yearly, etc.), and on which day the payment should be processed
- Allow SEPA Direct Debit and / or credit card payments
- Configure automatic retries of failed direct debit transactions
- Configure automatic payment reminders with a payment link by mail after a (final) chargeback
- Configure automatic invoicing
- Configure the mandate verification method (either through a bank payment, credit card payment, a confirmation email or a confirmation text message)
Once you've created a subscription plan in your eCurring account you're ready to create a subscription via the API.
A subscription is a customer that has a relationship with a subscription plan (subscription_plan + customer = subscription).
Here's what a common workflow with the eCurring API looks like:
- Create a customer
-
Create a subscription using the
customer_idandsubscription_plan_id - Once the mandate has been signed: eCurring schedules all transactions (this can take up to 10 minutes)
- eCurring processes the transaction on the due date
- Get the transactions for the subscription and Get the transaction (for example, to check the payment status of the latest transaction)
- Update the subscription to change the status of a subscription. For example, you can pause or cancel a subscription in case there are too many chargebacks or upon the request of the customer