Subscriptions
Get subscriptions
Retrieve all existing subscriptions.
GET
/
v2
/
subscriptions
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
take
number | null
default: 50skip
number | null
default: 0status
Available options:
all
, inactive
, active
, errored
, cancelled
, paused
, pending
, draft
, voided
status__in
Available options:
all
, inactive
, active
, errored
, cancelled
, paused
, pending
, draft
, voided
status__notIn
Available options:
all
, inactive
, active
, errored
, cancelled
, paused
, pending
, draft
, voided
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
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
updated_at
string
updated_at__not
string
updated_at__isNull
string
updated_at__isNotNull
string
updated_at__equals
string
updated_at__lt
string
updated_at__lte
string
updated_at__gt
string
updated_at__gte
string
Response
200 - application/json
meta
object
requireddata
object[]
requiredList of Subscription.
Was this page helpful?