v1

latestOpenAPI 3.1.0AGPLv32026-07-26168262527.5 KB
events

Retrieve a specific event

This endpoint is used for retrieving a specific usage measurement event that has been sent to a customer or a subscription.

Note that transaction_id is unique per external_subscription_id so multiple subscriptions can share the same transaction_id. This endpoint will only return the first event found with the given transaction_id.

WARNING: If your Lago organization is configured to use the Clickhouse-based event pipeline, multiple events can share the same transaction_id (with different timestamps). This endpoint will only return the first event found.

get/events/{transaction_id}

Response

Event

Example response

{
  "event": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "transaction_id": "transaction_1234567890",
    "lago_customer_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "code": "storage",
    "timestamp": "2022-04-29T08:59:51.123Z",
    "precise_total_amount_cents": "1234.56",
    "properties": {
      "gb": 10
    },
    "lago_subscription_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "external_subscription_id": "sub_1234567890",
    "created_at": "2022-04-29T08:59:51Z"
  }
}