Skip to main content
GET
Confirm your deployment before running this request. This page describes an API contract; a published reference does not establish hosted availability. Check the dated host report and obtain your deployment URL and credentials. Replace the example host if your provisioned service uses a different URL.
Pre-flight quota check. Cheaper than /usage when all you need to know is ‘can I send another batch right now?’ — skips the lifetime aggregation across UsageRecord and the by-status job count.

Response

QuotaResponse
string,null
Subscription plan label, or None if no subscription is on file.
integer
required
integer
required
integer
required
Convenience: max(quota - used, 0).
boolean
required
True iff remaining == 0. Tenants can branch on this without arithmetic.
string,null
string,null

Status codes

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.
Last modified on September 21, 2026