---
title: "Disable alert by ID"
method: POST
path: "/alerts/{alert_configuration_id}/disable"
tags: ["Alert"]
---

# Disable alert by ID

`POST /alerts/{alert_configuration_id}/disable`

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.

## Path parameters

- `alert_configuration_id` string, required

## Query parameters

- `subscription_id` string, nullable — Used to update the status of a plan alert scoped to this subscription_id

## Response `200`

OK

- Alert — [Alerts within Orb](/product-catalog/configuring-alerts) 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.
  - `id` string, required — Also referred to as alert_id in this documentation.
  - `type` union, required — The type of alert. This must be a valid alert type.
    - 'credit_balance_depleted' | 'credit_balance_dropped' | 'credit_balance_recovered'
    - 'usage_exceeded' | 'cost_exceeded'
    - 'license_balance_threshold_reached'
  - `created_at` string, date-time, required — The creation time of the resource in Orb.
  - `enabled` boolean, required — Whether the alert is enabled or disabled.
  - `thresholds` Threshold[], nullable, required — The thresholds that define the conditions under which the alert will be triggered.
    - `value` number, required — The value at which an alert will fire. For credit balance alerts, the alert will fire at or below this value. For usage and cost alerts, the alert will fire at or above this value.
  - `customer` CustomerMinified, required
    - `id` string, required
    - `external_customer_id` string, nullable, required
  - `plan` PlanMinifiedWithVersion, required
    - `id` string, nullable, required
    - `external_plan_id` string, nullable, required — An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.
    - `name` string, nullable, required
    - `plan_version` string, required
  - `subscription` SubscriptionMinified, required
    - `id` string, required
  - `metric` BillableMetricMinified, required
    - `id` string, required
  - `license_type` LicenseTypeMinified — Minified license type for alert serialization.
    - `id` string, required
  - `currency` string, nullable, required — The name of the currency the credit balance or invoice cost is denominated in.
  - `grouping_keys` string[], nullable — The property keys to group cost alerts by. Only present for cost alerts with grouping enabled.
  - `price_filters` PriceFilter[], nullable — Filters scoping which prices are included in grouped cost alert evaluation.
    - `field` 'price_id' | 'item_id' | 'price_type' | 'currency' | 'pricing_unit_id', required — The property of the price to filter on.
    - `operator` 'includes' | 'excludes', required — Should prices that match the filter be included or excluded.
    - `values` string[], required — The IDs or values that match this filter.
  - `threshold_overrides` ThresholdOverride[], nullable — Per-group threshold overrides. Each override maps a specific combination of grouping_keys values to a replacement threshold list. Only present for grouped cost alerts that have at least one override.
    - `group_values` string[], required — The values of the grouping keys that identify this group. The list length matches the alert's grouping_keys.
    - `thresholds` Threshold[], required — The thresholds applied to this group. An empty list means the group is silenced.
      - `value` number, required — The value at which an alert will fire. For credit balance alerts, the alert will fire at or below this value. For usage and cost alerts, the alert will fire at or above this value.
  - `balance_alert_status` BalanceAlertStatus[], nullable — The current status of the alert. This field is only present for credit balance alerts.
    - `threshold_value` number, required — The value of the threshold that defines the alert status.
    - `in_alert` boolean, required — Whether the alert is currently in-alert or not.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `409` — Conflict
- `413` — Content Too Large
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.dev/withorb/apis/api-reference.md) · [All operations](https://skmtc.dev/withorb/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/withorb/api-reference/revisions/816dfe734e2e/schema)