BillKit/Docs Console
Usage records

Create usage record

Report usage against a metered subscription.

POST/v1/subscriptions/{subscription_id}/usage_records
Operation create_usage_record · Scope usage_records:write · Spec snapshot 2026-09-13

Parameters

ParameterDescription
subscription_idstring · pathrequiredNo description in the spec.
quantityintegerrequiredBetween 1 and 1000000.
identifierstring | nulloptionalAt most 255 characters.
metadataobject | nulloptionalAt most 50 keys.
occurred_atinteger | nulloptionalMinimum 0.

Returns

Returns an UsageRecordResponse object.

Errors

Status Cause
401 Missing or invalid API key.
403 Key is missing the usage_records:write scope.
404 No such object, or it belongs to the other mode.
422 Validation Error
429 Rate limited. Back off and retry.
Request · curl 
curl -X POST https://api.billkit.eu/v1/subscriptions/sub_9XKp2vQ1/usage_records \
  -H "Authorization: Bearer $BILLKIT_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"quantity":0}'
Request body · every field 
{
  "identifier": "string",
  "metadata": {
    "key": "value"
  },
  "occurred_at": 1789392000,
  "quantity": 0
}
Response · 201 Created 
{
  "created": 1789392000,
  "id": "ur_9XKp2vQ1",
  "identifier": "string",
  "invoice_id": "inv_9XKp2vQ1",
  "livemode": false,
  "metadata": {
    "key": "value"
  },
  "object": "usage_record",
  "occurred_at": 1789392000,
  "quantity": 0,
  "subscription_id": "sub_9XKp2vQ1",
  "written_off_at": 1789392000
}