Skip to main content
GET
Get your Premium subscription

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

free; active; trialing; canceling (Premium until current_period_end, then Free); past_due (Premium while Stripe retries a failed payment); 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 could not be read, so this is the subscription Pomerado last stored

portal
boolean
required

The billing portal can open

checkout
object
required

Which Premium intervals checkout offers

yearly_switch
object
required