Get Quota V1

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…

GET /api/v1/quota

cURL

curl --request GET \
  --url 'https://api.computer.stateset.app/api/v1/quota' \
  --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY"

200

{
  "plan_name": "string",
  "period_tasks_used": 1,
  "task_quota": 1,
  "remaining": 1,
  "is_exhausted": true,
  "billing_period_start": "string",
  "billing_period_end": "string"
}

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

plan_name · string,null

Subscription plan label, or None if no subscription is on file.

period_tasks_used · integer · required

task_quota · integer · required

remaining · integer · required

Convenience: max(quota - used, 0).

is_exhausted · boolean · required

True iff remaining == 0. Tenants can branch on this without arithmetic.

billing_period_start · string,null

billing_period_end · string,null

Status codes

Code	Meaning
200	Successful Response

cURL

curl --request GET \
  --url 'https://api.computer.stateset.app/api/v1/quota' \
  --header "X-API-Key: $STATESET_COMPUTER_USE_API_KEY"

200

{
  "plan_name": "string",
  "period_tasks_used": 1,
  "task_quota": 1,
  "remaining": 1,
  "is_exhausted": true,
  "billing_period_start": "string",
  "billing_period_end": "string"
}