Sign in

v1

latestOpenAPI 3.1.02026-07-265817860.8 KB
events

List usage events for your organization. Filter by customer, feature, or time range.

post/v1/events.list

Headers

x-api-versionstring required

Request body

start_cursorstring

Opaque pagination cursor. Empty string (default) requests the first page; use next_cursor from a prior response for subsequent pages.

limitinteger

Number of items to return. Default 50, hard ceiling 5000.

customer_idstring

Filter events by customer ID

entity_idstring

Filter events by entity ID (e.g., per-seat or per-resource)

Example request

{
  "start_cursor": "",
  "customer_id": "cus_123",
  "limit": 50
}

Response

OK

next_cursorstring nullable required

Opaque cursor for the next page. Null when there are no more results.

Example response

{
  "list": [
    {
      "id": "evt_36xpk2TmuQX5zVPPQ8tCtnR5Weg",
      "timestamp": 1765958215459,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 30,
      "properties": {},
      "deductions": [
        {
          "balance_id": "cus_ent_3DdSDtFBlvDbjyUuJeUIbQlyN12",
          "feature_id": "credits",
          "plan_id": "pro",
          "reset": {
            "interval": "month",
            "resets_at": 1765958215459
          },
          "value": 30
        }
      ]
    },
    {
      "id": "evt_36xmHxxjAkqxufDf9yHAPNfRrLM",
      "timestamp": 1765956512057,
      "feature_id": "credits",
      "customer_id": "0pCIbS4AMAFDB1iBMNhARWZt2gDtVwQx",
      "value": 49,
      "properties": {},
      "deductions": null
    }
  ],
  "next_cursor": "eyJ2IjowLCJpZCI6ImV2dF8zNnhtSHh4akFrcXh1ZkRmOXlIQVBOZlJyTE0iLCJ0IjoxNzY1OTU2NTEyMDU3fQ"
}