Sign in
Space Balance

Update low balance settings

Replaces the low balance notification and auto top-up settings. The update writes the whole setting, so send every field you want to keep; omitted fields take their defaults.

When send_topup is true, topup_amount_in_microdollars and topup_payment_method_id are required. The threshold must be a whole number of cents between 5,000,000 and 1,000,000,000,000 microdollars, and the top-up amount a whole number of cents of at least 10,000,000 microdollars (10.00 USD). Some spaces are required to keep auto top-up on; disabling it there is rejected with send_topup_cannot_be_disabled.

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.

put/api/space/low_balance_setting

Request body

threshold_in_microdollarsinteger

The balance, in microdollars, below which notifications and auto top-up trigger. A whole number of cents, at least 5,000,000 (5.00 USD) and at most 1,000,000,000,000 (1,000,000 USD). Defaults to the platform default when omitted.

send_emailboolean

Whether to send an email when the balance falls below the threshold.

send_webhookboolean

Whether to send a webhook when the balance falls below the threshold.

webhook_urlstring

The URL to send the low balance webhook to. Required when send_webhook is true (webhook_url_missing).

webhook_method'GET' | 'POST'

The HTTP method used to deliver the low balance webhook.

send_topupboolean

Whether to top the balance up automatically when it falls below the threshold. Some spaces are required to keep auto top-up on; disabling it there is rejected with send_topup_cannot_be_disabled.

topup_amount_in_microdollarsinteger

The amount, in microdollars, to deposit on each auto top-up. Required when send_topup is true (topup_amount_missing). A whole number of cents and at least 10,000,000 (10.00 USD).

topup_payment_method_idstring uuid

Universal Unique Identifier.

Example request

{
  "threshold_in_microdollars": 6000000,
  "send_email": true,
  "webhook_url": "https://example.com/hooks/low-balance",
  "send_topup": true,
  "topup_amount_in_microdollars": 20000000
}

Response

The request has succeeded.

type'low_balance_setting' required

The object type. Always low_balance_setting.

threshold_in_microdollarsinteger required

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

thresholdnumber double required

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

send_emailboolean required

Whether an email is sent when the balance falls below the threshold.

send_webhookboolean required

Whether a webhook is sent when the balance falls below the threshold.

webhook_urlstring 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_topupboolean required

Whether auto top-up is enabled.

topup_amount_in_microdollarsinteger nullable required

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

topup_amountnumber double nullable required

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

topup_payment_method_idstring uuid required

Universal Unique Identifier.

Example response

{
  "type": "low_balance_setting",
  "threshold_in_microdollars": 6000000,
  "threshold": 6,
  "send_email": true,
  "webhook_url": "https://example.com/hooks/low-balance",
  "send_topup": true,
  "topup_amount_in_microdollars": 20000000,
  "topup_amount": 20
}

Changes

Changed in 1 of the 161 revisions of this API.1

Of the 161 revisions, 3 have a changelog that could not be searched.