> ## 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: [] paths: /v1/organization/billing: get: 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 drillsPerPeriod: type: integer minimum: 0 maximum: 1000000 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 discount: type: object properties: promotionCode: type: string minLength: 1 maxLength: 200 pattern: ^[A-Za-z0-9-]+$ providerPromotionCodeRef: type: string minLength: 3 maxLength: 255 providerCouponRef: type: string minLength: 1 maxLength: 255 name: type: string minLength: 1 maxLength: 200 percentOff: type: number minimum: 0 maximum: 100 amountOffCents: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 currency: type: string pattern: ^[a-z]{3}$ duration: type: string enum: - once - repeating - forever durationInMonths: type: integer minimum: 1 maximum: 1200 endsAtMs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - providerCouponRef - duration additionalProperties: false 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 drillsPerPeriod: type: integer minimum: 0 maximum: 1000000 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 perMonthUnitAmount: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - interval - currency - unitAmount additionalProperties: false contactUrl: type: string format: uri pattern: ^https:\/\/.* default: type: boolean enum: - true topupsPurchasable: type: boolean required: - planId - displayName - summary - prices additionalProperties: false topupPacks: maxItems: 20 type: array items: type: object properties: packId: type: string minLength: 1 maxLength: 40 pattern: ^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$ drills: type: integer minimum: 1 maximum: 1000000 currency: type: string pattern: ^[a-z]{3}$ unitAmount: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - packId - drills - currency - unitAmount additionalProperties: false drills: type: object properties: schemaVersion: type: number enum: - 1 organizationId: type: string pattern: ^org_[0-9a-z]{12,32}$ plan: type: string minLength: 1 maxLength: 80 unmetered: type: boolean period: type: object properties: reset: type: string enum: - calendar_month_utc - billing_period startsAtMs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 endsAtMs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - reset - startsAtMs - endsAtMs additionalProperties: false planDrills: nullable: true type: integer minimum: 0 maximum: 9007199254740991 planDrillsUsed: type: integer minimum: 0 maximum: 9007199254740991 planDrillsRemaining: nullable: true type: integer minimum: 0 maximum: 9007199254740991 topupDrillsRemaining: type: integer minimum: 0 maximum: 9007199254740991 drillsAtATime: type: integer minimum: 0 maximum: 9007199254740991 activeDrills: type: integer minimum: 0 maximum: 9007199254740991 generatedAtMs: type: integer minimum: -9007199254740991 maximum: 9007199254740991 required: - schemaVersion - organizationId - plan - unmetered - period - planDrills - planDrillsUsed - planDrillsRemaining - topupDrillsRemaining - drillsAtATime - activeDrills - generatedAtMs additionalProperties: false management: type: object properties: checkoutAvailable: type: boolean portalAvailable: type: boolean topupAvailable: type: boolean topupsConfigured: 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 ````