---
title: "Retrieve the balance"
method: GET
path: "/api/space/balance"
tags: ["Space Balance"]
---

# Retrieve the balance

`GET /api/space/balance`

Returns the current balance, the low balance threshold, and whether auto top-up is
enabled. Each amount is given in microdollars (millionths of a US dollar) and again in
dollars.

The balance is read from the billing service, so the response is `502` when that
service is unavailable.

#### Permissions

Authenticate with a [Personal access token](/docs/apis/authorization#personal-access-tokens) whose holder is an owner or admin of the space. A project API token is not accepted on this endpoint, and a Personal access token has no scopes: the holder's role in the space is the whole authorization decision.

## Response `200`

The request has succeeded.

- SpaceBalance — The current balance of the space and its auto top-up state. Amounts are given in microdollars (millionths of a US dollar) and again in dollars.
  - `type` 'balance', required — The object type. Always `balance`.
  - `balance_in_microdollars` integer, required — The current balance in microdollars.
  - `current_balance` number, double, required — The current balance in US dollars. The same value as `balance_in_microdollars`.
  - `low_balance_threshold_in_microdollars` integer, required — The low balance threshold in microdollars.
  - `low_balance_threshold` number, double, required — The low balance threshold in US dollars. The same value as `low_balance_threshold_in_microdollars`.
  - `auto_topup_enabled` boolean, required — Whether auto top-up is enabled.

## Other responses

- `401` — The credential is missing, unknown, or revoked; its holder is not a member of the space in the subdomain; or the member is not an owner or admin. The body is the plain text `Unauthorized`. An unverified space instead receives the JSON body `{"message": "Please validate a phone number to access your account."}` on every endpoint under `/api/space`.
- `500` — An internal server error occurred.
- `502` — An upstream billing or usage reporting service was unavailable. The body is empty; retry later.

## Changes

> 161 revisions in range; 3 could not be searched.

- **2026-09-15** `45bac4fd93ab` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/signalwire/apis/signalwire-rest-api/changes/api/space/balance/get.md)

---

[API](https://skmtc.dev/signalwire/apis/signalwire-rest-api.md) · [All operations](https://skmtc.dev/signalwire/apis/signalwire-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/signalwire/apis/signalwire-rest-api/revisions/20ee0f568ece?raw)