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

# Get Box limits

> Check quota, access readiness, and active-box capacity for the authenticated account.



## OpenAPI

````yaml openapi/box-v1.yaml GET /limits
openapi: 3.1.0
info:
  title: Box Public API v1
  version: 1.0.0
  description: >
    Public JSON API for creating, operating, prompting, observing, and exposing
    Box sandboxes from backend services, CI jobs, hosted workers, and Box
    automation products.


    The v1 reference intentionally documents the developer integration surface
    only. Dashboard billing actions are not part of v1.
servers:
  - url: https://ascii.dev/api/box/v1
security:
  - BoxBearerAuth: []
tags:
  - name: Box
    description: >-
      Unified Box account, setup, lifecycle, prompting, event history, desktop
      access, and SSH operations.
paths:
  /limits:
    get:
      tags:
        - Box
      summary: Get Box limits
      description: >-
        Check quota, access readiness, and active-box capacity for the
        authenticated account.
      operationId: limits
      responses:
        '200':
          description: Current creation and active-box limits.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitsResponse'
              examples:
                ready:
                  value:
                    ok: true
                    type: limits.info
                    canStart: true
                    activeBoxes: 1
                    activeStates:
                      - provisioned
                      - cloning
                      - ready
                      - idle
                      - running
                    boxPlanKey: box_20
                    boxPlanDollars: 20
                    maxActiveBoxes: 100
                    maxCreationRequestsPerMinute: 10
                    maxCreationRequestsPerDay: null
                    billingStatus: active
                    creditBalanceSeconds: 7200
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    LimitsResponse:
      allOf:
        - $ref: '#/components/schemas/SuccessBase'
        - $ref: '#/components/schemas/LimitsFields'
    SuccessBase:
      type: object
      required:
        - ok
        - type
      properties:
        ok:
          type: boolean
          examples:
            - true
        type:
          type: string
          description: Stable success envelope discriminator added by v1.
    LimitsFields:
      type: object
      required:
        - activeBoxes
        - maxActiveBoxes
        - canStart
        - billingStatus
      additionalProperties: true
      properties:
        accessTier:
          type: string
          examples:
            - trial
        blockedReason:
          type:
            - string
            - 'null'
        currentLimits:
          type: object
          additionalProperties: true
          properties:
            activeBoxes:
              type: integer
            creationRatePerMinute:
              type: integer
            creationRequestsPerDay:
              type:
                - integer
                - 'null'
        standardLimits:
          type: object
          additionalProperties: true
          properties:
            activeBoxes:
              type: integer
            creationRatePerMinute:
              type: integer
            creationRequestsPerDay:
              type:
                - integer
                - 'null'
        trialLimits:
          type: object
          additionalProperties: true
          properties:
            activeBoxes:
              type: integer
            creationRatePerMinute:
              type: integer
            creationRequestsPerDay:
              type:
                - integer
                - 'null'
        upgradeEffects:
          type: object
          additionalProperties: true
        canStart:
          type: boolean
          description: >-
            Whether the authenticated account can create or operate boxes right
            now.
        checkoutRequired:
          type: boolean
        startBlockedReason:
          type:
            - string
            - 'null'
        contactMessage:
          type:
            - string
            - 'null'
        activeBoxes:
          type: integer
        activeStates:
          type: array
          items:
            type: string
        maxActiveBoxes:
          type: integer
        maxCreationRequestsPerMinute:
          type: integer
        maxCreationRequestsPerDay:
          type:
            - integer
            - 'null'
        hasPaymentHistory:
          type: boolean
        package:
          type: object
          additionalProperties: true
        subscriptionQuotaSeconds:
          type: integer
        subscriptionRemainingSeconds:
          type: integer
        packBalanceSeconds:
          type: integer
        creditPurchasedSeconds:
          type: integer
        creditUsedSeconds:
          type: integer
        liveUsageSeconds:
          type: integer
        creditSecondsPerDollar:
          type: integer
        billingStatus:
          type: string
          description: >-
            Account access state returned by the current backend. Billing
            endpoints are not part of v1.
        subscriptionStatus:
          type:
            - string
            - 'null'
        subscriptionCancelAtPeriodEnd:
          type: boolean
        hasSubscription:
          type: boolean
        subscriptionTrialEndsAt:
          type:
            - string
            - 'null'
          format: date-time
        subscriptionCurrentPeriodEnd:
          type:
            - string
            - 'null'
          format: date-time
        creditBalanceSeconds:
          type: integer
    ErrorEnvelope:
      type: object
      required:
        - ok
        - type
        - status
        - code
        - message
        - error
        - requestId
      properties:
        ok:
          type: boolean
          examples:
            - false
        type:
          type: string
          examples:
            - box.error
        status:
          type: integer
          examples:
            - 409
        code:
          type: string
          examples:
            - provider_not_configured
        message:
          type: string
          examples:
            - Prompting is locked until Codex is configured on the Agents page.
        requestId:
          type: string
          examples:
            - req_01HX...
        error:
          type: object
          required:
            - code
            - message
            - status
          properties:
            code:
              type: string
            message:
              type: string
            status:
              type: integer
            details:
              type: object
              additionalProperties: true
  responses:
    Unauthorized:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
          examples:
            unauthorized:
              value:
                ok: false
                type: box.error
                status: 401
                code: unauthorized
                message: Unauthorized
                error:
                  code: unauthorized
                  message: Unauthorized
                  status: 401
                requestId: req_01HX...
  securitySchemes:
    BoxBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: box_api_key
      description: >-
        Box bearer token in the form `box_...`. Service API keys authenticate
        Box operations.

````