PApaypal
Events

Query usage events

get/events

Request

Query parameters

pageinteger

Page number

per_pageinteger

Number of records per page

external_subscription_idstring
Example:sub_1234567890abcdef

Filter events by external subscription ID

metric_codestring
Example:metric_123456ef

Filter events by metric code

from_datestring date-time
Example:2023-01-01T00:00:00Z

Start date for filtering events

to_datestring date-time
Example:2023-01-01T00:00:00Z

End date for filtering events

Response

A list of usage events

Example response

{
  "events": [
    {
      "transaction_id": "txn_1234567890abcdef",
      "external_subscription_id": "sub_1234567890abcdef",
      "metric_code": "event_code_123456",
      "timestamp": "2023-10-01T12:00:00Z",
      "id": "evt_1234567890abcdef",
      "created_at": "2023-10-01T12:00:00Z"
    }
  ]
}

Changes

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