---
title: "Read API account credit"
method: GET
path: "/balance"
---

# Read API account credit

`GET /balance`

## Request

- Base URL: `https://api.openmayhem.ai/v1`
- URL: `https://api.openmayhem.ai/v1/balance`
- Auth: HTTP bearer

Requires BILLING_READ. Returns exact posted, reserved and available USD credit. Set include_rails=1 only when the FIAT, TNK and TAP split is needed.

## Query parameters

- `include_rails` boolean

## Response `200`

Current account balance.

- Balance
  - `object` 'balance', required
  - `posted` string, required: Non-negative decimal USD string with at most 6 decimal places, parsed with exact fixed-point arithmetic.
  - `reserved` string, required: Non-negative decimal USD string with at most 6 decimal places, parsed with exact fixed-point arithmetic.
  - `available` string, required: Non-negative decimal USD string with at most 6 decimal places, parsed with exact fixed-point arithmetic.
  - `rails` object

## Other responses

- `401`: Missing or invalid API key.
- `403`: The key lacks BILLING_READ.

---

[API](https://skmtc.dev/openmayhem/apis/openmayhem-api.md) · [All operations](https://skmtc.dev/openmayhem/apis/openmayhem-api/llms.txt) · [OpenAPI document](https://skmtc.dev/openmayhem/apis/openmayhem-api/revisions/0ea33ad12f21?raw)