PApaypal
Alerts

Retrieve subscription alerts

Retrieves all usage-based alerts configured for a specific subscription. Use this endpoint to monitor and manage billing alerts across different consumption thresholds.

get/subscriptions/{external_subscription_id}/alerts

Request

Path parameters

external_subscription_idstring required
Example:SUB_1752779018503

Unique external identifier for the subscription. This ID is used to track the subscription across systems and must be provided to access subscription-specific alerts.

Query parameters

per_pageinteger

Number of records per page

pageinteger

Page number

Response

Successfully retrieved the collection of alerts configured for the specified subscription.

Example response

{
  "alerts": [
    {
      "id": "alert_01H3YT8P7Q5R3S1T2U0V4W9X8",
      "external_subscription_id": "sub_external_12345",
      "type": "CURRENT_USAGE_AMOUNT",
      "code": "current_usage_monetary_alert",
      "name": "Monetary Usage Alert",
      "previous_value": 1000,
      "last_processed_at": "2025-05-19T10:04:21Z",
      "thresholds": [
        {
          "code": "warn",
          "recurring": false,
          "value": "99.0"
        }
      ],
      "created_at": "2025-04-20T10:00:00Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.