Sample - Stripe API
POST/v1/billing/alerts/{id}/archive

Archive a billing alert

Triggers archival of a billing alert and removes it from list views and APIs. Archiving is non-reversible, so use id to select the alert and confirm that it should no longer be available before submitting the request.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
idstringrequired
The unique identifier of the billing alert to archive, limited to 5000 characters.

Optional form-encoded request body used to request expanded response fields.

expandarray<string>optional
Specifies which fields in the response should be expanded.

2 status codes
200Returns the archived billing alert, including its identifier, alert type, title, archived status, 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 archive. Each expand value must be a string no longer than 5000 characters.