Create subscription alert
This endpoint is used to create alerts at the subscription level.
Subscription level alerts can be one of two types: usage_exceeded or cost_exceeded. A usage_exceeded alert is
scoped to a particular metric and is triggered when the usage of that metric exceeds predefined thresholds during the
current billing cycle. A cost_exceeded alert is triggered when the total amount due during the current billing cycle surpasses
predefined thresholds. cost_exceeded alerts do not include burndown of pre-purchase credits. Each subscription can have one
cost_exceeded alert and one usage_exceeded alert per metric that is a part of the subscription. Alerts are triggered based
on usage or cost conditions met during the current billing cycle.
Authorizations
API Keys can be issued in the Orb's web application.
Path Parameters
Body
The type of alert to create. This must be a valid alert type.
usage_exceeded, cost_exceeded, credit_balance_depleted, credit_balance_dropped, credit_balance_recovered The thresholds that define the values at which the alert will be triggered.
The metric to track usage for.
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?