Skip to main content
GET
/
v1
/
limits
/
{limit_id}
/
usage
Retrieve Limit Usage
curl --request GET \
  --url https://tracer.lerian.io/v1/limits/{limit_id}/usage \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <x-api-key>'
{
  "limitId": "ff1e8400-e29b-41d4-a716-446655440050",
  "limitAmount": 5000000,
  "currentUsage": 1500000,
  "utilizationPercent": 30,
  "nearLimit": false,
  "resetAt": "2026-01-31T00:00:00Z"
}

Headers

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
X-API-Key
string
required

The API Key for authentication. This header is required for all endpoints except health checks.

​
X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Path Parameters

​
limit_id
string<uuid>
required

The unique identifier of the limit that you want to retrieve, update or delete.

Response

Indicates that the request was successful and the response contains the expected data.

Current usage snapshot for a limit.

​
limitId
string<uuid>

The limit identifier.

​
limitAmount
integer

Total limit amount in cents.

​
currentUsage
integer

Current usage amount in cents (sum of all transactions in period). Null for PER_TRANSACTION limits.

​
utilizationPercent
number<float>

Usage percentage (currentUsage / limitAmount * 100).

​
nearLimit
boolean

True if usage exceeds 80% of limit.

​
resetAt
string<date-time> | null

When counter resets. Null for PER_TRANSACTION limits.