Retrieve account balance

Overview

Balances are stored in integer micro-units and formatted by the public contract. This read-only endpoint creates no hold; task authorization and settlement follow the task's billing snapshots.

Authentication: Bearer API key

Request

This endpoint has no path, query, or request-body parameters.

Response

JSON endpoints use the standard response envelope. HTTP status represents the request outcome; business errors are not disguised as HTTP 200.

HTTP	Meaning
`200`	Request succeeded
`401`	Missing or invalid API key
`403`	API key disabled or access forbidden
`500`	Internal service error

Complete success example (optional fields vary by state)

{
  "code": 0,
  "message": "success",
  "data": {
    "account_id": "account_01JEXAMPLE",
    "currency": "USD",
    "balance_micro": 12500000,
    "balance_usd": "12.500000",
    "available_micro": 12500000,
    "available_usd": "12.500000",
    "held_micro": 0,
    "held_usd": "0.000000",
    "net_consumed_micro": 0,
    "net_consumed_usd": "0.000000",
    "balance_expires_at": "2029-08-10T00:00:00.000Z"
  },
  "request_id": "8f25b42f-2ed1-4ad7-99de-61d7f779bc7b",
  "timestamp": "2026-08-10T00:00:00Z"
}

Important boundaries

Requires an OGA platform API key, not an upstream provider key.

Open the machine-readable OpenAPI