Client area

GET · Account & access

The account's prepaid balance

The account's prepaid balance

GET /api/v1/account/balance
R Read
Scope read:billing

Description

Returns balance, availableToUse and currency. To settle an invoice from this balance is a confirmation-tier action (pay_invoice_with_balance), not a read.

Parameters

This operation takes no parameters. Authentication is the bearer token in the Authorization header.

Responses

The specification does not describe this response body; the note in the rail says what to expect. Every non-2xx response is an RFC 7807 problem with a stable code.

Commonly returned errors

The codes this operation reaches on its own path: the auth stack, its own validation and ownership checks, and the transport. Not a closed set — a shared code from the full registry can still surface. Each links to the code’s own page, the same URL its type dereferences to.

401 No token was presented, or the token is revoked, expired or unknown.
403 The token lacks a required scope, or this account does not own the resource.
429 The rate limit for this token is exhausted. See `Retry-After`.
500 Something went wrong on our side. The failure is logged against `requestId`.
Esc
navigate open Esc close