The alert object

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_organization_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "subscription_external_id": "sub_1234567890",
  "customer_external_id": "cus_0987654321",
  "billable_metric": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Storage",
    "code": "storage",
    "description": "GB of storage used in my application",
    "recurring": false,
    "rounding_function": "round",
    "rounding_precision": 2,
    "created_at": "2022-09-14T16:35:31Z",
    "expression": "round((ended_at - started_at) * units)",
    "field_name": "gb",
    "aggregation_type": "sum_agg",
    "weighted_interval": "seconds",
    "filters": [
      {
        "key": "region",
        "values": [
          "us-east-1"
        ]
      }
    ]
  },
  "alert_type": "billable_metric_current_usage_amount",
  "code": "storage_threshold_alert",
  "name": "Storage Usage Alert",
  "previous_value": 1000,
  "last_processed_at": "2025-05-19T10:04:21Z",
  "thresholds": [
    {
      "code": "warn",
      "recurring": false,
      "value": "99.0"
    }
  ],
  "created_at": "2025-03-20T10:00:00Z"
}

lago_id

string<uuid>

required

Unique identifier of the alert, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

lago_organization_id

string<uuid>

required

Unique identifier of the organization, created by Lago.

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

subscription_external_id

string

required

The subscription external unique identifier (provided by your own application).

Example:

"sub_1234567890"

customer_external_id

string

required

The customer external unique identifier (provided by your own application).

Example:

"cus_0987654321"

billable_metric

object

required

The billable metric associated with the alert. Only for alerts based on a billable metric.

Show child attributes

alert_type

enum<string>

required

The type of alert.

Available options:

current_usage_amount,

billable_metric_current_usage_amount,

billable_metric_current_usage_units,

lifetime_usage_amount

Example:

"billable_metric_current_usage_amount"

code

string

required

Unique code used to identify the alert.

Example:

"storage_threshold_alert"

name

string | null

required

The name of the alert.

Example:

"Storage Usage Alert"

previous_value

number

required

When the system checked if this alert should be triggered, this value was retrieved and checked against the thresholds.

Example:

1000

last_processed_at

string<date-time> | null

required

The date and time in UTC (ISO 8601) when the system checked if this alert should be triggered. Null until it's processed for the first time.

Example:

"2025-05-19T10:04:21Z"

thresholds

object[]

required

Array of thresholds associated with the alert.

Show child attributes

created_at

string<date-time>

required

The date and time in UTC (ISO 8601) when the alert was created.

Example:

"2025-03-20T10:00:00Z"

List all add-ons Create an alert

⌘I

API Reference