Skip to main content
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 following metrics may appear in the response, depending on your plan:
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
curl https://api.truthlocks.com/v1/billing/usage \
  -H "X-API-Key: tl_live_..."

[
  {
    "metric": "attestations.mint",
    "used": 45,
    "limit": 500,
    "period": "monthly",
    "unit": "count"
  },
  {
    "metric": "verifications_monthly",
    "used": 1200,
    "limit": -1,
    "period": "monthly",
    "unit": "count"
  },
  {
    "metric": "storage_bytes",
    "used": 52428800,
    "limit": 1073741824,
    "period": "total",
    "unit": "bytes"
  }
]
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 each metric as a progress bar against your plan limit, and calculates a projected monthly cost based on your current consumption and effective per-unit rates.