---
title: "A new alert was triggered"
method: POST
path: "usage-billing.subscription-alert.triggered"
tags: ["Alerts"]
---

# A new alert was triggered

`POST usage-billing.subscription-alert.triggered` (webhook)

Threshold defined in the alert was crossed.

## Headers

- `paypal-transmission-id` string
- `paypal-transmission-time` string

## Payload

- object
  - `id` string, required: Unique identifier for the webhook event.
  - `create_time` string, date-time, required: Date and time in ISO 8601 format.
  - `event_version` string: Version of the event schema.
  - `summary` string: Brief description of the event.
  - `resource_version` string: Version of the resource schema.
  - `links` Link[]: HATEOAS links for the webhook event.
    - `href` string, uri, required: URL for the action.
    - `rel` string, required: Relation type of the link.
    - `method` string, required: HTTP method to use with the URL.
  - `resource_type` 'subscription-alert' | 'wallet' | 'wallet-transaction' | 'credit-note' | 'invoice' | 'subscription', required: Type of resource that triggered the webhook.
  - `event_type` 'USAGE-BILLING.SUBSCRIPTION-ALERT.TRIGGERED' | 'USAGE-BILLING.WALLET.CREATED' | 'USAGE-BILLING.WALLET.UPDATED' | 'USAGE-BILLING.WALLET.NET-BALANCE-DEPLETED' | 'USAGE-BILLING.WALLET.TERMINATED' | 'USAGE-BILLING.WALLET-TRANSACTION.CREATED' | 'USAGE-BILLING.WALLET-TRANSACTION.UPDATED' | 'USAGE-BILLING.CREDIT-NOTE.CREATED' | 'USAGE-BILLING.CREDIT-NOTE.REFUND.FAILED' | 'USAGE-BILLING.INVOICE.CREATED' | 'USAGE-BILLING.INVOICE.PAYMENT.OVERDUE' | 'USAGE-BILLING.INVOICE.PAYMENT.SUCCEEDED' | 'USAGE-BILLING.INVOICE.PAYMENT.FAILED' | 'USAGE-BILLING.SUBSCRIPTION.UPDATED' | 'USAGE-BILLING.SUBSCRIPTION.TERMINATED' | 'USAGE-BILLING.SUBSCRIPTION.TRIAL.ENDED', required: Type of event that occurred in webhooks.
  - `resource` TriggeredAlertObject, required
    - `id` string, required: Unique identifier for the alert.
    - `external_subscription_id` string, required: External identifier of the subscription associated with the alert.
    - `metric_code` string: The code of the metric associated with the alert.
    - `type` 'CURRENT_USAGE_AMOUNT' | 'METRIC_CURRENT_USAGE_AMOUNT' | 'METRIC_CURRENT_USAGE_UNITS' | 'LIFETIME_USAGE_AMOUNT', nullable, required: Type of alert trigger
    - `code` string, required: The code used to configure the alert.
    - `name` string: The name used during the alert configuration.
    - `current_value` number, required: The current usage value that was compared against configured thresholds when the alert was evaluated.
    - `previous_value` number: The usage value when the alert was evaluated previously.
    - `crossed_thresholds` TriggeredAlertAlertThreshold[]: Array of thresholds that were crossed when the alert was triggered. Includes all applicable recurring thresholds.
      - `code` string, required: Code representing the threshold.
      - `value` string, required: Value at which the threshold was triggered.
      - `recurring` boolean: Indicates whether the threshold is recurring.
    - `triggered_at` string, date-time, required: Date and time in ISO 8601 format.

## Acknowledgement `204`

Return a 204 status to indicate that the data was received successfully.

---

[API](https://skmtc.dev/paypal/apis/usage-based-billing-api.md) - [All operations](https://skmtc.dev/paypal/apis/usage-based-billing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paypal/apis/usage-based-billing-api/revisions/22fb46514ac4?raw)