Skip to main content
POST
/
alerts
/
customer_id
/
{customer_id}
Create customer alert
curl --request POST \
  --url https://api.withorb.com/v1/alerts/customer_id/{customer_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "thresholds": [
    {
      "value": 123
    }
  ],
  "type": "credit_balance_depleted",
  "currency": "<string>"
}'
{
  "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

Path Parameters

customer_id
string | null
required

Body

application/json
type
enum<string>
required
Available options:
credit_balance_depleted,
credit_balance_dropped,
credit_balance_recovered
currency
string
required
thresholds
Threshold · object[] | null

Response

id
string
required
Examples:
type
required
Available options:
credit_balance_depleted,
credit_balance_dropped,
credit_balance_recovered
Examples:
created_at
string<date-time>
required
enabled
boolean
required
thresholds
Threshold · object[] | null
required
customer
object | null
required
plan
object | null
required
subscription
object | null
required
metric
object | null
required
currency
string | null
required
balance_alert_status
BalanceAlertStatus · object[] | null