Skip to main content
GET
List subscriptions

Authorizations

Authorization
string
header
required

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

Query Parameters

take
number | null
default:50
Required range: 0 <= x <= 100
skip
number | null
default:0
Required range: x >= 0
activation_strategy
Available options:
checkout,
contract_start_date,
quote,
start_date,
manually
activation_strategy__in
Available options:
checkout,
contract_start_date,
quote,
start_date,
manually
status

Subscription status filter.

  • active, pending, paused, errored, cancelled, draft, voided, archived: match that status.
  • inactive: shortcut for pending + paused.
  • all: every status except draft, voided, cancelled and archived — the same exclusion as omitting the filter.
  • any: every status, no exclusion.

Use status__in with comma-separated values to combine statuses. When the filter is omitted, draft, voided, cancelled and archived subscriptions are excluded.

Available options:
all,
any,
inactive,
active,
errored,
cancelled,
paused,
pending,
draft,
voided,
archived
status__in

Comma-separated list of subscription statuses to include. Same values as status.

Available options:
all,
any,
inactive,
active,
errored,
cancelled,
paused,
pending,
draft,
voided,
archived
currency
string
currency__not
string
currency__equals
string
currency__contains
string
currency__startsWith
string
currency__endWith
string
plan_id
string
plan_id__not
string
plan_id__equals
string
plan_id__contains
string
plan_id__startsWith
string
plan_id__endWith
string
plan_id__isNull
plan_id__isNotNull
original_quote_id
string
original_quote_id__not
string
original_quote_id__equals
string
original_quote_id__contains
string
original_quote_id__startsWith
string
original_quote_id__endWith
string
original_quote_id__isNull
original_quote_id__isNotNull
customer_id
string
customer_id__not
string
customer_id__equals
string
customer_id__contains
string
customer_id__startsWith
string
customer_id__endWith
string
customer_id__isNull
customer_id__isNotNull
invoicing_entity_id
string
purchase_order
string
purchase_order__not
string
purchase_order__equals
string
purchase_order__contains
string
purchase_order__startsWith
string
purchase_order__endWith
string
purchase_order__isNull
purchase_order__isNotNull
custom_properties
string

Filter by custom property values, as a JSON object mapping a custom property slug to the exact value to match. Suffix a slug with __contains for a case-sensitive substring match on text values. Several entries are combined with AND. Entries whose slug matches no custom property, or whose value is false, 0, null or an empty string, are ignored.

Example:

"{\"external_item_id\":\"core_f25\"}"

invoice_drafts
string
integration_entity_id
string
updated_at
string<date-time>
updated_at__not
string<date-time>
updated_at__equals
string<date-time>
updated_at__lt
string<date-time>
updated_at__lte
string<date-time>
updated_at__gt
string<date-time>
updated_at__gte
string<date-time>
cancel_at
string<date-time>
cancel_at__not
string<date-time>
cancel_at__equals
string<date-time>
cancel_at__lt
string<date-time>
cancel_at__lte
string<date-time>
cancel_at__gt
string<date-time>
cancel_at__gte
string<date-time>
cancel_at__isNull
cancel_at__isNotNull
contract_start__gte
string<date-time>

Return only subscriptions whose active contract starts on or after this date.

Example:

"2026-01-01T00:00:00.000Z"

contract_start__lte
string<date-time>

Return only subscriptions whose active contract starts on or before this date.

Example:

"2026-12-31T23:59:59.999Z"

contract_end__gte
string<date-time>

Return only subscriptions whose active contract ends on or after this date.

Example:

"2026-10-01T00:00:00.000Z"

contract_end__lte
string<date-time>

Return only subscriptions whose active contract ends on or before this date.

Example:

"2026-12-31T23:59:59.999Z"

renew_automatically

Return only subscriptions whose active contract renews automatically (true) or not (false).

Example:

true

Response

200 - application/json
meta
object
required
data
object[]
required

List of Subscription.