Skip to main content
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"

lago_customer_id
string<uuid> | 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"

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"

timestamp
string<date-time>
required

The date and time at which the event occurred, in ISO 8601 format with millisecond precision and expressed in Coordinated Universal Time (UTC). When no timestamp is sent on the event, it is set to the time of event reception.

Example:

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

lago_subscription_id
string<uuid> | 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"

external_subscription_id
string
required

The unique identifier of the subscription within your application, as sent on the event. It is the value Lago uses to attach the event to a subscription.

Example:

"sub_1234567890"

lago_id
string | null

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. It is an opaque identifier and is not guaranteed to be a UUID; on organizations using the ClickHouse events store it is a composite string.

Example:

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

precise_total_amount_cents
string | null

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

Example:

"1234.56"

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:
created_at
string<date-time> | null

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"