Skip to main content
GET
List company subscriptions

Authorizations

Authorization
string
header
required

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

Query Parameters

page[cursor]
string

Cursor token from the previous response page.

page[limit]
integer

Number of subscriptions to return.

Required range: 1 <= x <= 100
sort
enum<string>

Sort order. Prefix with - to reverse. amount sorts on unit price.

Available options:
created_at,
-created_at,
subscription_token,
-subscription_token,
status,
-status,
amount,
-amount
filter[status]
string

Status key, or active / inactive for the grouped states.

filter[frequency]
string

Billing interval unit, e.g. month.

filter[amount_min]
number

Minimum unit price (inclusive).

filter[amount_max]
number

Maximum unit price (inclusive).

filter[last_ship_after]
string<date>

Only subscriptions whose last order shipped on or after this date.

filter[customer_id]
integer

Restrict to one customer's subscriptions.

Free-text match across subscription token and customer name/email.

Response

Success

subscriptions
object[]
required
meta
object
required
status
integer