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

# Workspace Checkout



## OpenAPI

````yaml /api/openapi.json post /api/entities/{entity_id}/usage-account/checkout
openapi: 3.1.0
info:
  title: CrowdListen Agent API
  description: >-
    Configure sources, collect and retain originals, run durable analysis, and
    read or revise cited insights. Humans and agents share authorized
    entity/project records, research jobs and evidence history.
  version: 1.0.0
servers:
  - url: https://agent.crowdlisten.com
    description: Production
  - url: http://localhost:8000
    description: Local development
security: []
paths:
  /api/entities/{entity_id}/usage-account/checkout:
    post:
      tags:
        - AWB integration
      summary: Workspace Checkout
      operationId: workspace_checkout_api_entities__entity_id__usage_account_checkout_post
      parameters:
        - name: entity_id
          in: path
          required: true
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Entity Id
        - name: workspace_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: uuid
              - type: 'null'
            title: Workspace Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceCheckoutRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    WorkspaceCheckoutRequest:
      properties:
        amount_cents:
          anyOf:
            - type: integer
              maximum: 100000
              minimum: 100
            - type: 'null'
          title: Amount Cents
        pack_id:
          anyOf:
            - type: string
              enum:
                - starter
                - regular
                - volume
                - topup-5
                - topup-10
                - topup-25
                - topup-50
            - type: 'null'
          title: Pack Id
        policy_version:
          type: string
          maxLength: 100
          minLength: 1
          title: Policy Version
        request_id:
          type: string
          format: uuid
          title: Request Id
      type: object
      required:
        - policy_version
        - request_id
      title: WorkspaceCheckoutRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.