Sample - Stripe API
GET/v1/billing/alerts/{id}

Retrieve a billing alert

Retrieves a billing alert by its unique identifier. Use expand to request additional fields in the returned alert object.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
idstringrequired
The unique identifier of the billing alert, limited to 5000 characters.
expandarray<string>optional
Fields to expand in the response; each value must be no longer than 5000 characters.

2 status codes
200Returns the billing alert, including its identifier, alert type, title, status, mode, and usage-threshold configuration.
alert_typestringrequired
Defines the type of the alert.
Allowed:usage_threshold
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:billing.alert
statusstringoptional
Status of the alert. This can be active, inactive or archived.
Allowed:activearchivedinactive
titlestringrequired
Title of the alert.
usage_thresholdobjectoptional
Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://docs.stripe.com/api/billing/meter).
defaultError response.
errorobjectrequired

Error handling

id must be a string no longer than 5000 characters and must identify the billing alert to retrieve. Each expand value must be a string no longer than 5000 characters.