> ## 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.

# Consultar saldo de la cuenta

> Obtén el saldo disponible y la moneda de la cuenta de YCloud.

## Qué es

La Balance API devuelve el saldo disponible de la cuenta autenticada de YCloud.
Utilízala para la monitorización operativa, alertas de facturación y comprobaciones
de autenticación.

## Antes de comenzar

* Almacena tu clave de API de YCloud de forma segura.
* Determina con qué frecuencia necesita tu aplicación la información del saldo.
* Define un umbral de alerta que refleje el volumen de envío previsto.

## Cómo funciona

El endpoint es de solo lectura y siempre se aplica a la cuenta identificada por la
clave de API. No acepta un ID de cuenta en la ruta ni en el cuerpo de la solicitud.

Utilízalo en tareas de monitorización, no antes de cada envío de mensaje. Las comprobaciones
frecuentes de saldo por mensaje añaden latencia y no reservan fondos.

## Solicitud

`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"
```

## Respuesta

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

| Campo | Descripción |
| - | - |
| `amount` | Saldo disponible de la cuenta. |
| `currency` | Moneda utilizada por la cuenta. |

## Guía de monitorización

* Envía una alerta antes de que el saldo alcance un nivel que pueda interrumpir
  el tráfico de producción.
* Incluye la moneda en paneles de control y alertas.
* Utiliza una alerta independiente para los fallos de la API, de modo que una comprobación no disponible no se confunda
  con un saldo cero.
* Restringe el acceso a los datos de saldo como información financiera.

## Límites y resolución de problemas

* Una respuesta de saldo correcta verifica la clave de API y la URL base.
* Un saldo bajo puede afectar a los productos de mensajería facturables, incluso cuando
  la autenticación de la API sea correcta.
* No asumas que el importe está en USD; lee `currency`.
* Evita registrar la clave de API en los registros de salida de monitorización.

<Card title="Referencia de la Balance API" icon="wallet" href="/api-reference/balance/retrieve-balance">
  Inspecciona el esquema completo de respuesta y prueba la solicitud de solo lectura.
</Card>


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