# The Billing Alert Notification object

### The Billing Alert Notification object

```json
{
  "id": "threvt_12345",
  "object": "billing.alert_notification",
  "action": "triggered",
  "customer": "cus_12345",
  "notification_event": "evt_12345",
  "alert": "alrt_12345",
  "subscription": null,
  "cadence": null,
  "value": "12345",
  "currency": null,
  "alert_type": "usage_threshold",
  "meter": "mtr_12345",
  "aggregation_period_start": 1698796800,
  "aggregation_period_end": 1701388800,
  "livemode": false,
  "notified_at": 1700000020
}
```

## Attributes

- `id` (string)
  Unique identifier for the object.

- `object` (string, value is "billing.alert_notification")
  String representing the object’s type. Objects of the same type share the same value.

- `action` (enum)
  Whether the alert was triggered or recovered.
Possible enum values:
  - `recovered`
    The alert recovered below the threshold and a notification was sent.

  - `triggered`
    The alert threshold was crossed and a notification was sent.

- `aggregation_period_end` (timestamp, nullable)
  End of the aggregation period for which this notification was sent. Only present for usage threshold alerts.

- `aggregation_period_start` (timestamp, nullable)
  Start of the aggregation period for which this notification was sent. Only present for usage threshold alerts.

- `alert` (string)
  ID of the billing alert that generated this notification.

- `alert_type` (enum)
  The type of billing alert that generated this notification.
Possible enum values:
  - `usage_threshold`
    Use `usage_threshold` if you intend for an alert to fire when a usage threshold on a meter is crossed.

- `billing_group` (string, nullable)
  The billing group associated with this notification. Only present for spend threshold alerts grouped by billing group.

- `cadence` (string, nullable)
  The cadence associated with this notification. Only present for spend threshold alerts grouped by cadence.

- `currency` (string, nullable)
  Three-letter ISO currency code for the value, in lowercase. Only present for spend and credit balance threshold alerts.

- `customer` (string)
  ID of the customer for which the alert notification was sent.

- `livemode` (boolean)
  The value is `true` for objects in live mode and `false` for objects in a sandbox. For accounts that still have access to legacy test mode, the value is also `false` for objects in that mode.

- `meter` (string, nullable)
  ID of the billing meter associated with this notification. Only present for usage threshold alerts.

- `notification_event` (string)
  ID of the event delivered for this notification. Retrievable via the Events API for a limited time; for long-term audit scenarios, capture the full event payload at webhook delivery time.

- `notified_at` (timestamp)
  Time at which the notification was sent. Measured in seconds since the Unix epoch.

- `subscription` (string, nullable)
  ID of the subscription associated with this notification. Only present for spend threshold alerts grouped by subscription.

- `value` (string)
  The value that triggered the alert. This may be a decimal string for custom pricing unit alerts. For usage threshold alerts, this is the meter event count. For credit balance and spend threshold alerts, this is the amount in the smallest currency unit.