Batch usage events

POST

events

batch

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

curl --location --request POST "$LAGO_URL/api/v1/events/batch" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
	"events": [
      {
        "transaction_id": "__UNIQUE_ID__",
        "external_subscription_id": "__YOUR_SUBSCRIPTION_ID__",
        "code": "__BILLABLE_METRIC_CODE__",
        "timestamp": $(date +%s),
        "properties": {
          "custom_field": 12
        }
      }
    ]
  }'

This response does not have an example.

Authorizations

Authorization

string

header

required

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

Body

application/json

Batch events payload

events

object[]

required

events.transaction_id

string

required

This field represents a unique identifier for the event. It is crucial for ensuring idempotency, meaning that each event can be uniquely identified and processed without causing any unintended side effects.

Example:

"transaction_1234567890"

events.external_subscription_id

string

required

The unique identifier of the subscription in your application. This field is mandatory in order to link events to the correct customer subscription.

Example:

"sub_1234567890"

events.code

string

required

The code that identifies a targeted billable metric. It is essential that this code matches the code property of one of your active billable metrics. If the provided code does not correspond to any active billable metric, it will be ignored during the process.

Example:

"storage"

events.timestamp

This field captures the Unix timestamp in seconds indicating the occurrence of the event in Coordinated Universal Time (UTC). If this timestamp is not provided, the API will automatically set it to the time of event reception. You can also provide miliseconds precision by appending decimals to the timestamp.

Example:

"1651240791.123"

events.precise_total_amount_cents

string | null

The precise total amount in cents with precision used by the dynamic pricing model to compute the usage amount.

Example:

"1234.56"

events.properties

object

This field represents additional properties associated with the event, which are utilized in the calculation of the final fee. This object becomes mandatory when the targeted billable metric employs a sum_agg, max_agg, or unique_count_agg aggregation method. However, when using a simple count_agg, this object is not required.

Example:

{ "gb": 10 }

Response

200

_mintlify/placeholder

Event received

Was this page helpful?

Suggest edits Raise issue

Send usage event Estimate an upcoming fee

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

curl --location --request POST "$LAGO_URL/api/v1/events/batch" \
--header "Authorization: Bearer $API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
	"events": [
      {
        "transaction_id": "__UNIQUE_ID__",
        "external_subscription_id": "__YOUR_SUBSCRIPTION_ID__",
        "code": "__BILLABLE_METRIC_CODE__",
        "timestamp": $(date +%s),
        "properties": {
          "custom_field": 12
        }
      }
    ]
  }'

This response does not have an example.

API Reference

Authorizations

Body

Response