# TenantBalance

A tenant's prepaid balance, as shown to the tenant.

**Kind:** an object, used in responses.

## Fields

Every field is present in a response; empty ones are `null`.

| Field | Type | Description |
|---|---|---|
| `currency` | `string` | The balance's currency. |
| `balance` | `number` | What's left, rounded to the currency's minor unit. Negative when the tenant owes. |
| `lastTopUpAmount` | `number \| null` | The last top-up's amount, which a low-balance alert is a share of. |
| `outOfCredit` | `boolean` | Nothing new can start: the balance can't pay for more work (a plan with an allowance left can still run at zero). |

## Example

```json
{
  "currency": "...",
  "balance": 0,
  "lastTopUpAmount": 0,
  "outOfCredit": false
}
```

## Where it's used

- [`billing.balance`](https://docs.maitento.com/reference/api/billing.md) (`GET /billing/balance`)