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

# List the agent cost catalog

> What the workspace's AI usage is priced against: the global registry row in force right now for each (provider, model) merged with the workspace's own negotiated override, then the workspace's custom cost items (`source: "custom"`, `custom_item_id` set), then the (provider, model) pairs this workspace's telemetry has carried that nothing prices (`source: "unlisted"`). An unlisted row is unpriced — its rates are zero because there is no catalog entry, never because the vendor is free — so never render it as $0; price it by creating a custom cost item for the same pair and traffic from then on is priced. Token rates are USD per million tokens, `dimensions` holds the extra cost dimensions, and every rate is a decimal string. Each row also carries whether the model is in the workspace's catalog (`enabled`) and why (`enablement_source`): `seen` when the workspace has actually called it, `manual` when somebody answered for it explicitly, `default_off` for a registry model never touched. Pass `enabled_only=true` for just the catalog; the default is the whole registry.



## OpenAPI

````yaml get /v1/ai/billing/cost-catalog
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/ai/billing/cost-catalog:
    get:
      tags:
        - AI > Billing
      summary: List the agent cost catalog
      description: >-
        What the workspace's AI usage is priced against: the global registry row
        in force right now for each (provider, model) merged with the
        workspace's own negotiated override, then the workspace's custom cost
        items (`source: "custom"`, `custom_item_id` set), then the (provider,
        model) pairs this workspace's telemetry has carried that nothing prices
        (`source: "unlisted"`). An unlisted row is unpriced — its rates are zero
        because there is no catalog entry, never because the vendor is free — so
        never render it as $0; price it by creating a custom cost item for the
        same pair and traffic from then on is priced. Token rates are USD per
        million tokens, `dimensions` holds the extra cost dimensions, and every
        rate is a decimal string. Each row also carries whether the model is in
        the workspace's catalog (`enabled`) and why (`enablement_source`):
        `seen` when the workspace has actually called it, `manual` when somebody
        answered for it explicitly, `default_off` for a registry model never
        touched. Pass `enabled_only=true` for just the catalog; the default is
        the whole registry.
      operationId: listAgentCostCatalog
      parameters:
        - schema:
            anyOf:
              - type: boolean
              - type: string
                enum:
                  - 'true'
                  - 'false'
            default: false
          required: false
          name: enabled_only
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        provider:
                          type: string
                          description: >-
                            AI model provider, or the vendor of a custom cost
                            item. This is not an integration connection.
                          example: anthropic
                        model:
                          type: string
                          description: >-
                            Model identifier, or custom item identifier. Null on
                            wildcard pricing rows.
                          example: claude-sonnet-5
                        aliases:
                          type: array
                          items:
                            type: string
                          description: >-
                            Alternative model names recognized by the cost
                            catalog.
                          example:
                            - claude-sonnet-5-latest
                        input_per_m_tokens:
                          type: string
                          pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
                          description: >-
                            Provider cost in USD per million input tokens, as an
                            exact decimal string.
                          example: '3'
                        output_per_m_tokens:
                          type: string
                          pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
                          description: >-
                            Provider cost in USD per million output tokens, as
                            an exact decimal string.
                          example: '15'
                        cached_input_per_m_tokens:
                          type: string
                          pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
                          description: >-
                            Provider cost in USD per million cached input
                            tokens, as an exact decimal string.
                          example: '0.3'
                        cache_write_per_m_tokens:
                          type: string
                          pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
                          description: >-
                            Provider cost in USD per million cache write tokens,
                            as an exact decimal string.
                          example: '3.75'
                        dimensions:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                                description: >-
                                  Dimension or allowance identifier used by
                                  usage payloads and meter results.
                                example: cached_input_tokens
                              rate:
                                type: string
                                description: >-
                                  Applied rate. Receipt lines may contain a
                                  human-readable rate expression.
                                example: '3'
                              per:
                                type: string
                                enum:
                                  - 1m
                                  - 1k
                                  - unit
                                description: |-
                                  Quantity basis for the dimension rate.

                                  - 1m: Per million units.
                                  - 1k: Per thousand units.
                                  - unit: Per single unit.
                                example: 1m
                            required:
                              - key
                              - rate
                              - per
                          description: >-
                            Additional billable dimensions; each key matches a
                            usage_extra key and rates use the owning card's
                            units or USD for cost-catalog dimensions.
                          example:
                            - key: cached_input_tokens
                              rate: '0.3'
                              per: 1m
                        effective_from:
                          type: string
                          format: date-time
                          description: >-
                            Time the price takes effect, as a UTC ISO 8601
                            timestamp.
                          example: '2026-09-01T00:00:00Z'
                        source:
                          type: string
                          enum:
                            - official
                            - override
                            - custom
                            - unlisted
                          description: |-
                            Source of the model or item cost.

                            - official: Official model price registry.
                            - override: Negotiated workspace cost override.
                            - custom: Workspace-defined cost item.
                            - unlisted: Observed usage without catalog pricing.
                          example: official
                        custom_item_id:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Custom cost-item identifier used to delete the item;
                            null for registry models.
                          example: null
                        override:
                          type:
                            - object
                            - 'null'
                          properties:
                            id:
                              type: string
                              description: Unique Hyperline identifier for this resource.
                              example: d18603dd-7285-4bf5-a45e-88d7de8f37c9
                            input_per_m_tokens:
                              type: string
                              pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
                              description: >-
                                Provider cost in USD per million input tokens,
                                as an exact decimal string.
                              example: '3'
                            output_per_m_tokens:
                              type: string
                              pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
                              description: >-
                                Provider cost in USD per million output tokens,
                                as an exact decimal string.
                              example: '15'
                            cached_input_per_m_tokens:
                              type:
                                - string
                                - 'null'
                              pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
                              description: >-
                                Provider cost in USD per million cached input
                                tokens, as an exact decimal string.
                              example: '0.3'
                            cache_write_per_m_tokens:
                              type:
                                - string
                                - 'null'
                              pattern: ^-?\d+(\.\d+)?(e[+-]?\d+)?$/i
                              description: >-
                                Provider cost in USD per million cache write
                                tokens, as an exact decimal string.
                              example: '3.75'
                            dimensions:
                              type: array
                              items:
                                type: object
                                properties:
                                  key:
                                    type: string
                                    description: >-
                                      Dimension or allowance identifier used by
                                      usage payloads and meter results.
                                    example: cached_input_tokens
                                  rate:
                                    type: string
                                    description: >-
                                      Applied rate. Receipt lines may contain a
                                      human-readable rate expression.
                                    example: '3'
                                  per:
                                    type: string
                                    enum:
                                      - 1m
                                      - 1k
                                      - unit
                                    description: |-
                                      Quantity basis for the dimension rate.

                                      - 1m: Per million units.
                                      - 1k: Per thousand units.
                                      - unit: Per single unit.
                                    example: 1m
                                required:
                                  - key
                                  - rate
                                  - per
                              description: >-
                                Additional billable dimensions; each key matches
                                a usage_extra key and rates use the owning
                                card's units or USD for cost-catalog dimensions.
                              example:
                                - key: cached_input_tokens
                                  rate: '0.3'
                                  per: 1m
                            effective_from:
                              type: string
                              format: date-time
                              description: >-
                                Time the price takes effect, as a UTC ISO 8601
                                timestamp.
                              example: '2026-09-01T00:00:00Z'
                          required:
                            - id
                            - input_per_m_tokens
                            - output_per_m_tokens
                            - cached_input_per_m_tokens
                            - cache_write_per_m_tokens
                            - effective_from
                          description: >-
                            Negotiated workspace cost override, or null when
                            using registry rates.
                          example: null
                        enabled:
                          type: boolean
                          description: >-
                            Whether this model is enabled in the workspace
                            catalog.
                          example: true
                        enablement_source:
                          type: string
                          enum:
                            - seen
                            - manual
                            - default_off
                          description: >-
                            Reason for the model enablement state.


                            - seen: Enabled because usage was observed.

                            - manual: Explicitly configured in the workspace.

                            - default_off: Not configured or observed; disabled
                            by default.
                          example: seen
                      required:
                        - provider
                        - model
                        - aliases
                        - input_per_m_tokens
                        - output_per_m_tokens
                        - cached_input_per_m_tokens
                        - cache_write_per_m_tokens
                        - dimensions
                        - effective_from
                        - source
                        - custom_item_id
                        - override
                        - enabled
                        - enablement_source
                required:
                  - data
        '400':
          description: Invalid request.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
        '409':
          description: The request conflicts with the current configuration.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                required:
                  - message
      security:
        - bearer: []
components:
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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