> ## Documentation Index
> Fetch the complete documentation index at: https://docs.firedrill.run/llms.txt
> Use this file to discover all available pages before exploring further.

# Read the organization's billing account, subscription, and available catalog



## OpenAPI

````yaml /api-reference/openapi.json get /v1/organization/billing
openapi: 3.1.0
info:
  title: Firedrill Control API
  version: 1.0.0
  description: >-
    The control plane for drills, drill runs, and the worlds they run in. Errors
    always carry the canonical envelope; unsafe operations require an
    Idempotency-Key; long work returns an operation resource.
servers:
  - url: https://api.firedrill.run
security:
  - controlCredential: []
tags:
  - name: authentication
    description: Sessions, CLI exchange, credentials, and verification keys.
    x-group: Authentication
  - name: organizations
    description: Organization members, billing, usage, retention, audit, and exports.
    x-group: Organizations
  - name: projects
    description: Project lifecycle, access, grants, and repository bindings.
    x-group: Projects
  - name: builds
    description: Immutable builds, uploads, source drafts, and world definitions.
    x-group: Builds and source
  - name: tools
    description: Project Tool discovery, approval, source, and revocation.
    x-group: Tool library
  - name: worlds
    description: >-
      Managed environments, world sessions, state, time, reset, faults, forks,
      and snapshots.
    x-group: Environments and sessions
  - name: runs
    description: >-
      Hosted runs, comparisons, attachments, reports, evidence bundles, sharing,
      and exports.
    x-group: Runs and evidence
  - name: browser
    description: Managed browser tests, runs, messages, streams, frames, and artifacts.
    x-group: Browser testing
  - name: callbacks
    description: Callback receiver approval, revocation, and signing material.
    x-group: Callbacks
  - name: github-ci
    description: >-
      GitHub installations, repository automation, CI suites, cases, evidence,
      and checks.
    x-group: GitHub and CI
  - name: authoring
    description: Authoring sessions, proposals, turns, and scenario proposals.
    x-group: Cloud authoring
