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

# Retrieve low balance settings

`GET /api/space/low_balance_setting`

Returns how the space is notified when its balance falls below the threshold, and how
auto top-up is configured. A space that has never configured a threshold reports the
platform default.

The settings are 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.

- SpaceLowBalanceSetting — How the space is notified when its balance falls below the threshold, and whether it tops itself up automatically.
  - `type` 'low_balance_setting', required — The object type. Always `low_balance_setting`.
  - `threshold_in_microdollars` integer, required — The balance, in microdollars, below which notifications and auto top-up trigger. Falls back to the platform default when never configured.
  - `threshold` number, double, required — The threshold in US dollars. The same value as `threshold_in_microdollars`.
  - `send_email` boolean, required — Whether an email is sent when the balance falls below the threshold.
  - `send_webhook` boolean, required — Whether a webhook is sent when the balance falls below the threshold.
  - `webhook_url` string, nullable, required — The URL the low balance webhook is sent to, or `null` when none is set.
  - `webhook_method` 'GET' | 'POST', required — The HTTP method used to deliver the low balance webhook.
  - `send_topup` boolean, required — Whether auto top-up is enabled.
  - `topup_amount_in_microdollars` integer, nullable, required — The amount, in microdollars, deposited by each auto top-up. Can be `null`.
  - `topup_amount` number, double, nullable, required — The auto top-up amount in US dollars. The same value as `topup_amount_in_microdollars`.
  - `topup_payment_method_id` string, uuid, required — Universal Unique Identifier.

## 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/low_balance_setting/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)