Wallet balance

Alpha

GEThttps://api.voxrouter.ai/v1/credits

Return the current wallet snapshot for the authenticated key's account: `balanceMicros` (available credit) and `reservedMicros` (in-flight reservations not yet committed). Both values are USD micro-dollars (1_000_000 = $1.00). Keys without an associated account return an empty snapshot (`{balanceMicros: 0, reservedMicros: 0}`).

bash

curl https://api.voxrouter.ai/v1/credits \
  -H "Authorization: Bearer $VOXROUTER_API_KEY"

Headers

AuthorizationstringRequired

Bearer token. Send as Authorization: Bearer pk_....

Response

Wallet snapshot.

json

{
  "balanceMicros": 0,
  "reservedMicros": 0
}

balanceMicrosintegerRequired

Available credit in USD micro-dollars (1_000_000 = $1.00).

reservedMicrosintegerRequired

In-flight reservations held against the wallet but not yet committed to the ledger. Effective spendable balance is `balanceMicros - reservedMicros`.

Errors

Non-2xx responses return a JSON body with a machine-readable error code and an optional details string.

Status	Meaning
401	Missing or invalid API key.
429	Per-key rate limit or per-key concurrency limit exceeded. The `code` field on the body distinguishes the two (`rate_limit_exceeded` vs `concurrency_limit_exceeded`). `Retry-After` is seconds-from-now: a hard value until the rate-limit window resets, or a soft `1` hint for concurrency (slots free on request completion).
500	Unexpected server error.