---
title: "List balances"
method: GET
path: "/v1/balances"
tags: ["Balances"]
---

# List balances

`GET /v1/balances`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/balances`
- Auth: HTTP bearer

One row per partner per currency: `pending_minor` (earned, inside the hold), `due_minor` (payable now), `paid_minor` (sent). Ordered by partner then currency; the cursor is a balance id.

**Scope:** `read`

## Query parameters

- `program_id` string, required: Required on every list
- `limit` string: 1 to 100, default 25
- `starting_after` string: Object id; returns the page after it (older)
- `ending_before` string: Object id; returns the page before it (newer)
- `expand[]` union: Relations to embed: partner
  - string
  - string[]
- `include[]` union: Nothing to include on this resource
  - string
  - string[]
- `partner_id` string
- `currency` string

## Response `200`

Balances

- BalanceList
  - `data` Balance[], required
    - `id` string, required: `bal_<partner_id>_<currency>`
    - `object` 'balance', required
    - `partner_id` string, required: Prefixed id (`part_…`)
    - `currency` string, required: ISO-4217
    - `pending_minor` integer, required: Integer minor units (cents, pence). Never a float, never a string.
    - `due_minor` integer, required: Integer minor units (cents, pence). Never a float, never a string.
    - `paid_minor` integer, required: Integer minor units (cents, pence). Never a float, never a string.
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: Pass the last object's id as `starting_after` to fetch the next page
  - `total_count` integer, required: Count of every object matching the filters, ignoring the cursor

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

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