The activity log object

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"

user_email

string<email> | null

required

The email of the user who performed the activity. It is null when the action was performed with an API key or by the system.

Example:

"dinesh@piedpiper.example"

activity_type

string

required

The action that was performed on the resource.

Example:

"billable_metric.created"

activity_source

enum<string>

required

The source that triggered the action.

Available options:

api,

front,

system

Example:

"api"

activity_object

object | null

required

The state of the resource after the action, keyed by top-level attribute name. Nested values are returned JSON-encoded.

Example:

{
  "lago_id": "dad68bc7-c01a-4ad8-a87b-13e78693a5bc",
  "plan_id": "b9155544-e261-4e92-b54e-f65d7609294c"
}

activity_object_changes

object | null

required

The attributes the action changed, keyed by attribute name. Each value is the JSON-encoded pair of the previous and the new value. It is empty when the activity type is not an update.

Example:

{
  "plan_id": "[null,\"b9155544-e261-4e92-b54e-f65d7609294c\"]"
}

external_customer_id

string | null

required

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

Example:

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

external_subscription_id

string | null

required

Unique identifier assigned to the subscription in your application.

Example:

"external_id"

resource_id

string<uuid>

required

The unique identifier of the resource the action was applied to.

Example:

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

resource_type

string

required

The type of the resource the action was applied to.

Example:

"BillableMetric"

logged_at

string<date-time>

required

The date when the action happened, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC).

Example:

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

created_at

string<date-time>

required

The creation date of the activity log record in the Lago application, presented in the ISO 8601 datetime format, specifically in Coordinated Universal Time (UTC).

Example:

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