Retrieve Limit Usage

Use this endpoint to retrieve the current usage snapshot for a spending limit.

GET /v1/limits/{id}/usage

Retrieve Limit Usage

cURL

curl --request GET \
  --url https://tracer.lerian.io/v1/limits/{id}/usage \
  --header 'Content-Type: <content-type>' \
  --header 'X-API-Key: <api-key>'

200

{
  "limitId": "019c96a0-0c0d-7915-84b9-e497bfee9916",
  "limitAmount": "50000.00",
  "currentUsage": "15000.00",
  "utilizationPercent": 30,
  "nearLimit": false,
  "resetAt": "2026-01-31T00:00:00Z"
}

Authorizations

ApiKeyAuthBearerAuth

X-API-Key · string · header · required

API Key authentication. Used by single-tenant deployments (MULTI_TENANT_ENABLED=false). Sent on every /v1/* request.

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

id · string<uuid> · required

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

Response

200

application/json

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 · string

Total limit amount as a decimal string (e.g., "50000.00").

currentUsage · string

Current usage amount as a decimal string (sum of all transactions in period). Returns "0" for PER_TRANSACTION limits, which do not track persistent usage.

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.