Skip to main content
GET
Get your account balance

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests — see Test mode explained for the full credential-header matrix and worked samples. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Response

The wallet balance — balance_usd (decimal dollars), balance_cents (whole cents), balance_micro_cents (cents × 1e6, the same unit as the charge ledger's chargedMicroCents, for integer-exact sub-cent rates), credits (deprecated alias of balance_cents), currency (ISO 4217 code the wallet is denominated in), and pause-state flags (outbound_paused, outbound_block_reason, payment_failure_count); a degraded: true + source pair is added when the value came from the database fallback — in the standard { data, meta } envelope.

The wallet balance — balance_usd (decimal dollars), balance_cents (whole cents), balance_micro_cents (cents × 1e6, the same unit as the charge ledger's chargedMicroCents, for integer-exact sub-cent rates), credits (deprecated alias of balance_cents), currency (ISO 4217 code the wallet is denominated in), and pause-state flags (outbound_paused, outbound_block_reason, payment_failure_count); a degraded: true + source pair is added when the value came from the database fallback — in the standard { data, meta } envelope.