Skip to main content
GET
Renewal date, payment failures, a pending cancellation and invoices, from Stripe

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Response

The subscription as Plan & billing shows it.

plan
enum<string>
required
Available options:
free,
standard,
team
subscription
object | null
required
invoices
object[]
required
unpaid_invoice
object | null
required

The newest open invoice with an amount still due: the one to pay after a failed payment.

live
boolean
required

false when this is the stored state because Stripe could not be asked.

stripe_error
string | null
required