​
activity_id
string<uuid>
required

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

Example:

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

​
activity_type
string
required

This field stores the actitivy action that was performed to the activity_object.

Example:

"billing_metric.created"

​
activity_source
enum<string>
required

This field represents the source of the activity log, the interaction source that triggered the action.

Available options:
api,
front,
system
Example:

"api"

​
resource_id
string<uuid>
required

The resource id of the object that the action was applied.

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

​
resource_type
string
required

The resource type of the resource_id record.

Example:

"BillableMetric"

​
organization_id
string<uuid>
required

Unique identifier for the organization associated with the activity log.

Example:

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

​
logged_at
string<date-time>
required

The logged date of the activity, 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:

"2025-03-31T12:31:44Z"

​
created_at
string<date-time>
required

The creation date of the activity 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"

​
user_email
string<email> | null

The email of the user who performed the activity

Example:

"dinesh@piedpiper.test"

​
activity_object
object | null

This field represents the final state of the object that the action was applied.

Example:
{
  "lago_id": "dad68bc7-c01a-4ad8-a87b-13e78693a5bc",
  "plan_id": "b9155544-e261-4e92-b54e-f65d7609294c"
}
​
activity_object_changes
object | null
Example:
{
  "plan_id": [
    null,
    "b9155544-e261-4e92-b54e-f65d7609294c"
  ]
}
​
external_customer_id
string | null

The customer external unique identifier (provided by your own application)

Example:

"5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba"

​
external_subscription_id
string | null

Unique identifier assigned to the subscription in your application.

Example:

"external_id"