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.

Query Parameters

surface
enum<string>
required

The client asking: web, ios or android. The actions returned are the ones available from that surface.

Available options:
web,
ios,
android

Response

OK

actions
object
required
active_billing_cycle_id
string
required
billing_cycle_starts_at
string
required
cancel_at_period_end
boolean
required
checkout_pending
boolean
required
credits_remaining
number<double>
required
managed_by
enum<string>
required
Available options:
none,
stripe,
app_store,
play_store
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
plan
object
required
settlement_mode
enum<string>
required
Available options:
prepaid,
enterprise_invoice
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,
team
billing_cycle_ends_at
string
cancellation_effective_at
string
current_period_end
string
current_period_start
string
store_app_user_id
string<uuid>

On ios and android, the signed-in user's store identity, which the store SDK logs in with. Absent until the user's first store purchase intent mints it, and on the web.