Skip to main content
GET
Usage of a product, by customer

Authorizations

Authorization
string
header
required

A Custral secret API key (sk_…), created in Settings → Applications. Sent as Authorization: Bearer sk_…. The X-Api-Key: sk_… header is also accepted and takes precedence. Never expose a secret key in a browser.

Path Parameters

object
string
required

The object, by id or key.

id
string
required

The product record id (rec_…).

Query Parameters

moduleId
string

The usage module (umod_…) to read, when several meter the record's object. Defaults to the oldest.

Response

The product's usage, customer by customer.

data
object

The product's usage breakdown.

reqId
string

A per-request id (req_…). Quote it to support when reporting a problem.

Example:

"req_2a1f9c8e7b6d5"