Skip to main content
GET
Get Balance

Authorizations

Authorization
string
header
required

Enter your MeshAPI key (rsk_...) — sent as Authorization: Bearer <key>.

Headers

X-Mesh-Version
enum<string>
default:2026-08

Dated version of the API contract to pin this request to. Omit it and the request is served under 2026-08 — the oldest supported version, so an existing integration is never moved by a release. A malformed or unsupported value is rejected with 400 invalid_api_version rather than falling back silently. The version actually served is echoed as X-Mesh-Version on every response, including errors.

Available options:
2026-08

Response

200 - application/json

Successful Response

balance_usd
string
required

Total credit balance in USD.

available_usd
string
required

Spendable balance: balance_usd minus reserved_usd.

reserved_usd
string
default:0.0000000

Funds currently held by in-flight operations and not spendable.

reserved_breakdown
ReservationCategoryTotal · object[]

Reserved totals per category (realtime / async / video); omits categories holding nothing. Sums to reserved_usd.

updated_at
string | null

Last balance update (ISO 8601).

message
string | null