Create billable metric

Route

POST

/api/v1/billable_metrics

Usage

Curl

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": "bm_name",
      "code": "bm_code",
      "description": "description",
      "aggregation_type": "sum_agg",
      "field_name": "amount_sum"
    }
  }'

Python

from lago_python_client import Client
from lago_python_client.models import BillableMetric

client = Client(api_key='__YOUR_API_KEY__')

billable_metric = BillableMetric(
  name='name',
  code='code_first',
  description='desc',
  aggregation_type='sum_agg',
  field_name='amount_sum'
)
client.billable_metrics().create(billable_metric)

Ruby

require 'lago-ruby-client'

client = Lago::Api::Client.new({api_key: '__YOUR_API_KEY__'})

client.billable_metrics.create({
    name: 'BM1',
    code: 'code_bm',
    description: 'description',
    aggregation_type: 'sum_agg',
    field_name: 'amount_sum',
})

Node.js

import BillableMetric from 'lago-nodejs-client/billable_metric'

let client = new Client('__API_KEY__')

let billableMetric = new BillableMetric({name: 'name1', code: 'code1', aggregationType: 'sum_agg',
  fieldName: 'field_name'
})
await client.createBillableMetric(billableMetric);

Go

  import "fmt"
  import "github.com/getlago/lago-go-client"

  func main() {
    lagoClient := lago.New().
      SetApiKey("__YOUR_API_KEY__")

    bmInput := &lago.BillableMetricInput{
      Name:            "First Billable Metric",
      Code:            "first_bm",
      Description:     "My First Billable Metric"
      AggregationType: lago.CountAggregation,
      FieldName:       "sum",
    }

    billableMetric, err := lagoClient.BillableMetric().Create(bmInput)
    if err != nil {
      // Error is *lago.Error
      panic(err)
    }
      
    // billableMetric is *lago.BillableMetric
    fmt.Println(billableMetric)
  }

Arguments

{
  "billable_metric": {
    "name": "bm_name",
    "code": "bm_code",
    "description": "description",
    "aggregation_type": "sum_agg",
    "field_name": "amount_sum"
  }
}

Attributes	Type	Description
name	String      Required	Billable metric name
code	String      Required	Code identifying the billable metric
description	String      Optional	Description of the billable metric
aggregation_type	String      Required	Aggregation type that is used in event calculations. It can be count_agg (metered), sum_agg (metered), max_agg (metered), unique_count_agg (metered) or recurring_count_agg (persistent)
field_name	String      Required (optional only for count_agg aggregation type)	Field name used in events.

Responses

HTTP 200

The billable metric was created

Returns a billable metric object.

HTTP 400

{
  "status": 400,
  "error": "Bad Request"
}

The billable_metric json root is not present in the request body.

HTTP 401

{
  "status": 401,
  "error": "Unauthorized"
}

Access to the API endpoint is unhautorized.

Possible reasons are:

• The Authorization header is missing
• The Authorization header does not contain the API key
• The Api key is invalid or expired

HTTP 422

{
  "status": 422,
  "error": "Unprocessable entity",
  "message": "message"
}

Possible error messages:

• Validation error on the record