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

# GET /v1/channels/sms/balance

> Your own SMS gateway's balance.

The balance on your own SMS gateway account. On FireFlo's shared gateway there is none of yours to show: `own_gateway` is false and the figures null — see [GET /v1/usage](/api-reference/usage/get) for your account's balance.

<Note>Needs the `sms.balance:read` scope.</Note>

## Request

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.fireflo.au/v1/channels/sms/balance \
    -H "Authorization: Bearer $OMNI_API_KEY"
  ```

  ```python Python theme={null}
  import os

  import requests

  response = requests.get(
      "https://api.fireflo.au/v1/channels/sms/balance",
      headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
  )
  print(response.status_code, response.json())
  ```

  ```javascript Node theme={null}
  const response = await fetch("https://api.fireflo.au/v1/channels/sms/balance", {
    headers: {
      Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
    },
  });
  console.log(response.status, await response.json());
  ```
</CodeGroup>

## Response

`200 OK` — `balance` and `sms_count` are the gateway's own figures. `balance` can be the string `"ND"`: the gateway doesn't enforce a balance on this account, which is not the same as zero.

```json theme={null}
{
  "balance": 12480.5,
  "sms_count": 83203,
  "own_gateway": true
}
```

## Errors

Every refusal is `{"error": {"code", "message", "field"}}`; `field` is there when one input is at fault.

| Status | Error code | When |
| :- | :- | :- |
| 404 | `channel_off` | The account doesn't have SMS on. |
| 409 | `provider_refused` | The SMS gateway refused it or couldn't be asked; the message says why. |
| 403 | `scope_missing` | The key doesn't have the `sms.balance:read` scope. |

Any request can also be refused for its key, its account or its rate (`key_required`, `invalid_key`, `account_suspended`, `plan_excludes_api`, `address_not_allowed`, `rate_limited`); see [the overview](/api-reference/overview).


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