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 intial 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.
Note
If the initial transaction is declined, the subscription will not be created. It must be re-created with a new card token.
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, and a customer reference number. You can also include the appropriate subscription parameters.