SchemaPaymentsSubscriptions

List subscriptions

List subscriptions linked to a terminal.
To filter your results, use the query parameters.

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-KeystringRequired

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:
endDatestringOptionalformat: "date"

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

nextDueDatestringOptionalformat: "date"

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

beforestringOptional

Points to the resource identifier that you want to receive your results before. Typically, this is the first resource on the previous page.

afterstringOptional

Points to the resource identifier that you want to receive your results after. Typically, this is the last resource on the previous page.

limitintegerOptional<=100Defaults to 10

States the total amount of results the response is limited to.

Response

Successful request. Returns a paginated list of subscriptions.

datalist of objects

Array of subscriptions.

countintegerOptional

Number of results that we returned.

hasMorebooleanOptional

Indicates that further results are available.

limitintegerOptional

Maximum number of results that we return for each page.