Create customer alert by external ID
This endpoint creates a new alert to monitor a customer’s credit balance. There are three types of alerts that can be scoped to
customers: credit_balance_depleted, credit_balance_dropped, and credit_balance_recovered. Customers can have a maximum
of one of each type of alert per credit balance currency.
credit_balance_dropped alerts require a list of thresholds to be provided while credit_balance_depleted
and credit_balance_recovered alerts do not require thresholds.
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 case sensitive currency or custom pricing unit to use for this alert.
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.
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?