Sign in
billing

Update usage-alert settings

Configures the low-balance alert: while enabled and the balance sits below the threshold, an alert stays open and surfaces in the dashboard. Negative-balance alerts are always on. Requires an admin-role caller: an API key carries its creator's organization role, so the key must belong to an org admin.

put/billing/usage-alerts

Request body

$schemastring uri

A URL to the JSON Schema for this object.

enabledboolean required

Whether low-balance alerts are active. Negative-balance alerts are always on.

threshold_centsinteger required

Alert while the balance sits below this amount, in cents. Must be positive.

Example request

{
  "$schema": "/api/v1/SubscriptionUsageAlertSettings.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

enabledboolean required

Whether low-balance alerts are active. Negative-balance alerts are always on.

threshold_centsinteger required

Alert while the balance sits below this amount, in cents. Must be positive.

Example response

{
  "$schema": "/api/v1/SubscriptionUsageAlertSettingsResponse.json"
}

Changes