Update
Authorizations
API key authentication
Path Parameters
Unique identifier for a billable metric
^bm_[a-zA-Z0-9]+$Body
Revised explanation of what the metric represents. Sample values: 'Language model token consumption', 'Database storage capacity used', 'Machine learning prediction API calls', 'AI-generated content items'
Updated label for the metric. Sample values: 'LLM Tokens', 'Database Storage', 'Prediction Requests', 'Content Generations'
Updated measurement unit. Common examples: 'tokens', 'GB', 'requests', 'items', 'hours'
Optional item tag, used to map this metric's invoice lines to an external accounting/tax identity. Send a new id to re-tag — the item must be filed under this charge's own product, and an archived item is rejected. An item from another product is refused with ITEM_PRODUCT_MISMATCH: a tag is an accounting grouping and does not move the charge between products, and no field here could move it back. Re-file the item to move every charge anchored to it together. Send null to untag. Every line item whose invoice has not closed reports this charge's current tag, so a re-tag takes effect on the bill in progress and on any generated ahead of it — no further action, and no window to wait for. Lines on a closed invoice keep the item recorded at close and never move. Un-tagging works the same way: those lines report no item.
^itm_[a-zA-Z0-9]+$CloudEvents type for meter routing.
JSONPath to extract a numeric value from event data. Must start with $. (example: $.amount or $.payload.bytes).
^\$\.[a-zA-Z0-9_]+(\.[a-zA-Z0-9_]+)*$Map of dimension name to JSONPath for group-by queries. Each value must start with $. (example: $.region).
Only count events after this timestamp.
Response
Billable metric updated successfully
Unique identifier for a billable metric
^bm_[a-zA-Z0-9]+$billableMetric SUM, COUNT, AVG, MIN, MAX, UNIQUE_COUNT, LATEST Unique identifier for an organization
^org_[a-zA-Z0-9]+$The product this metric belongs to. Always populated; derived from the item's catalog when the metric is tagged with an item.
^prod_[a-zA-Z0-9]+$The item this metric is tagged with, or null when untagged. Used to map this metric's invoice lines to an external accounting/tax identity.
^itm_[a-zA-Z0-9]+$