Get Event

Get an event by its ID.

GET /events/{event_id}

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

const event = await client.usageEvents.retrieve('event_id');

console.log(event.business_id);

200

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

Path Parameters

event_id · string · required

Unique event identifier (case-sensitive, must match the ID used during ingestion)

Response

200

application/json

Event retrieved successfully

business_id · string · required

customer_id · string · required

event_id · string · required

event_name · string · required

timestamp · string<date-time> · required

metadata · EventMetadata · object

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

Show child attributes