Skip to content

Current billing state.

GET
/billing/overview
curl --request GET \
--url https://api.siteqwality.com/billing/overview \
--header 'Authorization: Bearer <token>'

Current billing state

Media type application/json
object
status

Stripe’s own subscription status, or null when the account has never subscribed. Deliberately the raw Stripe string rather than our internal enum: this screen exists to show what Stripe thinks.

string | null
cancel_at_period_end
required
boolean
cancel_at

Unix seconds. Set when a cancellation is scheduled.

integer | null format: int64
current_period_end

Unix seconds. Read off the first subscription ITEM, not the subscription: Stripe moved period boundaries onto items in the API version this SDK pins, and Subscription no longer carries them.

integer | null format: int64
default_payment_method
One of:
null
Example generated
{
"status": "example",
"cancel_at_period_end": true,
"cancel_at": 1,
"current_period_end": 1,
"default_payment_method": {
"id": "example",
"brand": "example",
"last4": "example",
"exp_month": 1,
"exp_year": 1
}
}

Missing or invalid authentication

Internal server error