Just launched
We're actively working on new content and improvements to our documentation. We'd love to hear your thoughts, launch quick survey
Paddle Billing
Search

List events

Returns a paginated list of events that have occurred. Use the query parameters to page through results.

This is sometimes referred to as "the event stream."

Query Parameters

afterstring

Return entities after the specified cursor. Used for working through paginated results.

order_bystring

Order returned entities by the specified field and direction ([ASC] or [DESC]).

per_pageinteger

Set how many entities are returned per page.

Response

dataarray[object]

Represents an event entity.

event_idstring

Unique Paddle ID for this event, prefixed with evt_.

event_typestring

Type of event sent by Paddle, in the format entity.event_type.

occurred_atstring<date-time>

RFC 3339 datetime string of when this event occurred.

notification_idstring

Unique Paddle ID for this notification, prefixed with ntf_.

dataobject

New or changed entity.

metaobject

Information about this response.

request_idstring

Unique ID for the request relating to this response. Provide this when contacting Paddle support about a specific request.

paginationobject

Keys used for working with paginated results.