List billing alerts
GET / v1 / billing / alerts
Lists billing active and inactive alerts
Parameters
- alert _ type enum Filter results to only include this type of alert. Possible enum values
usage_thresholdUseusage_thresholdif you intend for an alert to fire when a usage threshold on a meter is crossed. - meter string Filter results to only include alerts with the given meter.
More parameters
- ending _ before string
- limit integer
- starting _ after string
Returns
Returns a list of billing alerts
Response
{ "data": [ { "id": "alrt_12345", "object": "billing.alert", "title": "API Request usage alert", "livemode": true, "alert_type": "usage_threshold", "usage_threshold": { "gte": 10000, "meter": "mtr_12345", "recurrence": "one_time" }, "status": "active" }, { "id": "alrt_67890", "object": "billing.alert", "title": "API Request usage alert", "livemode": true, "alert_type": "usage_threshold", "usage_threshold": { "gte": 120, "meter": "mtr_67890", "recurrence": "one_time" }, "status": "active" } ]}
Activate a billing alert
POST / v1 / billing / alerts /:id / activate
Reactivates this alert, allowing it to trigger again.
Parameters
No parameters.
Returns
Returns the alert with its updated status.
Response
{ "id": "alrt_12345", "object": "billing.alert", "title": "API Request usage alert", "livemode": true, "alert_type": "usage_threshold", "usage_threshold": { "gte": 10000, "meter": "mtr_12345", "recurrence": "one_time" }, "status": "active"}
Archive a billing alert
POST / v1 / billing / alerts /:id / archive
Archives this alert, removing it from the list view and APIs. This is non-reversible.
Parameters
No parameters.
Returns
Returns the alert with its updated status.
Response
{ "id": "alrt_12345", "object": "billing.alert", "title": "API Request usage alert", "livemode": true, "alert_type": "usage_threshold", "usage_threshold": { "gte": 10000, "meter": "mtr_12345", "recurrence": "one_time" }, "status": "archived"}