Create a billable metric

POST

billable_metrics

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/billable_metrics" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
    "billable_metric": {
    "name": "Storage",
    "code": "storage",
    "description": "GB of storage used in my application",
    "aggregation_type": "sum_agg",
    "recurring": false,
    "field_name": "gb",
    "weighted_interval": "seconds",
    "filters": [
      {
        "key": "region",
        "values": ["us-east-1", "us-east-2", "eu-west-1"]
      }
    ]
  }
}'

{
  "billable_metric": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Storage",
    "code": "storage",
    "description": "GB of storage used in my application",
    "recurring": false,
    "rounding_function": "round",
    "rounding_precision": 2,
    "created_at": "2022-09-14T16:35:31Z",
    "expression": "round((ended_at - started_at) * units)",
    "field_name": "gb",
    "aggregation_type": "sum_agg",
    "weighted_interval": "seconds",
    "filters": [
      {
        "key": "region",
        "values": [
          "us-east-1"
        ]
      }
    ]
  }
}

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/billable_metrics" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
    "billable_metric": {
    "name": "Storage",
    "code": "storage",
    "description": "GB of storage used in my application",
    "aggregation_type": "sum_agg",
    "recurring": false,
    "field_name": "gb",
    "weighted_interval": "seconds",
    "filters": [
      {
        "key": "region",
        "values": ["us-east-1", "us-east-2", "eu-west-1"]
      }
    ]
  }
}'

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Billable metric payload

billable_metric

object

required

billable_metric.name

string

Name of the billable metric.

billable_metric.code

string

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

billable_metric.description

string | null

Internal description of the billable metric.

billable_metric.recurring

boolean

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.

billable_metric.expression

string | null

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. Accepted function are ceil, concat and round as well as +, -, \ and * operations. Round is accepting an optional second parameter to specify the number of decimal.

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

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

billable_metric.field_name

string | null

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

billable_metric.aggregation_type

enum<string>

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

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

billable_metric.filters

object[]

Response

200

application/json

Billable metric created

billable_metric

object

required

billable_metric.lago_id

string

required

Unique identifier of the billable metric created by Lago.

billable_metric.name

string

required

Name of the billable metric.

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

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.

billable_metric.created_at

string

required

Creation date of the billable metric.

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

billable_metric.description

string | null

Internal description of the billable metric.

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

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

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.

billable_metric.field_name

string | null

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

billable_metric.weighted_interval

enum<string> | null

Available options:

seconds

billable_metric.filters

object[]

Was this page helpful?

Suggest edits Raise issue

The billable metric object Update a billable metric

LAGO_URL="https://api.getlago.com"
API_KEY="__YOUR_API_KEY__"

curl --location --request POST "$LAGO_URL/api/v1/billable_metrics" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
    "billable_metric": {
    "name": "Storage",
    "code": "storage",
    "description": "GB of storage used in my application",
    "aggregation_type": "sum_agg",
    "recurring": false,
    "field_name": "gb",
    "weighted_interval": "seconds",
    "filters": [
      {
        "key": "region",
        "values": ["us-east-1", "us-east-2", "eu-west-1"]
      }
    ]
  }
}'

{
  "billable_metric": {
    "lago_id": "1a901a90-1a90-1a90-1a90-1a901a901a90",
    "name": "Storage",
    "code": "storage",
    "description": "GB of storage used in my application",
    "recurring": false,
    "rounding_function": "round",
    "rounding_precision": 2,
    "created_at": "2022-09-14T16:35:31Z",
    "expression": "round((ended_at - started_at) * units)",
    "field_name": "gb",
    "aggregation_type": "sum_agg",
    "weighted_interval": "seconds",
    "filters": [
      {
        "key": "region",
        "values": [
          "us-east-1"
        ]
      }
    ]
  }
}

API Reference

Authorizations

Body

Response