Sign in

v49

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-081445491.8 MB
Alert

Enable alert by ID

This endpoint allows you to enable an alert. To enable 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.

post/alerts/{alert_configuration_id}/enable

Path parameters

alert_configuration_idstring required

Query parameters

subscription_idstring nullable

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

Response

OK

idstring required

Also referred to as alert_id in this documentation.

created_atstring date-time required

The creation time of the resource in Orb.

enabledboolean required

Whether the alert is enabled or disabled.

currencystring nullable required

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

grouping_keysstring[] nullable

The property keys to group cost alerts by. Only present for cost alerts with grouping enabled.

Example response

{
  "id": "XuxCbt7x9L82yyeF",
  "plan": {
    "id": "m2t5akQeh2obwxeU",
    "external_plan_id": "m2t5akQeh2obwxeU",
    "name": "Example plan"
  },
  "subscription": {
    "id": "VDGsT23osdLb84KD"
  }
}