Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

GET /v1/billing/usage
Returns metered usage counters for the current billing period. Each counter tracks a billable resource and shows how much you have consumed relative to your plan limit.

​
Response

Returns an array of usage counter objects.
​
metric
string
The usage metric identifier (e.g., attestations.mint, verifications_monthly, storage_bytes).
​
used
integer
Amount consumed in the current billing period.
​
limit
integer
Maximum allowed for this metric under your plan. A value of -1 means unlimited.
​
period
string
Billing period for this counter: monthly or total.
​
unit
string
Unit of measurement: count or bytes.
​
allowed
boolean
Whether the tenant is currently allowed to consume more of this metric. Returns false when the limit has been reached. Only included when relevant.
​
delta
integer
Change in usage since the last query. Only included when the server tracks incremental updates.

​
Tracked metrics

The usage endpoint returns up to 16 metrics organized by product group. Which metrics appear depends on your plan and active features.

​
Core

MetricDescriptionUnit
attestations.mintAttestations mintedcount
verifications_monthlyVerifications performedcount
storage_bytesTotal storage consumedbytes
proof_bundlesProof bundles generatedcount
webhook_endpointsActive webhook endpointscount
webhook_deliveriesWebhook deliveries sentcount
seatsTeam member seatscount

​
MAIP (Machine Identity)

MetricDescriptionUnit
maip.agentsRegistered machine agentscount
maip.sessionsAgent sessions createdcount
maip.trust_computesTrust score calculationscount
maip.compliance_checksCompliance verification requestscount

​
AI

MetricDescriptionUnit
ai.dataset_attestationsDatasets attested for lineagecount
ai.model_attestationsModels attested for provenancecount

​
Anti-Fraud

MetricDescriptionUnit
antifraud.risk_signalsRisk signals ingested or generatedcount
antifraud.deepfake_scansDeepfake scan requestscount
antifraud.velocity_recordsVelocity scoring recordscount
To check whether a specific operation is allowed before performing it, use the entitlements endpoint to verify your quotas.

​
Console dashboard

You can also view usage visually in the console at Settings > Billing > Usage. The dashboard shows all 16 metrics organized by product group (Core, MAIP, AI, and Anti-Fraud), each displayed as a progress bar against your plan limit. A projected monthly cost is calculated based on your current consumption and effective per-unit rates.