Skip to main content
GET
Get billing status

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Response

Billing status

has_payment_method
boolean
billing_email
string<email> | null
balance_cents
integer
balance
number

balance_cents / 100

currency
string
Example:

"usd"

is_suspended
boolean
auto_topup_enabled
boolean
auto_topup_amount_cents
integer | null
low_balance_threshold_cents
integer | null