> ## Documentation Index > Fetch the complete documentation index at: https://checkfu.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get workspace billing status > Returns the workspace's billing snapshot: rollout, catalog, the organization commercial state, provisioning state, model access (the active ModelRoutingProfile, whether it resolves a workspace BYOK override or platform supply, and platform-supply availability), builder seat counts, usage-projection delivery states, and exact local charge totals. `recovery_actions` names the concrete steps that would clear the current condition. A rejected BYOK override never silently falls back to platform supply. Checkfu support posture: preview; rollout_fenced. Required evidence journey: platform-supply-billing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. ## OpenAPI ````yaml /openapi.json get /v1/billing/status openapi: 3.1.0 info: title: Checkfu API version: '2026-08-29' description: >- Authentication is declared per operation: API-key, runtime, or connector bearer; Automation signature; or credential-free pairing redemption. Every general Checkfu REST request requires the dated `Checkfu-Version` header (one of: 2026-08-29); the three MCP JSON-RPC transports use `MCP-Protocol-Version`, A2A uses `A2A-Version`, and the provider OAuth callback carries neither Checkfu header. API keys resolve one Workspace without a request selector; authenticated responses identify it with `Checkfu-Workspace-Id`. servers: - url: https://api.checkfu.com security: - bearerAuth: [] tags: - name: organizations - name: sourceRepositories - name: tenants - name: workspaces - name: principals - name: principalGroups - name: principalAccessCredentials - name: apiKeys - name: agents - name: harnesses - name: harnessRuntime - name: computerProfiles - name: permissionAssignments - name: actionPolicies - name: files - name: memoryStores - name: dreams - name: modelCredentials - name: modelRoutingProfiles - name: blueprintInstallations - name: toolSources - name: skills - name: skillSources - name: agentSources - name: skillProposals - name: instructionProposals - name: catalog - name: concepts - name: support - name: connections - name: connectionVaults - name: connectionAssignments - name: connectedRuntimes - name: projects - name: collaboration - name: automationGraphs - name: automations - name: actionApprovals - name: standingApprovals - name: usage - name: models - name: outcomes - name: budgets - name: billing - name: sessions - name: audit - name: sessionExports - name: runs - name: runnerPools - name: transcripts - name: sessionWatches - name: sessionHandoffs - name: sessionCapsules - name: sessionTrajectories - name: webhookEndpoints - name: integrationGateway - name: agentDeployments - name: workEnvironments - name: computers - name: computerScreens - name: computerBrowserObservations - name: computerBrowserActions - name: environments - name: vaults - name: apiMcp - name: a2a paths: /v1/billing/status: get: tags: - billing summary: Get workspace billing status description: >- Returns the workspace's billing snapshot: rollout, catalog, the organization commercial state, provisioning state, model access (the active ModelRoutingProfile, whether it resolves a workspace BYOK override or platform supply, and platform-supply availability), builder seat counts, usage-projection delivery states, and exact local charge totals. `recovery_actions` names the concrete steps that would clear the current condition. A rejected BYOK override never silently falls back to platform supply. Checkfu support posture: preview; rollout_fenced. Required evidence journey: platform-supply-billing. Deployment-specific readiness and the latest proven release are available from GET /v1/support/capabilities. operationId: billing.getBillingStatus parameters: - name: checkfu-version in: header schema: type: string enum: - '2026-08-29' required: true responses: '200': description: Success content: application/json: schema: type: object properties: organization_id: $ref: '#/components/schemas/OrganizationId' workspace_id: $ref: '#/components/schemas/WorkspaceId' rollout: type: object properties: catalog_visible: type: boolean platform_supply_eligible: type: boolean usage_projection_enabled: type: boolean charging_enabled: type: boolean required: - catalog_visible - platform_supply_eligible - usage_projection_enabled - charging_enabled additionalProperties: false catalog: anyOf: - type: object properties: kind: type: string enum: - hidden required: - kind additionalProperties: false - type: object properties: kind: type: string enum: - visible version: type: string allOf: - minLength: 1 - maxLength: 255 display_credit_microusd: type: integer allOf: - minimum: 0 explore: type: object properties: monthly_base_microusd: type: integer allOf: - minimum: 0 included_builder_seats: type: integer allOf: - minimum: 0 included_credit_microusd: type: integer allOf: - minimum: 0 required: - monthly_base_microusd - included_builder_seats - included_credit_microusd additionalProperties: false team: type: object properties: monthly_base_microusd: type: integer allOf: - minimum: 0 included_builder_seats: type: integer allOf: - minimum: 0 additional_builder_monthly_microusd: type: integer allOf: - minimum: 0 included_credit_microusd: type: integer allOf: - minimum: 0 required: - monthly_base_microusd - included_builder_seats - additional_builder_monthly_microusd - included_credit_microusd additionalProperties: false required: - kind - version - display_credit_microusd - explore - team additionalProperties: false commercial: type: object properties: state: type: string enum: - ready - unavailable - not_provisioned current_plan_id: anyOf: - type: string enum: - explore - team - enterprise - type: 'null' payment_state: type: string enum: - current - past_due - unknown pooled_credit: anyOf: - type: object properties: granted_microusd: type: integer allOf: - minimum: 0 remaining_microusd: type: integer allOf: - minimum: 0 usage_microusd: type: integer allOf: - minimum: 0 required: - granted_microusd - remaining_microusd - usage_microusd additionalProperties: false - type: 'null' required: - state - current_plan_id - payment_state - pooled_credit additionalProperties: false provisioning: type: object properties: local_state: type: string enum: - pending - ready - starter_unavailable external_state: type: string enum: - pending - ready - retryable - disabled last_error_code: anyOf: - type: string allOf: - minLength: 1 - maxLength: 255 - type: 'null' required: - local_state - external_state - last_error_code additionalProperties: false model_access: type: object properties: binding_id: anyOf: - $ref: '#/components/schemas/ModelRoutingProfileId' - type: 'null' source: type: string enum: - workspace_override_configured - workspace_override_rejected - platform_default - unavailable platform_supply_state: type: string enum: - available - capacity_reached - unavailable - disabled - not_used provider: anyOf: - type: string allOf: - pattern: ^[a-z0-9](?:[a-z0-9._-]{0,93})$ - type: 'null' model: anyOf: - type: string allOf: - minLength: 1 - maxLength: 255 - type: 'null' invalid_byok_falls_back: type: boolean enum: - false required: - binding_id - source - platform_supply_state - provider - model - invalid_byok_falls_back additionalProperties: false builder_seats: type: object properties: authoritative_quantity: anyOf: - type: integer allOf: - minimum: 0 - type: 'null' projection_state: anyOf: - type: string enum: - pending - sending - delivered - retryable - conflict_review - type: 'null' remote_quantity: anyOf: - type: integer allOf: - minimum: 0 - type: 'null' source: type: string enum: - organization_membership - membership_source_pending required: - authoritative_quantity - projection_state - remote_quantity - source additionalProperties: false usage_projections: type: array items: type: object properties: state: type: string enum: - pending - sending - delivered - accepted_pending - delivery_unknown - retryable - conflict_review - dead_letter - external_adjustment_required - externally_adjusted count: type: integer allOf: - minimum: 0 required: - state - count additionalProperties: false local_usage: type: object properties: charge_count: type: integer allOf: - minimum: 0 correction_count: type: integer allOf: - minimum: 0 original_charge: $ref: '#/components/schemas/Objects_161' correction_delta: $ref: '#/components/schemas/Objects_161' net_charge: $ref: '#/components/schemas/Objects_161' dimensions: type: object properties: uncached_input_tokens: type: integer allOf: - minimum: 0 cached_input_tokens: type: integer allOf: - minimum: 0 cache_write_input_tokens: type: integer allOf: - minimum: 0 output_tokens: type: integer allOf: - minimum: 0 reasoning_output_tokens: type: integer allOf: - minimum: 0 required: - uncached_input_tokens - cached_input_tokens - cache_write_input_tokens - output_tokens - reasoning_output_tokens additionalProperties: false required: - charge_count - correction_count - original_charge - correction_delta - net_charge - dimensions additionalProperties: false recovery_actions: type: array items: type: string enum: - add_or_repair_byok - retry_provisioning - update_payment_method - wait_for_projection - contact_support required: - organization_id - workspace_id - rollout - catalog - commercial - provisioning - model_access - builder_seats - usage_projections - local_usage - recovery_actions additionalProperties: false headers: checkfu-workspace-id: description: The Workspace resolved from the authenticated bearer credential. required: true schema: $ref: '#/components/schemas/WorkspaceId' '400': description: Typed Checkfu wire error content: application/json: schema: type: object required: - error properties: error: type: object properties: type: type: string enum: - validation.malformed message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#validation-malformed description: >- Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false additionalProperties: false '401': description: Typed Checkfu wire error content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - auth.invalid_key message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-invalid-key description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '403': description: >- The organization, tenant, or workspace backing this key is administratively disabled. | Deployment governance or retention policy denied the request. content: application/json: schema: anyOf: - type: object required: - error properties: error: type: object properties: type: type: string enum: - auth.disabled_tenancy message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#auth-disabled-tenancy description: >- Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false additionalProperties: false - $ref: '#/components/schemas/PolicyDeniedError' '429': description: Typed Checkfu wire error headers: retry-after: description: >- Delay in seconds for rate limits or deployment quotas with a known release or UTC reset boundary required: false schema: type: integer minimum: 1 content: application/json: schema: type: object required: - error properties: error: type: object required: - type - message - more properties: type: type: string enum: - budget.exceeded message: type: string more: type: string enum: - >- https://docs.checkfu.com/reference/errors#budget-exceeded description: >- Stable public documentation and remedy for this error type. additionalProperties: false additionalProperties: false '500': description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. content: application/json: schema: $ref: '#/components/schemas/RuntimeInternalError' security: - bearerAuth: [] components: schemas: OrganizationId: type: string allOf: - pattern: ^org_[0-9a-f]{32}$ WorkspaceId: type: string allOf: - pattern: ^wrkspc_[0-9a-f]{32}$ ModelRoutingProfileId: type: string allOf: - pattern: ^mrp_[0-9a-f]{32}$ Objects_161: type: object properties: microusd: $ref: '#/components/schemas/SafeInteger' remainder_millionths: type: integer allOf: - exclusiveMinimum: -1000000 - exclusiveMaximum: 1000000 required: - microusd - remainder_millionths additionalProperties: false PolicyDeniedError: type: object properties: error: type: object properties: type: type: string enum: - policy.denied message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#policy-denied description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: Deployment governance or retention policy denied the request. RuntimeInternalError: type: object properties: error: type: object properties: type: type: string enum: - runtime.internal message: type: string more: type: string enum: - https://docs.checkfu.com/reference/errors#runtime-internal description: Stable public documentation and remedy for this error type. required: - type - message - more additionalProperties: false required: - error additionalProperties: false description: >- An unexpected internal failure occurred; the message contains an opaque incident reference. SafeInteger: type: integer securitySchemes: bearerAuth: type: http scheme: bearer ````