Skip to main content
GET
List individual usage entries

Authorizations

X-SALESBRICKS-KEY
string
header
required

API key for authentication

Path Parameters

brick_id
string
required
Pattern: ^([a-zA-Z\d\-]+)$
subscription_id
string
required
Pattern: ^([a-zA-Z\d\-]+)$

Query Parameters

from
string

Start of the range (inclusive). ISO 8601 (YYYY-MM-DD or full datetime). Date-only values are interpreted in the subscription's time zone.

limit
integer

Page size. Defaults to 25, max 100.

offset
integer

Number of entries to skip.

Optional free-text filter. Matches (OR) against the transaction_id, the entry's properties JSON (as text), and — when the term parses as a number — the exact recorded value.

to
string

End of the range (inclusive). ISO 8601. Date-only values resolve to the end of that day in the subscription's time zone.

Response

transaction_id
string
required

The unique identifier of this usage entry. Use it with PATCH /usage and DELETE /usage to update or remove the entry.

subscription_id
string<uuid>
required
brick_id
string<uuid>
required
value
number<double>
required

The recorded usage value. Integer for whole quantities, decimal for fractional.

Required range: -100000000000000 < x < 100000000000000
time
string<date-time>
required

The timestamp the usage was recorded against.

properties
unknown