Skip to main content
GET
Get consumed units for a customer

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

id
string
required

Query Parameters

customer_id
string
required

The customer whose consumption is read

Example:

"cust_abc123"

at
string

ISO 8601 instant. When present, the consumption is replayed from the raw events as of that point in time, within the billing period that contains it. When absent, the current billing period’s projected total is returned.

Example:

"2026-08-15T00:00:00.000Z"

Response

Consumed units for the period

meter_id
string
required

Meter ID

Example:

"mtr_abc123"

customer_id
string
required

Customer ID

Example:

"cust_abc123"

units
string
required

Consumed units for the period, as a string for BigInt safety

Example:

"1280"

period_start
string
required

Start of the billing period (inclusive, ISO 8601)

period_end
string
required

End of the billing period (exclusive, ISO 8601)

updated_at
string | null
required

When the projection was last advanced. Null when no usage has been folded into this period yet, and always null for an at= reply (which is replayed from raw events rather than read from the projection).

as_of
string

The point in time the units were replayed as of. Present only when at= was supplied.