The lifetime usage object

{
  "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "lago_subscription_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
  "external_subscription_id": "5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba",
  "external_historical_usage_amount_cents": 100,
  "invoiced_usage_amount_cents": 100,
  "current_usage_amount_cents": 100,
  "from_datetime": "2024-01-01T00:00:00Z",
  "to_datetime": "2024-12-31T23:59:59Z",
  "usage_thresholds": [
    {
      "amount_cents": 100,
      "completion_ratio": 0.5,
      "reached_at": "2024-01-01T00:00:00Z"
    }
  ]
}

lago_id

string<uuid>

required

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

Example:

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

lago_subscription_id

string<uuid>

required

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

Example:

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

external_subscription_id

string

required

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

Example:

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

external_historical_usage_amount_cents

integer

required

The historical usage amount in cents for the subscription (provided by your own application).

Example:

100

invoiced_usage_amount_cents

integer

required

The total invoiced usage amount in cents for the subscription.

Example:

100

current_usage_amount_cents

integer

required

The current usage amount in cents for the subscription on the current billing period.

Example:

100

from_datetime

string<date-time> | null

required

The recording start date and time of the subscription lifetime usage. The date and time must be in ISO 8601 format.

Example:

"2024-01-01T00:00:00Z"

to_datetime

string<date-time>

required

The recording end date and time of the subscription lifetime usage. The date and time must be in ISO 8601 format.

Example:

"2024-12-31T23:59:59Z"

usage_thresholds

object[]

Array of usage thresholds that apply to the subscription. Thresholds attached to the subscription take precedence over the ones attached to its plan. This array is returned only when at least one threshold applies.

Show child attributes