Creates a recurring payment as a subscription or payment plan. For guides to using this endpoint, see the Recurring billing overview topic.
A successful request to this endpoint processes an initial transaction using a saved card token and schedules recurring transactions. All transactions are processed with the values provided in the payment object or the data saved in the card token. The scheduled transaction runs according to the values provided in the schedule object.
Also, in order to have a customer skip a month for an existing subscription or payment plan, you need to delete the current one and then recreate it to start with an initialBillingAmount of 0 and have the dateInitialBillingEnd happen a month before the next scheduled payment.
Note
If the initial transaction is declined, the subscription or payment plan will not be created. It must be re-created with a new card token.
After the subscription or payment plan is created, if a subsequent transaction gets declined or has an error, the system retries the transaction up to three times, one minute apart. On the third failure, the system stops trying for that installment, the subscription or payment plan remains active, and the system tries again at the next scheduled payment date. In this instance, the merchant would need to contact the customer about the missed payment or transaction. Also, if you have webhooks configured, you will receive a webhook for each of the failures. For additional information about this, see the Creating a Nexio-scheduled card subscription or Creating a Nexio-scheduled card payment plan tutorial.
However, with Decline recovery and when the subscription or payment plan was created with the
retryOnSoftDeclineparameter, instead of doing the three retries at a minute apart, the system retries according to the recommendation received from the Decline recovery system.
Try It
To use the Try It feature for this endpoint, you can use the credentials for your Sandbox API user.
You can also use the following test account. Copy the value and paste it into the appropriate space in the Try It section to the right.
username:[email protected]
password:JZdzoXpdDeH6VA
Include at least a saved card token in thetokenex.tokenparameter, the amount and currency for the transaction, the payment type, and a customer reference number. You can also include the appropriate subscription parameters.