Sign in
Subscriptions

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.

get/processing-terminals/{processingTerminalId}/subscriptions

Path parameters

processingTerminalIdstring required

Unique identifier that we assigned to the terminal.

Query parameters

customerNamestring

Filter by the customer's name.

last4string

Filter by the last four digits of the card or account number.

paymentPlanstring

Filter by the name of the payment plan.

frequency'weekly' | 'fortnightly' | 'monthly' | 'quarterly' | 'yearly'

Filter by the frequency of subscription payments.

status'active' | 'completed' | 'suspended' | 'cancelled'

Filter by the current status of the subscription.

endDatestring date

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

nextDueDatestring date

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

beforestring

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

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

afterstring

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

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

limitinteger

Limit the maximum number of results that we return for each page.

Headers

Authorizationstring required

Bearer authentication

Response

Successful request. Returns a paginated list of subscriptions.

limitinteger required

Maximum number of results that we return for each page.

countinteger required

Number of results we returned on this page.

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

hasMoreboolean required

Indicates whether there is another page of results available.

Changes