Meters
Meter and usage reporting endpoints
List meter subscriptions by ID
Looks up a meter by its UUID and returns the subscriptions (with their products) that can report usage to it — i.e. subscriptions holding a product whose price is linked to this meter. Paused subscriptions are excluded.
Returns an empty subscriptions array when no product price uses the meter.
Responds 404 with code METER_NOT_FOUND if the meter does not exist in
your company, and 403 with code LICENSE.REQUIRED if your company lacks
the Metered Products or Subscription license.
Required Scope
meter-report
path Parameters
meterIdThe unique identifier of the meter
List meter subscriptions by ID › Responses
Subscriptions and products that can report usage to this meter
meterIdMeter ID
meterNameMeter name
Subscriptions with products using this meter
Report usage
Reports a usage event to a meter for metered subscription billing. Ingestion
is asynchronous: a successful report returns 202 with status: queued
and a requestId — the event is not yet visible the moment the call
returns.
The Idempotency-Key header is required (400 when missing). Replaying a
request with the same key returns 200 with status: duplicate and the
event is not ingested twice, so retries are always safe.
Use the meter-subscriptions endpoints to discover which subscriptions and products can report usage to a given meter.
Required Scope
meter-report
Headers
x-api-idempotency-keyIdempotency key to deduplicate submissions
Report usage › Request Body
valueUsage value to record
customerIdCustomer ID this usage is associated with.
meterIdMeter identifier. Provide meterId or meterName. Meter must be ACTIVE; usage will be rejected for archived meters.
meterNameMeter name. Provide meterId or meterName. Meter must be ACTIVE; usage will be rejected for archived meters.
timestampISO-8601 timestamp. Defaults to now.
metadataAdditional metadata for the usage event (values must be string, number, or boolean)
Report usage › Responses
Duplicate request detected
statusidempotencyKeyList meter subscriptions by name
Looks up a meter by its name (?meterName=) and returns the subscriptions
(with their products) that can report usage to it — useful when your
integration knows the meter's name (e.g. api_calls) but not its UUID.
Paused subscriptions are excluded.
Returns an empty subscriptions array when no product price uses the meter.
Responds 400 with code METER_IDENTIFIER_REQUIRED when meterName is
missing, 404 with code METER_NOT_FOUND if no meter has that name in
your company, and 403 with code LICENSE.REQUIRED if your company lacks
the Metered Products or Subscription license.
Required Scope
meter-report
query Parameters
meterNameThe name of the meter to look up
List meter subscriptions by name › Responses
Subscriptions and products that can report usage to this meter (lookup by name)
meterIdMeter ID
meterNameMeter name
Subscriptions with products using this meter