billing

Get account balance

Returns the organization's current credit balance in microdollars plus a display string.

get/billing/balance

Request

Base URL
/api/v1 (relative, and the document was published on a file host, not at the API’s origin)
Auth
API key in header X-Axilio-Api-Key
TypeScript
https://skmtc.dev/axilioai/apis/axilio-api/docs/billing/balance/get.ts
A function with typed inputs. Its response is checked against the schema.

$schemastring uri

A URL to the JSON Schema for this object.

balance_displaystring required

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

balance_microdollarsinteger required

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

included_microdollarsinteger required

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

purchased_expires_atstring date-time

When the soonest-expiring purchased credit stops being usable.

purchased_microdollarsinteger required

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

{
  "$schema": "/api/v1/SubscriptionBalanceResponse.json"
}

Oct 23, 202649b1da5a7974 Revision changes
- warning
  removed the optional property from the response with the status
- info
  added the optional property to the response with the status
Aug 20, 20264a74befa0bde Revision changes
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status