Reactivates this alert, allowing it to trigger again.

Parameters

No parameters.

Returns

Returns the alert with its updated status.

POST /v1/billing/alerts/:id/activate
curl -X POST https://api.stripe.com/v1/billing/alerts/alrt_12345/activate \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
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"
}

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.

POST /v1/billing/alerts/:id/archive
curl -X POST https://api.stripe.com/v1/billing/alerts/alrt_12345/archive \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
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"
}

Deactivates this alert, preventing it from triggering.

Parameters

No parameters.

Returns

Returns the alert with its updated status.

POST /v1/billing/alerts/:id/deactivate
curl -X POST https://api.stripe.com/v1/billing/alerts/alrt_12345/deactivate \
-u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
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"
}

Meters 

Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.

Related guide: Usage based billing

Meter Events 

Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.