Skip to content
GET/api/v1/account/tier

Get current API tier and limits

Returns the subscription tier and limits for the authenticated API key. Used by the official Bellator SI Dashboard for dynamic feature gating. Fully stateless and lightweight.

Request example

json
json
{
  "tasks": [
    {
      "id": "T1",
      "duration_days": 5
    }
  ]
}

Response example

json
json
{
  "score": 92,
  "grade": "A"
}

Response fields from OpenAPI contract

This table is generated from the endpoint response schema in openapi.json.

FieldTypeRequiredDescription
tierstringRequiredLowercase tier identifier: demo | free | starter | professional | enterprise | government
display_namestringRequiredHuman-readable tier display name.
limitsobjectRequiredNumeric limits for the authenticated tier. Attributes: sync_task_limit: Maximum tasks per synchronous request. Always 1,000. max_task_limit: Maximum tasks per request across sync + async combined. payload_limit_mb: Maximum request payload size in megabytes. api_calls_per_month: Monthly API call quota. Null for unlimited tiers. monthly_calls_remaining: Remaining calls this month from Redis. Null if Redis unavailable or tier is unlimited.
limits.sync_task_limitintegerRequiredMaximum tasks per synchronous request. Always 1,000 for all tiers.
limits.max_task_limitintegerRequiredMaximum tasks per request across sync + async combined. Tier-dependent.
limits.payload_limit_mbintegerRequiredMaximum request payload size in MB.
limits.api_calls_per_monthinteger | nullOptionalMonthly API call quota. Null for unlimited tiers (Enterprise, Government).
limits.monthly_calls_remaininginteger | nullOptionalRemaining calls this billing month. Null if Redis unavailable or tier is unlimited.
capabilitiesobjectRequiredBoolean feature flags for dashboard gating. The 'async' and 'import' JSON keys are Python reserved words. They are declared as 'async_jobs' and 'import_api' with serialization_alias set so the JSON output uses the correct names ('async' and 'import'). Construct from Python using async_jobs=True and import_api=True. Attributes: tier1: Access to Tier 1 APIs: Health Score, CPM, Validation. forensics: Access to Tier 2 forensics endpoints. import_api: Access to Import APIs (MPP, XER). JSON key: "import". risk: Access to Tier 3 Risk & Simulation APIs (v0.3.0+). async_jobs: Async job submission available (Starter+). JSON key: "async". webhooks: Webhook callback registration supported. sandbox_fixture_requests: Sandbox fixture system available.
capabilities.tier1booleanRequiredAccess to Tier 1 APIs: Health, CPM, Validation.
capabilities.forensicsbooleanRequiredAccess to Tier 2 forensics: Logic Audit, Progress Audit, DCMA 14-Point, DCMA DECM, Resource Analysis.
capabilities.importbooleanRequiredAccess to Import APIs: MPP and XER file parsing.
capabilities.riskbooleanRequiredAccess to Tier 3 Risk & Simulation APIs (v0.3.0+).
capabilities.asyncbooleanRequiredAsync job submission available. True for Starter and above.
capabilities.webhooksbooleanRequiredWebhook callback registration supported. Same tier gate as async.
capabilities.sandbox_fixture_requestsbooleanRequiredSandbox fixture request system available. False for Demo tier only.
recommended_routesobjectRequiredAccessible API route templates filtered to this tier's capabilities.
metadataobjectRequiredAudit context for the tier resolution. Attributes: resolved_at: UTC ISO 8601 timestamp when the tier was resolved. api_version: API version that produced this response.
metadata.resolved_atstringRequiredUTC ISO 8601 timestamp of tier resolution.
metadata.api_versionstringRequiredAPI version that produced this response.

Schema

json-schema
{
  "$ref": "#/components/schemas/AccountTierResponse"
}

Authentication

  • x-api-key header

Reference details

Operation ID
get_account_tier_api_v1_account_tier_get
Section
Account
Tags
Account

Was this page helpful?

Your feedback helps us improve docs, reference pages, and Playground flows.

Topic: Get current API tier and limits · Page: /docs/api-reference/get_account_tier_api_v1_account_tier_get

TermsPrivacyContact

Schedule analysis guidance. Not legal advice. You remain responsible for contract and agency compliance.