Alerts

Query alert logs

Changed on

Use when viewing or searching alert history (e.g. support triage or customer-facing alert log). Returns a paginated list; supports filtering by type, customer, subscription.

post/alerts/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/alerts/search
  • Auth
    API key in header x-api-key

Request body

alert_status'ok' | 'info' | 'warning' | 'in_alarm'
alert_type'low_ongoing_balance' | 'low_credit_balance' | 'feature_wallet_balance' | 'subscription_spend' | 'subscription_line_item_spend' | 'subscription_group_spend' | 'entitlement_grant_threshold' | 'entitlement_grant_exhausted'
customer_idstring
end_timestring date-time
entity_idstring
entity_type'wallet' | 'feature' | 'subscription' | 'subscription_line_item' | 'group' | 'entitlement_grant'
expandstring
limitinteger
offsetinteger
order'asc' | 'desc'
start_timestring date-time
status'published' | 'deleted' | 'archived'

Response

OK

Example response

{
  "items": [
    {
      "feature": {
        "meter": {
          "created_at": "2024-03-20T15:04:05Z",
          "event_name": "api_request",
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "name": "API Usage Meter",
          "status": "published",
          "tenant_id": "tenant123",
          "updated_at": "2024-03-20T15:04:05Z"
        }
      }
    }
  ]
}

Changes

  • 80eb0267435cRevision changes
    • info

      added the optional property /// to the response with the status

  • de915dc839feRevision changes
    • warning

      removed the optional property /// from the response with the status