Skip to main content
GET
Get subscription billing overview

Authorizations

Authorization
string
header
required

JWT authentication token

Response

Subscription overview

has_subscription
boolean
required
available_credits
number<double>
cancel_at_period_end
boolean
discount_credits
number<double>

Bonus subscription credits currently granted from the first-month discount (per-seat allotment above the billed tier). 0 once the first credit-month has settled or when no discount applies.

next_charge_cents
integer
next_charge_display
string
payment_methods
object[]
pending_change
object
per_seat_usage
object[]
plan
object
renews_at
string<date-time>
reset_at
string<date-time>

When the monthly subscription credits next reset

status
string

active, past_due, canceled, incomplete

subscription_credits
number<double>

Monthly subscription grant total (seats x credits_per_user)

subscription_remaining
number<double>
subscription_used
number<double>
topup_credits
number<double>

Current top-up bucket total (issued_credits)

topup_expires_at
string<date-time>
topup_purchased
number<double>

Lifetime total top-up credits purchased for this resource.

topup_remaining
number<double>
topup_used
number<double>

Lifetime top-up credits consumed (purchased - current balance).

used_credits
number<double>