Other
How much of the allowance this billing period has been used
GET
https://backend.immut.io/api/v1/billing/usageRequired scope: billing:read
Use it before a large sweep so an agent can stop short of the limit rather than discovering it as a failed upload halfway through. Requires the billing:read scope, which is NOT granted to agent keys by default. This is read-only: nothing in the API changes a plan, buys seats or touches a payment method, and those stay in the app.
Responses
| Status | Meaning |
|---|---|
200 | Success Returns: periodStart, periodEnd, and uploads {used, limit, remaining, quotaKind, byChannel}. byChannel is counted from the documents themselves over the same window, so it is real provenance rather than a running tally. A null periodStart means the plan has no billing window. |
400 | BadRequest |
401 | Unauthorized |
403 | Forbidden |
429 | RateLimited |
Example
curl -X GET "https://backend.immut.io/api/v1/billing/usage" \
-H "Authorization: Bearer $IMMUT_API_KEY"
Generated from the immut API contract, version 1.11.0. Machine-readable: this page as markdown · everything in one file · OpenAPI