Skip to navigation
PlatformSpaceBalance

Retrieve low balance settings

View as MarkdownOpen in Claude

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 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_...)

Response

The request has succeeded.
typeenum

The object type. Always low_balance_setting.

Allowed values:
threshold_in_microdollarslong

The balance, in microdollars, below which notifications and auto top-up trigger. Falls back to the platform default when never configured.

thresholddouble

The threshold in US dollars. The same value as threshold_in_microdollars.

send_emailboolean
Whether an email is sent when the balance falls below the threshold.
send_webhookboolean
Whether a webhook is sent when the balance falls below the threshold.
webhook_urlstring or null

The URL the low balance webhook is sent to, or null when none is set.

webhook_methodenum or null

The HTTP method used for the low balance webhook, or null when none is set.

Allowed values:
send_topupboolean

Whether auto top-up is enabled.

topup_amount_in_microdollarslong or null

The amount, in microdollars, deposited by each auto top-up. Can be null.

topup_amountdouble or null

The auto top-up amount in US dollars. The same value as topup_amount_in_microdollars.

topup_payment_method_idstring or nullformat: "uuid"

The payment method charged by auto top-up, or null when none is set.

Errors

401
Unauthorized Error
500
Internal Server Error
502
Bad Gateway Error