List Events

Get a list of all events.

GET /events

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: 'My Bearer Token',
});

// Automatically fetches more pages as needed.
for await (const event of client.usageEvents.list()) {
  console.log(event.business_id);
}

200

{
  "items": [
    {
      "business_id": "<string>",
      "customer_id": "<string>",
      "event_id": "<string>",
      "event_name": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id · string

Filter events by customer ID

event_name · string

Filter events by event name. If both event_name and meter_id are provided, they must match the meter's configured event_name

meter_id · string

Filter events by meter ID. When provided, only events that match the meter's event_name and filter criteria will be returned

page_size · integer<int32>

Number of events to return per page (default: 10)

Required range: x >= 0

page_number · integer<int32>

Page number (0-based, default: 0)

Required range: x >= 0

start · string<date-time>

Filter events created after this timestamp

end · string<date-time>

Filter events created before this timestamp

Response

200

application/json

Events retrieved successfully

items · object[] · required

Show child attributes