Disable alert by ID
This endpoint allows you to disable an alert. To disable a plan-level alert for a specific subscription, you must include
the subscription_id. The subscription_id is not required for customer or subscription level alerts.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Query Parameters
Used to update the status of a plan alert scoped to this subscription_id
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.
Also referred to as alert_id in this documentation.
The type of alert. This must be a valid alert type.
usage_exceeded, cost_exceeded, credit_balance_depleted, credit_balance_dropped, credit_balance_recovered The creation time of the resource in Orb.
Whether the alert is enabled or disabled.
The thresholds that define the conditions under which the alert will be triggered.
The customer the alert applies to.
The plan the alert applies to.
The subscription the alert applies to.
The metric the alert applies to.
The name of the currency the credit balance or invoice cost is denominated in.
Was this page helpful?