The billable metric object

{
  "billable_metric": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Storage",
    "code": "storage",
    "description": "GB of storage used in my application",
    "recurring": false,
    "created_at": "2022-09-14T16:35:31Z",
    "field_name": "gb",
    "aggregation_type": "sum_agg",
    "weighted_interval": "seconds",
    "filters": [
      {
        "key": "region",
        "values": [
          "us-east-1"
        ]
      }
    ],
    "active_subscriptions_count": 4,
    "draft_invoices_count": 10,
    "plans_count": 4
  }
}

Attributes

object

Hide object

string

required

Unique identifier of the billable metric created by Lago.

string

required

Name of the billable metric.

string

required

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

string | null

Internal description of the billable metric.

string

required

Creation date of the billable metric.

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 previous 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.

string | null

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

enum<string>

required

Aggregation method used to compute usage for this billable metric. Possible values are count_agg, sum_agg, max_agg, unique_count_agg, latest_agg or weighted_sum_agg.

string

Parameter exclusively utilized in conjunction with the weighted_sum_agg 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.

object

Show object

string

required

Filter key to add to the event properties payload.

array

required

List of possible filter values.

integer

required

Number of active subscriptions using this billable metric.

integer

required

Number of draft invoices for which this billable metric is listed as an invoice item.

integer

required

Number of plans using this billable metric.

​Attributes

Attributes