Skip to main content

Get current-period usage vs quota

GET 

/api/usage

Returns the current tenant's metered usage for the current billing period (UTC calendar month) compared against its quota limits. Admin only.

Each metric reports used, limit (null = unlimited), remaining (null when unlimited), and enforced (whether exhausting the limit actually blocks the consuming action vs. being measured only). When enabled is false, quotas are off platform-wide for this tenant: usage is still counted but no limit is applied (all limit/remaining are null).

Since the counter/quota split (doc 63) a quota is a limit over a SET of usage counters the platform owner chooses. metrics always carries the eight original quota keys and, after them, any quota the platform owner added; visible says whether the owner shows it to tenants. counters is the breakdown underneath: every counter used this period, with the quotas it currently feeds.

Responses​

The current-period usage summary.