v49

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

Alert

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.

post/alerts/external_customer_id/{external_customer_id}

Path parameters

external_customer_idstring nullable required

Request body

type'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered' required

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

currencystring required

The case sensitive currency or custom pricing unit to use for this alert.

Response

Created

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