Skip to main content
GET
Get usage-alert settings
Minimum role required: Viewer

Authorizations

X-Axilio-Api-Key
string
header
required

Customer API key (axl_ prefix).

Response

OK

The org's usage-alert configuration and any open alerts.

active_alerts
object[] | null
required

Currently open alerts, oldest first. Empty when the balance is healthy.

enabled
boolean
required

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

threshold_cents
integer<int64>
required

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