paths:
  /v1/organization/billing:
    get:
      tags:
        - organizations
      summary: >-
        Read the organization's billing account, subscription, and available
        catalog
      operationId: billing.getOrganization
      responses:
        '200':
          description: Organization billing overview
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingOverview'
        default:
          description: Canonical error envelope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    BillingOverview:
      type: object
      properties:
        schemaVersion:
          type: number
          enum:
            - 1
        organizationId:
          type: string
          pattern: ^org_[0-9a-z]{12,32}$
        billingAccountId:
          type: string
          pattern: ^billacct_[0-9a-z]{12,32}$
        state:
          type: string
          enum:
            - unconfigured
            - active
            - attention
            - canceled
        entitlement:
          type: object
          properties:
            schemaVersion:
              type: number
              enum:
                - 1
            entitlementId:
              type: string
              pattern: ^entitlement_[0-9a-z]{12,32}$
            organizationId:
              type: string
              pattern: ^org_[0-9a-z]{12,32}$
            plan:
              type: string
              minLength: 1
              maxLength: 80
            limits:
              type: object
              properties:
                maxConcurrentSessions:
                  type: integer
                  minimum: 0
                  maximum: 100000
                maxConcurrentRuns:
                  type: integer
                  minimum: 0
                  maximum: 100000
                maxSessionTtlMs:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
                  maximum: 604800000
                maxDrillTimeoutMs:
                  type: integer
                  minimum: 1000
                  maximum: 86400000
                maxEvidenceRetentionMs:
                  type: integer
                  minimum: 0
                  exclusiveMinimum: true
                  maximum: 31536000000
                usage:
                  type: object
                  properties:
                    sessionMs:
                      type: string
                      pattern: ^(0|[1-9][0-9]{0,37})$
                    warmLeaseMs:
                      type: string
                      pattern: ^(0|[1-9][0-9]{0,37})$
                    storageByteMs:
                      type: string
                      pattern: ^(0|[1-9][0-9]{0,37})$
                    transferBytes:
                      type: string
                      pattern: ^(0|[1-9][0-9]{0,37})$
                    drillMs:
                      type: string
                      pattern: ^(0|[1-9][0-9]{0,37})$
                  additionalProperties: false
              required:
                - maxConcurrentSessions
                - maxConcurrentRuns
                - maxSessionTtlMs
                - maxDrillTimeoutMs
                - maxEvidenceRetentionMs
              additionalProperties: false
            effectiveAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            expiresAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - schemaVersion
            - entitlementId
            - organizationId
            - plan
            - limits
            - effectiveAtMs
          additionalProperties: false
        subscription:
          type: object
          properties:
            schemaVersion:
              type: number
              enum:
                - 1
            billingSubscriptionId:
              type: string
              pattern: ^billsub_[0-9a-z]{12,32}$
            billingAccountId:
              type: string
              pattern: ^billacct_[0-9a-z]{12,32}$
            organizationId:
              type: string
              pattern: ^org_[0-9a-z]{12,32}$
            planId:
              type: string
              minLength: 1
              maxLength: 40
              pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$
            interval:
              type: string
              enum:
                - monthly
                - yearly
            state:
              type: string
              enum:
                - trialing
                - active
                - past_due
                - paused
                - incomplete
                - unpaid
                - canceled
            currentPeriodStartAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            currentPeriodEndAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            cancelAtPeriodEnd:
              type: boolean
            graceEndsAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
            observedAtMs:
              type: integer
              minimum: -9007199254740991
              maximum: 9007199254740991
          required:
            - schemaVersion
            - billingSubscriptionId
            - billingAccountId
            - organizationId
            - planId
            - interval
            - state
            - currentPeriodStartAtMs
            - currentPeriodEndAtMs
            - cancelAtPeriodEnd
            - observedAtMs
          additionalProperties: false
        catalog:
          maxItems: 100
          type: array
          items:
            type: object
            properties:
              planId:
                type: string
                minLength: 1
                maxLength: 40
                pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$
              displayName:
                type: string
                minLength: 1
                maxLength: 80
              summary:
                type: string
                minLength: 1
                maxLength: 240
              limits:
                type: object
                properties:
                  maxConcurrentSessions:
                    type: integer
                    minimum: 0
                    maximum: 100000
                  maxConcurrentRuns:
                    type: integer
                    minimum: 0
                    maximum: 100000
                  maxSessionTtlMs:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 604800000
                  maxDrillTimeoutMs:
                    type: integer
                    minimum: 1000
                    maximum: 86400000
                  maxEvidenceRetentionMs:
                    type: integer
                    minimum: 0
                    exclusiveMinimum: true
                    maximum: 31536000000
                  usage:
                    type: object
                    properties:
                      sessionMs:
                        type: string
                        pattern: ^(0|[1-9][0-9]{0,37})$
                      warmLeaseMs:
                        type: string
                        pattern: ^(0|[1-9][0-9]{0,37})$
                      storageByteMs:
                        type: string
                        pattern: ^(0|[1-9][0-9]{0,37})$
                      transferBytes:
                        type: string
                        pattern: ^(0|[1-9][0-9]{0,37})$
                      drillMs:
                        type: string
                        pattern: ^(0|[1-9][0-9]{0,37})$
                    additionalProperties: false
                required:
                  - maxConcurrentSessions
                  - maxConcurrentRuns
                  - maxSessionTtlMs
                  - maxDrillTimeoutMs
                  - maxEvidenceRetentionMs
                additionalProperties: false
              prices:
                maxItems: 2
                type: array
                items:
                  type: object
                  properties:
                    interval:
                      type: string
                      enum:
                        - monthly
                        - yearly
                    currency:
                      type: string
                      pattern: ^[a-z]{3}$
                    unitAmount:
                      type: integer
                      minimum: -9007199254740991
                      maximum: 9007199254740991
                  required:
                    - interval
                    - currency
                    - unitAmount
                  additionalProperties: false
              contactUrl:
                type: string
                format: uri
                pattern: ^https:\/\/.*
            required:
              - planId
              - displayName
              - summary
              - limits
              - prices
            additionalProperties: false
        management:
          type: object
          properties:
            checkoutAvailable:
              type: boolean
            portalAvailable:
              type: boolean
          required:
            - checkoutAvailable
            - portalAvailable
          additionalProperties: false
        generatedAtMs:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
      required:
        - schemaVersion
        - organizationId
        - billingAccountId
        - state
        - entitlement
        - catalog
        - management
        - generatedAtMs
      additionalProperties: false
    ErrorEnvelope:
      type: object
      properties:
        code:
          type: string
          pattern: ^(control|world)\.[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$
        message:
          type: string
          minLength: 1
        correlationId:
          type: string
          minLength: 1
        retryable:
          type: boolean
        retryAfterMs:
          type: integer
          exclusiveMinimum: 0
          maximum: 9007199254740991
        operationId:
          type: string
        source:
          type: string
          enum:
            - platform
            - simulated_provider
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: string
              code:
                type: string
              message:
                type: string
            required:
              - path
              - code
              - message
            additionalProperties: false
        details:
          type: object
          propertyNames:
            type: string
          additionalProperties: {}
        evidence:
          type: object
          properties:
            sessionId:
              type: string
            runId:
              type: string
            journalSeq:
              type: integer
              minimum: 0
              maximum: 9007199254740991
            buildHash:
              type: string
          additionalProperties: false
      required:
        - code
        - message
        - correlationId
        - retryable
        - source
      additionalProperties: true
  securitySchemes:
    controlCredential:
      type: http
      scheme: bearer
      description: Opaque control credential

````