List subscriptions
Use this method to return a paginated list of subscriptions.
Note: If you want to view a specific subscription and you have its subscriptionId, use our Retrieve subscription method.
Use query parameters to filter the list of results that we return, for example, to search for subscriptions for a customer, a payment plan, or frequency.
Our gateway returns information about the following for each subscription in the list:
- Payment plan the subscription is linked to.
- Secure token that represents cardholder’s payment details.
- Current state of the subscription, including its status, next due date, and invoices.
- Fees for setup and the cost of the recurring order.
- Subscription length, end date, and frequency.
For each subscription, we also return the subscriptionId, the paymentPlanId, and the secureTokenId, which you can use to perform follow-actions.
Path parameters
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.
Query parameters
Format: YYYY-MM-DD
Filter subscriptions that end on a specific date.
Format: YYYY-MM-DD
Filter subscriptions by the date that the next payment is collected.