Skip to main content
GET
Get billing subscription

Authorizations

Authorization
string
header
required

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

Response

OK

active_billing_cycle_id
string
required
billing_cycle_starts_at
string
required
cancel_at_period_end
boolean
required
checkout_pending
boolean
required
monthly_credit_grant
integer<int64>
required
payment_state
enum<string>
required
Available options:
not_required,
checkout_pending,
active,
grace_period,
past_due,
unpaid,
canceled,
blocked
portal_available
boolean
required
subscription_status
enum<string>
required
Available options:
free,
active,
trialing,
incomplete,
past_due,
unpaid,
canceled,
paused
tier
enum<string>
required
Available options:
free,
starter,
pro,
max
billing_cycle_ends_at
string
cancellation_effective_at
string
current_period_end
string
current_period_start
string