---
title: "Get balance"
method: GET
path: "/balance"
tags: ["billing"]
---

# Get balance

`GET /balance`

## Request

- Base URL: `https://api.mailly.site` (the document declares no server; this is the origin it was published from)
- URL: `https://api.mailly.site/balance`
- Auth: HTTP bearer

## Response `200`

USD balance and sending status

- object
  - `success` boolean, required
  - `balance` number, required: Available balance in USD (allowance plus top-ups)
  - `currency` 'USD', required
  - `prepaid_nano` integer, required
  - `allowance_nano` integer, required
  - `included_emails_remaining` integer, required
  - `sending` object
    - `status` 'active' | 'paused', required: When paused, all customer sends are rejected with workspace_sending_paused
    - `reason` 'auto_bounce' | 'auto_complaint' | 'manual' | 'null', nullable, required
    - `paused_at` string, nullable, required
    - `daily_limit` object, nullable, required: Rolling 24h recipient limit; sends over it are rejected with workspace_daily_limit_exceeded and not charged
      - `limit` integer, required
      - `used` integer, required
      - `remaining` integer, required
      - `window_hours` 24, required
      - `source` 'new_workspace' | 'override' | 'free_plan', required
      - `applies_until` string, nullable, required

## Other responses

- `500`: Missing authentication context

---

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