aggregation_type
enum<string>
required

Aggregation method used to compute usage for this billable metric.

Available options:
count_agg,
sum_agg,
max_agg,
unique_count_agg,
weighted_sum_agg,
latest_agg
code
string
required

Unique code used to identify the billable metric associated with the API request. This code associates each event with the correct metric.

created_at
string
required

Creation date of the billable metric.

lago_id
string
required

Unique identifier of the billable metric created by Lago.

name
string
required

Name of the billable metric.

recurring
boolean
required

Defines if the billable metric is persisted billing period over billing period.

  • If set to true: the accumulated number of units calculated from the previous billing period is persisted to the next billing period.
  • If set to false: the accumulated number of units is reset to 0 at the end of the billing period.
  • If not defined in the request, default value is false.
description
string | null

Internal description of the billable metric.

expression
string

Expression used to calculate the event units. The expression is evalutated for each event and the result is then used to calculate the total aggregated units.

field_name
string | null

Property of the billable metric used for aggregating usage data. This field is not required for count_agg.

filters
object[]
rounding_function
enum<string> | null

Refers to the numeric value or mathematical expression that will be rounded based on the calculated number of billing units. Possible values are round, ceil and floor.

Available options:
ceil,
floor,
round
rounding_precision
integer | null

Specifies the number of decimal places to which the rounding_function will be rounded. It can be a positive or negative value.

weighted_interval
enum<string> | null

Parameter exclusively utilized in conjunction with the weighted_sum aggregation type. It serves to adjust the aggregation result by assigning weights and proration to the result based on time intervals. When this field is not provided, the default time interval is assumed to be in seconds.

Available options:
seconds