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.

curl -X POST https://api.stripe.com/v1/billing/alerts/alrt_12345/archive \
  -u "sk_test_Hrs6SAo...0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:"

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"
}

Deactivate a billing alert

POST /v1/billing/alerts/:id/deactivate

Deactivates this alert, preventing it from triggering.

Parameters

No parameters.

Returns

Returns the alert with its updated status.

curl -X POST https://api.stripe.com/v1/billing/alerts/alrt_12345/deactivate \
  -u "sk_test_Hrs6SAo...0bZXSN3f6ELNsk_test_Hrs6SAopgFPF0bZXSN3f6ELN:"

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": "inactive"
}