Skip to main content
POST
/
alerts
/
{alert_configuration_id}
/
enable
Enable alert by ID
curl --request POST \  --url https://api.withorb.com/v1/alerts/{alert_configuration_id}/enable \  --header 'Authorization: Bearer <token>'
{  "id": "XuxCbt7x9L82yyeF",  "type": "\"usage_exceeded\", \"cost_exceeded\", \"credit_balance_depleted\", \"credit_balance_recovered\", or \"credit_balance_dropped\"",  "created_at": "2023-11-07T05:31:56Z",  "enabled": true,  "thresholds": [  {  "value": 123  }  ],  "customer": {  "id": "<string>",  "external_customer_id": "<string>"  },  "plan": {  "id": "m2t5akQeh2obwxeU",  "external_plan_id": "m2t5akQeh2obwxeU",  "name": "Example plan",  "plan_version": "<string>"  },  "subscription": {  "id": "VDGsT23osdLb84KD"  },  "metric": {  "id": "<string>"  },  "currency": "<string>",  "balance_alert_status": [  {  "threshold_value": 123,  "in_alert": true  }  ] }

Authorizations

Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

alert_configuration_id
string
required

Query Parameters

subscription_id
string | null

Used to update the status of a plan alert scoped to this subscription_id

Response

OK

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.

id
string
required

Also referred to as alert_id in this documentation.

Examples:

"XuxCbt7x9L82yyeF"

type
required

The type of alert. This must be a valid alert type.

Available options:
credit_balance_depleted,
credit_balance_dropped,
credit_balance_recovered
Examples:

"\"usage_exceeded\", \"cost_exceeded\", \"credit_balance_depleted\", \"credit_balance_recovered\", or \"credit_balance_dropped\""

created_at
string<date-time>
required

The creation time of the resource in Orb.

enabled
boolean
required

Whether the alert is enabled or disabled.

thresholds
Threshold · object[] | null
required

The thresholds that define the conditions under which the alert will be triggered.

customer
object | null
required

The customer the alert applies to.

plan
object | null
required

The plan the alert applies to.

subscription
object | null
required

The subscription the alert applies to.

metric
object | null
required

The metric the alert applies to.

currency
string | null
required

The name of the currency the credit balance or invoice cost is denominated in.

balance_alert_status
BalanceAlertStatus · object[] | null

The current status of the alert. This field is only present for credit balance alerts.