v1

latestOpenAPI 3.1.02026-07-261444991.2 MB

Alert

Fetch alert

This endpoint retrieves an alert by its ID.

get/alerts/{alert_id}

Path parameters

alert_idstring required

Response

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"
  }
}