# LowBalanceAlertSettings

The low-balance warnings a tenant has chosen. Each is sent once per crossing, not on every debit.

**Kind:** an object, used in requests and responses. In a request it is called `LowBalanceAlertSettingsInput`.

## In a request

| Field | Type | Required | Description |
|---|---|---|---|
| `emailAtPercentOfLastTopUp` | `integer \| null` |  | Email when the balance falls to this percentage of the last top-up; null for no email. |
| `showPortalBanner` | `boolean` |  | Show a banner in the portal while the balance is low: below `LowBalanceAlertSettings.EmailAtPercentOfLastTopUp` of the last top-up, or below 20% of it when the email is off. The billing standing's `lowBalance` says when. |
| `emailWhenWorkRefused` | `boolean` |  | Email when work is refused because the balance has run out. |

```json
{
  "emailAtPercentOfLastTopUp": 0,
  "showPortalBanner": false,
  "emailWhenWorkRefused": false
}
```

## In a response

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

| Field | Type | Description |
|---|---|---|
| `emailAtPercentOfLastTopUp` | `integer \| null` | Email when the balance falls to this percentage of the last top-up; null for no email. |
| `showPortalBanner` | `boolean` | Show a banner in the portal while the balance is low: below `LowBalanceAlertSettings.EmailAtPercentOfLastTopUp` of the last top-up, or below 20% of it when the email is off. The billing standing's `lowBalance` says when. |
| `emailWhenWorkRefused` | `boolean` | Email when work is refused because the balance has run out. |

```json
{
  "emailAtPercentOfLastTopUp": 0,
  "showPortalBanner": false,
  "emailWhenWorkRefused": false
}
```

## Where it's used

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