Sign in
latestOpenAPI 3.1.02026-08-20866385.9 KB

a4b69f6d2450

billing

Get Billing State

Snapshot of plan + current-period usage for the dashboard.

get/api/billing/state

Response

Successful Response

plan_tierstring required
subscription_statusstring required
pro_enabledboolean required
can_manage_billingboolean required
monthly_price_centsinteger required
monthly_mb_includedinteger required
overage_per_gb_centsinteger required
used_bytesinteger required
period_startstring date-time nullable required
period_endstring date-time nullable required
trial_ends_atstring date-time nullable required
cancel_at_period_endboolean required
has_subscriptionboolean
has_customerboolean
refund_window_ends_atstring date-time nullable
refund_eligibleboolean
is_paygboolean
credit_balance_bytesinteger
credit_balance_creditsnumber
free_grant_creditsinteger
credit_price_centsinteger
bytes_per_creditinteger
payg_out_of_credits_modestring
credit_pack_presetsinteger[]