> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Check account balance

> Retrieve the available YCloud account balance and currency.

## What it is

The Balance API returns the available balance for the authenticated YCloud
account. Use it for operational monitoring, billing alerts, and authentication
checks.

## Before you begin

* Store your YCloud API key securely.
* Decide how often your application needs balance information.
* Define an alert threshold that reflects expected sending volume.

## How it works

The endpoint is read-only and always applies to the account identified by the
API key. It does not accept an account ID in the path or request body.

Use it in monitoring jobs, not before every message send. Frequent per-message
balance checks add latency and do not reserve funds.

## Request

`GET /balance`

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl https://api.ycloud.com/v2/balance \
  --header "X-API-Key: $YCLOUD_API_KEY" \
  --header "Accept: application/json"
```

## Response

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "amount": 190.0765,
  "currency": "USD"
}
```

| Field | Description |
| - | - |
| `amount` | Available account balance. |
| `currency` | Currency used by the account. |

## Monitoring guidance

* Alert before the balance reaches a level that can interrupt production
  traffic.
* Include the currency in dashboards and alerts.
* Use a separate alert for API failures so an unavailable check is not confused
  with a zero balance.
* Restrict access to balance data as financial information.

## Limits and troubleshooting

* A successful balance response verifies the API key and base URL.
* A low balance can affect billable messaging products even when API
  authentication succeeds.
* Do not assume that the amount is in USD; read `currency`.
* Avoid logging the API key in monitoring output.

<Card title="Balance API reference" icon="wallet" href="/api-reference/balance/retrieve-balance">
  Inspect the complete response schema and test the read-only request.
</Card>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.