Skip to main content
GET
Get account balance
Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key
string
header
required

Customer API key (axl_ prefix).

Response

OK

The current account balance and its source breakdown.

balance_display
string
required

Formatted balance string (e.g., '$12.50').

balance_microdollars
integer<int64>
required

Current balance in microdollars (1_000_000 = $1.00).

included_microdollars
integer<int64>
required

Remaining plan-included credit in microdollars. Spent first; resets to the plan allowance at each renewal.

purchased_microdollars
integer<int64>
required

Remaining purchased credit in microdollars. Spent after included credit; each purchase expires one year after Stripe settled it.

purchased_next_expiry
string<date-time>

When the soonest-expiring purchased credit stops being usable.