Skip to main content
GET
Get Checklist
When called with an API key, the key needs the billing:read scope (about scopes).

Authorizations

Authorization
string
header
required

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

Cookies

session
String

Response

Successful Response

stripe_balance
number
required

Negative value indicates funds ready-to-spend. Positive value indicates money owed

recent
number
required

usage since most recent invoice

limit
number | null
required
suspend_reason
enum<string> | null
required
Available options:
balance,
payment-method,
overdue-invoices,
limit-reached,
admin,
bad-cc,
missing-address
email
boolean
default:false
billing_address
boolean
default:false
billing_address_info
BillingAddressOut · object | null
payment_method
boolean
default:false
payment_method_info
PaymentMethodOut · object | null
suspended
boolean
default:false
overdue_invoices
number
default:0
last_checked
integer
default:0
topup
boolean
default:false
topup_amount
integer
default:0
topup_threshold
integer
default:0
topup_failed
boolean
default:false
billing_type
string | null
payment_collection
string | null
payment_method_required
boolean
default:true

False when a missing payment method never suspends the account (monthly invoicing paid by bank transfer or on receipt)

scoped_credits
ScopedCredit · object[]
new_customer_limits
NewCustomerLimits · object | null

Limits on adding funds that apply to new customers; null when none apply