SchemaPaymentsSubscriptions

List subscriptions

Use this method to return a paginated list of subscriptions.

Note: If you want to view the details of 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

processingTerminalIdstringRequired>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Idempotency-KeystringRequiredformat: "uuid"

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

customerNamestringOptional>=1 character<=50 characters
Filter by the customer's name.
last4stringOptionalformat: "[0-9]{4}"
Filter by the last four digits of the card or account number.
paymentPlanstringOptional>=1 character<=128 characters
Filter by the name of the payment plan.
frequencyenumOptional
Filter by the frequency of subscription payments.
Allowed values:
statusenumOptional
Filter by the current status of the subscription.
Allowed values:
endDatedateOptional

Format: YYYY-MM-DD
Filter subscriptions that end on a specific date.

nextDueDatedateOptional

Format: YYYY-MM-DD
Filter subscriptions by the date that the next payment is collected.

beforestringOptional

Return the previous page of results before the value that you specify.

You can’t send a before parameter in the same request as an after parameter.

afterstringOptional

Return the next page of results after the value that you specify.

You can’t send an after parameter in the same request as a before parameter.

limitintegerOptional<=100Defaults to 10
Limit the maximum number of results that we return for each page.

Response

Successful request. Returns a paginated list of subscriptions.
limitdouble
Maximum number of results that we return for each page.
countdouble

Number of results we returned on this page.

Note: This might not be the total number of results that match your query.

hasMoreboolean
Indicates whether there is another page of results available.
datalist of objects
Array of subscriptions.

Errors