Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-205391153.1 KB

4a74befa0bde

billing

Get account balance

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

get/billing/balance

Response

OK

$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_microdollarsinteger required

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

purchased_next_expirystring date-time

When the soonest-expiring purchased credit stops being usable.

Example response

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