curl --request POST \
--url https://api.withorb.com/v1/alerts/{alert_configuration_id}/disable \
--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
}
]
}
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.
curl --request POST \
--url https://api.withorb.com/v1/alerts/{alert_configuration_id}/disable \
--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
}
]
}
API Keys can be issued in the Orb's web application.
Used to update the status of a plan alert scoped to this subscription_id
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.
Was this page helpful?