API Reference · Events

List events

Returns a cursor-paginated list of events.

GET/v1/events

Filter by type or type prefix. Sorted by `created` descending. Only events from the current livemode are returned.

Query parameters

limitintegerdefault: 10

Max results.

Constraints: 1 <= limit <= 100

starting_afterstring

Cursor for the next page.

ending_beforestring

Cursor for the previous page.

typestring

Exact event type, e.g. `payment.succeeded`.

type[]array

Multiple exact type matches.

created[gte]integer

Lower bound on `created` (unix, inclusive).

created[lte]integer

Upper bound on `created` (unix, inclusive).