Operations · min plan: starter · lightweight (0.1u) · scope: read:usage · live

Workspace Usage Snapshot

Returns add-on-aware usage, reserved capacity, remaining allowance, percentage consumed, and billing-period forecast for weighted API units, AI credits, event monitoring credits, and AI document processing pages. Poll at most every six hours.

GET /v1/usage

Required scope

read:usage

Weighted API units

0.1 per success

Minimum plan

starter

Rate-limit bucket

lightweight

AI credits

—

Sample request

curl "https://getway.clearie.ai/v1/usage" -H "Authorization: Bearer $CLEARIE_API_KEY"

Sample response

{
  "recommended_poll_interval_hours": 6,
  "subscription_status": "active",
  "meters": {
    "api_units": {
      "used": 1200,
      "effective_limit": 50000,
      "percentage": 2.4
    },
    "ai_credits": {
      "used": 40,
      "effective_limit": 500,
      "percentage": 8
    },
    "monitoring_credits": {
      "used": 18,
      "effective_limit": 120,
      "percentage": 15
    },
    "document_pages": {
      "used": 20,
      "effective_limit": 250,
      "percentage": 8
    }
  }
}

Live response contract

Live calls require API-key authentication, read:usage scope, plan access, and available quota. Successful calls consume 0.1 weighted API units; failed responses release reservations. AI credits are waived when no chargeable AI output is delivered.

Sandbox sample response

Workspace try-it calls use isolated representative sandbox records. They are for integration validation, not production filing.

Error examples

401 invalid key · 403 missing scope or plan · 429 quota/rate limit · 404 no verified data where applicable.

Response schema

root object {

recommended_poll_interval_hours* integer// e.g. 6

subscription_status* string// e.g. "active"

meters* object {

api_units* object {

used* integer// e.g. 1200

effective_limit* integer// e.g. 50000

percentage* number// e.g. 2.4

}

ai_credits* object {

used* integer// e.g. 40

effective_limit* integer// e.g. 500

percentage* integer// e.g. 8

}

monitoring_credits* object {

used* integer// e.g. 18

effective_limit* integer// e.g. 120

percentage* integer// e.g. 15

}

document_pages* object {

used* integer// e.g. 20

effective_limit* integer// e.g. 250

percentage* integer// e.g. 8

}

Try this API live in the workspace

The in-app try-it console runs against the isolated deterministic sandbox repository. It never reads live customer or reference records.

Open in workspace Create account