Subscriptions

List subscriptions

Retrieve existing subscriptions. By default, draft, voided, and cancelled subscriptions are not included.

get/v2/subscriptions

Query parameters

takenumber nullable
skipnumber nullable
'checkout' | 'contract_start_date' | 'quote' | 'start_date' | 'manually'
OR
string

checkout,contract_start_date

'checkout' | 'contract_start_date' | 'quote' | 'start_date' | 'manually'
OR
string

checkout,contract_start_date

'all' | 'inactive' | 'active' | 'errored' | 'cancelled' | 'paused' | 'pending' | 'draft' | 'voided' | 'archived'
OR
string

all,inactive

'all' | 'inactive' | 'active' | 'errored' | 'cancelled' | 'paused' | 'pending' | 'draft' | 'voided' | 'archived'
OR
string

all,inactive

currencystring
currency__notstring
currency__isNullstring
currency__isNotNullstring
currency__equalsstring
currency__containsstring
currency__startsWithstring
currency__endWithstring
plan_idstring
plan_id__notstring
plan_id__isNullstring
plan_id__isNotNullstring
plan_id__equalsstring
plan_id__containsstring
plan_id__startsWithstring
plan_id__endWithstring
original_quote_idstring
original_quote_id__notstring
original_quote_id__isNullstring
original_quote_id__isNotNullstring
original_quote_id__equalsstring
original_quote_id__containsstring
original_quote_id__startsWithstring
original_quote_id__endWithstring
customer_idstring
customer_id__notstring
customer_id__isNullstring
customer_id__isNotNullstring
customer_id__equalsstring
customer_id__containsstring
customer_id__startsWithstring
customer_id__endWithstring
invoicing_entity_idstring
purchase_orderstring
purchase_order__notstring
purchase_order__isNullstring
purchase_order__isNotNullstring
purchase_order__equalsstring
purchase_order__containsstring
purchase_order__startsWithstring
purchase_order__endWithstring
custom_propertiesstring
invoice_draftsstring
integration_entity_idstring
updated_atstring date-time
updated_at__notstring date-time
updated_at__isNullstring date-time
updated_at__isNotNullstring date-time
updated_at__equalsstring date-time
updated_at__ltstring date-time
updated_at__ltestring date-time
updated_at__gtstring date-time
updated_at__gtestring date-time

Response

PaginatedSubscription required— unresolved $ref

Changes