Get usage this period so far
GET
Used, included, percent and amount so far for each metered entitlement, worked out as the next bill will be, before prepaid credit. Kept for 5 minutes, so it can be a few minutes behind. Secret and trusted tokens may call it; a limited token may not (403).
header
AuthorizationBearer <token>A secret, trusted or limited token. See Authentication.
agreement_id*stringThe agreement id.
Success.
application/json- response
object?stringAlways usage_period_so_far.
agreement_id?stringThe agreement.
customer_id?stringYour id for the customer.
currency?stringThe agreement's currency.
period_start?stringStart of the period not billed yet.
Format
date-timeperiod_end?stringThe subscription's next renewal, when known.
Format
date-timeas_of?stringUsage is counted up to this hour.
Format
date-timeentitlements?array<>One line per metered entitlement.
curl -X GET 'https://api.comecero.com/api/v1/usage/agreements/string/current'Example Response
{ "object": "usage_period_so_far", "agreement_id": "agr_cust_8412", "customer_id": "cust_8412", "currency": "USD", "period_start": "2026-11-01T00:00:00Z", "period_end": "2026-12-01T00:00:00Z", "as_of": "2026-11-12T10:00:00Z", "entitlements": [ { "entitlement_id": "ent_cust_8412_ai_tokens", "metric_id": "met_ai_tokens", "metric_key": "ai_tokens", "metric_name": "AI tokens", "unit_label": "token", "used": 830000, "included": 1000000, "percent": 83, "amount": 0 } ]}