Skip to main content
GET
Get your subscription
  • Callers: an API key, an MCP OAuth token or a Dashboard session.
  • Permission: any signed-in member, for their own records; an API key also needs billing:manage.
  • Effect: Changes nothing.
  • Errors: only the errors any request can get.

Authorizations

Authorization
string
header
required

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

Response

Your subscription

plan
enum<string>
required
Available options:
free,
premium
status
enum<string>
required

canceling: Premium until current_period_end, then Free. past_due: still Premium while a failed payment is retried. payment_failed: the first payment failed, so still Free

Available options:
free,
active,
trialing,
canceling,
past_due,
payment_failed
interval
enum<string> | null
required
Available options:
monthly,
yearly
current_period_end
string | null
required

When the current period ends: the next renewal, the end of a trial, or when Premium ends

live
boolean
required

False when Stripe couldn't be read, so this is the last stored subscription

portal
boolean
required

The billing portal can open

checkout
object
required

Which Premium intervals checkout offers

yearly_switch
object
required
promotion
object | null
required

The free Premium period from a redeemed code, while it runs; else null