Skip to main content
GET
cURL

Authorizations

X-Delegated-Token
string
header
required

Headers

X-Tenant-ID
string
required

Unique identifier of the tenant in the system (usually a store identifier)

Query Parameters

query
string

Search query. Terms are field:value; comparisons field:>value, :<, :>=, :<=. A bare value without a field is a full-text prefix search. Several bare words in a row are one phrase, as if quoted: the words next to each other, in that order. Quote values in single or double quotes unless they are only letters and digits, with single dots between them, or a UUID as a filter value. Combine terms with AND (binds tighter) and OR, group with parentheses, negate a term or group with NOT or a leading -. status values are case-insensitive. Fields: id, serial, status, createdAt, updatedAt, nextBillingDate, canceledAt. Example: status:active AND nextBillingDate:>="2026-01-01". See search query language and the field reference.

limit
integer
default:20

See pagination for more details on how to paginate the results.

Required range: 1 <= x <= 100
after
string

See pagination for more details on how to paginate the results.

Minimum string length: 1
before
string

See pagination for more details on how to paginate the results.

Minimum string length: 1
sort
string
default:createdAt:asc

See sorting for more details on how to sort the results.

includeCanceledItems
boolean
default:false

Whether to include canceled subscriptions in the results.

expand
enum<string>[]

Specify which related resources to include in the response. Currently supports 'paymentMethod'.

Available options:
paymentMethod

Response

200 - application/json

Default Response

resource
enum<string>
required
Available options:
list
hasNextPage
boolean
required
hasPrevPage
boolean
required
endCursor
null | string
required
startCursor
null | string
required
data
Subscription · object[]
required