Retrieve the balance

GET

https://{your_space_name}.signalwire.com/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 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.

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.

Authentication

AuthorizationBasic

Personal access token authentication for space-wide administration.

Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project’s: it is created from your user menu in the Dashboard, is prefixed pat_, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space.

Example:

Authorization: Basic base64(:pat_...)

Personal access token authentication for space-wide administration. Send HTTP Basic auth with an empty username and the Personal access token as the password. A Personal access token carries your own authority rather than a project's: it is created from your user menu in the Dashboard, is prefixed `pat_`, and has no scopes. The holder must be an owner or admin of the space named by the subdomain, and the token acts only on that space. Example: ``` Authorization: Basic base64(:pat_...) ```

Response

The request has succeeded.

typeenum

The object type. Always balance.

balance_in_microdollarslong

The current balance in microdollars.

current_balancedouble

The current balance in US dollars. The same value as balance_in_microdollars.

low_balance_threshold_in_microdollarslong

The low balance threshold in microdollars.

low_balance_thresholddouble

The low balance threshold in US dollars. The same value as low_balance_threshold_in_microdollars.

auto_topup_enabledboolean

Whether auto top-up is enabled.

Errors

401

Unauthorized Error

500

Internal Server Error

502

Bad Gateway Error