Skip to main content
GET
List all subscriptions

Authorizations

Authorization
string
header
required

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

Query Parameters

ids
integer[] | null

When provided, filters to objects with these IDs.

ending_before
integer | null

A cursor used for pagination. Fetches the page of results ending immediately before the object with the given ID. Cannot be used at the same time as starting_after.

starting_after
integer | null

A cursor used for pagination. Fetches the page of results starting immediately after the given ID. Cannot be used at the same time as ending_before.

limit
integer
default:10

The maximum number of items to return per page.

Required range: 1 <= x <= 100
cursor
string | null

A cursor token used for pagination. This token contains encoded information about the last seen record in order to continue pagination. Cannot be used with starting_after or ending_before parameters.

modified__gte
string<date-time> | null

Filters to objects modified on or after this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with starting_after or ending_before parameters.

modified__lte
string<date-time> | null

Filters to objects modified on or before this datetime (ISO8601 UTC, e.g. 2025-08-25T10:30:00Z). Cannot be used with starting_after or ending_before parameters.

clinic_id
integer | null

When provided, filters to subscriptions for this clinic

clinic_client_id
integer | null

When provided, filters to subscriptions for this clinic client

clinic_patient_id
integer | null

When provided, filters to subscriptions for this clinic patient

status
enum<string> | null

When provided, filters to subscriptions for this status

Available options:
ACTIVE,
CANCELED_VIA_CLINIC,
CANCELED_VIA_CLIENT,
CANCELED_DENIED,
CANCELED_VIA_ADMIN,
FAILED_PAYMENT,
PAUSED_VIA_CLIENT,
PAUSED_VIA_CLINIC,
PAUSED_BAD_ADDRESS,
PAUSED_PRESCRIPTION,
PAUSED_OUT_OF_STOCK,
PAUSED_MISSING_CLIENT_INFO,
PAUSED_FLAVOR_UNAVAILABLE,
PAUSED_OTHER,
IMPORTED

Response

200 - application/json

OK

data
ExternalSubscriptionSchema · object[]
required

A single page of data contained within this list.

next_page
string
required

A URL linking to the next page of this list.

has_more
boolean
default:false

Whether there are more pages or data in this list.

type
string
default:list

Type of this object. Always list.