Subscriptions overview
Important: Before you can use the Subscriptions endpoints, you need to integrate with the Payment Plans endpoints and the Secure Tokens endpoints.
Use our Subscriptions endpoints to take repeat payments from customers.
Integrate with our Create Subscription method to assign a customer to a payment plan and take repeat payments. The Create Subscription request contains the following details:
- ID of the payment plan that the merchant wants to use.
- Secure token that represents the customer’s payment details.
- (Optional) Adjustments that override details of the payment plan.
When you create a subscription, you also need to provide a subscriptionId, which you can use to complete the following actions:
Retrieve the details of the subscription
Integrate with our Retrieve Subscription method to view details of the subscription, including the amount for each payment, start date, and payment schedule.
Integrate with our List Subscription method to return a paginated list of subscriptions that meet specific query parameters.
Update the subscription
Integrate with our Update Subscription method to update the details of the subscription, for example, increase the amount for each payment.
Stop the subscription
Integrate with our Deactivate Subscription method to stop taking payments from the customer. If you want to start taking payments again, integrate with our Re-activate Subscription method.
Manually collect a payment for the subscription
Integrate with the Pay Manual Subscription method to manually collect a payment.