Retrieve an event

GET

events

{transaction_id}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/events/:transaction_id" \
  --header "Authorization: Bearer $API_KEY"

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

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/events/:transaction_id" \
  --header "Authorization: Bearer $API_KEY"

Authorizations

Authorization

string

header

required

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

Path Parameters

transaction_id

string

required

This field represents the unique identifier sent for this specific event (must be URL encoded).

Example:

"transaction_1234567890"

Response

200

application/json

Event

event

object

required

event.lago_id

string

required

Unique identifier assigned to the event within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the event's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

event.transaction_id

string

required

This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.

Example:

"transaction_1234567890"

event.lago_customer_id

string | null

required

Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

event.code

string

required

The code that identifies a targeted billable metric. It is essential that this code matches the code property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.

Example:

"storage"

event.timestamp

string

required

This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception.

Example:

"2022-04-29T08:59:51.123Z"

event.lago_subscription_id

string | null

required

Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription's record within the Lago system

Example:

"1a901a90-1a90-1a90-1a90-1a901a901a90"

event.external_subscription_id

string

required

The unique identifier of the subscription within your application. It is a mandatory field when the customer possesses multiple subscriptions or when the external_customer_id is not provided.

Example:

"sub_1234567890"

event.created_at

string

required

The creation date of the event's record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC). It provides the precise timestamp of when the event's record was created within the Lago application

Example:

"2022-04-29T08:59:51Z"

event.precise_total_amount_cents

string | null

The precise total amount that was sent in the event payload. This filed is used by the dynamic pricing model.

Example:

"1234.56"

event.properties

object

This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a sum_agg, max_agg, or unique_count_agg aggregation method. However, when using a simple count_agg, this object is not required.

Example:

{ "gb": 10 }

Was this page helpful?

Suggest edits Raise issue

Estimate an upcoming fee List all events

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request GET "$LAGO_URL/api/v1/events/:transaction_id" \
  --header "Authorization: Bearer $API_KEY"

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

API Reference

Authorizations

Path Parameters

Response