PApaypal
Events

Create a new usage event

post/events

Request

Request body

transaction_idstring required

Unique identifier for the transaction associated with the event

external_subscription_idstring required

External subscription ID associated with the event

metric_codestring required

Identifier for the targeted metric. This value must match the code property of an active metric; otherwise, it will be disregarded during processing.

timestampstring date-time

Date and time in ISO 8601 format.

propertiesobject

Example request

{
  "transaction_id": "txn_1234567890abcdef",
  "external_subscription_id": "sub_1234567890abcdef",
  "metric_code": "event_code_123456",
  "timestamp": "2023-10-01T12:00:00Z"
}

Response

Event created successfully

transaction_idstring required

Unique identifier for the transaction associated with the event

external_subscription_idstring required

External subscription ID associated with the event

metric_codestring required

Identifier for the targeted metric. This value must match the code property of an active metric; otherwise, it will be disregarded during processing.

timestampstring date-time

Date and time in ISO 8601 format.

propertiesobject
idstring

Unique identifier for the event

created_atstring date-time

Date and time in ISO 8601 format.

Example response

{
  "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.