GET
/v1/billing/alertsList billing alerts
Lists active and inactive billing alerts. Use alert_type and meter to filter the alerts, and use cursor parameters to paginate through the results.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
alert_typestringoptional
Filters alerts by type. Must be `usage_threshold` when provided.
ending_beforestringoptional
Cursor for retrieving the preceding page, using an alert object ID; limited to 5000 characters.
expandarray<string>optional
Fields to expand in the response; each value must be no longer than 5000 characters.
limitintegeroptional
Maximum number of alerts to return, from 1 to 100. Defaults to 10 when omitted.
meterstringoptional
Filters alerts associated with the specified meter ID, limited to 5000 characters.
starting_afterstringoptional
Cursor for retrieving the following page, using an alert object ID; limited to 5000 characters.
200Returns a paginated list of billing alerts, including each alert's type, identifier, title, status, and usage-threshold configuration.
dataarray<Alert>required
has_morebooleanrequired
True if this list has another page of items after this one that can be fetched.
objectstringrequired
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
urlstringrequired
The URL where this list can be accessed.
defaultError response.
errorobjectrequired
Error handling
alert_type must be usage_threshold when provided. limit must be between 1 and 100 and defaults to 10 when omitted; each ending_before or starting_after value must be no longer than 5000 characters.