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
Available options:
all,
inactive,
active,
errored,
cancelled,
paused,
pending,
draft,
voided,
archived
status__in
Available options:
all,
inactive,
active,
errored,
cancelled,
paused,
pending,
draft,
voided,
archived
currency
string
currency__not
string
currency__isNull
string
currency__isNotNull
string
currency__equals
string
currency__contains
string
currency__startsWith
string
currency__endWith
string
plan_id
string
plan_id__not
string
plan_id__isNull
string
plan_id__isNotNull
string
plan_id__equals
string
plan_id__contains
string
plan_id__startsWith
string
plan_id__endWith
string
original_quote_id
string
original_quote_id__not
string
original_quote_id__isNull
string
original_quote_id__isNotNull
string
original_quote_id__equals
string
original_quote_id__contains
string
original_quote_id__startsWith
string
original_quote_id__endWith
string
customer_id
string
customer_id__not
string
customer_id__isNull
string
customer_id__isNotNull
string
customer_id__equals
string
customer_id__contains
string
customer_id__startsWith
string
customer_id__endWith
string
invoicing_entity_id
string
purchase_order
string
purchase_order__not
string
purchase_order__isNull
string
purchase_order__isNotNull
string
purchase_order__equals
string
purchase_order__contains
string
purchase_order__startsWith
string
purchase_order__endWith
string
custom_properties
string
invoice_drafts
string
integration_entity_id
string
updated_at
string<date-time>
updated_at__not
string<date-time>
updated_at__isNull
string<date-time>
updated_at__isNotNull
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>

Response

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

List of Subscription.