Update alert
This endpoint updates the thresholds of an alert.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
The thresholds that define the values at which the alert will be triggered.
Response
Alerts within Orb monitor spending, usage, or credit balance and trigger webhooks when a threshold is exceeded.
Alerts created through the API can be scoped to either customers or subscriptions.
The creation time of the resource in Orb.
The name of the currency the credit balance or invoice cost is denominated in.
The customer the alert applies to.
Whether the alert is enabled or disabled.
Also referred to as alert_id in this documentation.
The metric the alert applies to.
The plan the alert applies to.
The subscription the alert applies to.
The thresholds that define the conditions under which the alert will be triggered.
The type of alert. This must be a valid alert type.
usage_exceeded
, cost_exceeded
, credit_balance_depleted
, credit_balance_dropped
, credit_balance_recovered
Was this page helpful?