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

# GET /admin/api/price-rates



## OpenAPI

````yaml /generated/openapi.json get /admin/api/price-rates
openapi: 3.1.0
info:
  description: >-
    Forwarding, management, portal and OAuth APIs generated from Rust types.
    Input and output schemas preserve their respective Serde contracts.
    Streaming events and WebSocket messages are documented alongside HTTP
    payloads.
  title: GPROXY HTTP API
  version: 4.2.1
servers: []
security:
  - bearer: []
  - anthropicKey: []
  - googleKey: []
  - queryKey: []
paths:
  /admin/api/price-rates:
    get:
      tags:
        - Management
      summary: GET /admin/api/price-rates
      parameters:
        - description: ''
          in: query
          name: credentialId
          required: false
          schema:
            type:
              - string
              - 'null'
        - description: ''
          in: query
          name: enabled
          required: false
          schema:
            type:
              - boolean
              - 'null'
        - description: Restrict price rules to the global scope.
          in: query
          name: globalOnly
          required: false
          schema:
            description: Restrict price rules to the global scope.
            type:
              - boolean
              - 'null'
        - description: ''
          in: query
          name: modelId
          required: false
          schema:
            type:
              - string
              - 'null'
        - description: Exact pricing pattern (not a runtime wildcard match).
          in: query
          name: modelPattern
          required: false
          schema:
            description: Exact pricing pattern (not a runtime wildcard match).
            type:
              - string
              - 'null'
        - description: ''
          in: query
          name: ownerId
          required: false
          schema:
            type:
              - string
              - 'null'
        - description: ''
          in: query
          name: ownerKind
          required: false
          schema:
            type:
              - string
              - 'null'
        - description: 1-based. Zero and absent both mean the first page.
          in: query
          name: page
          required: false
          schema:
            description: 1-based. Zero and absent both mean the first page.
            format: uint64
            minimum: 0
            type:
              - integer
              - 'null'
        - description: Clamped to 1..=500; absent means 50.
          in: query
          name: pageSize
          required: false
          schema:
            description: Clamped to 1..=500; absent means 50.
            format: uint64
            minimum: 0
            type:
              - integer
              - 'null'
        - description: ''
          in: query
          name: priceRuleId
          required: false
          schema:
            type:
              - string
              - 'null'
        - description: ''
          in: query
          name: providerId
          required: false
          schema:
            type:
              - string
              - 'null'
        - description: ''
          in: query
          name: routeId
          required: false
          schema:
            type:
              - string
              - 'null'
        - description: ''
          in: query
          name: ruleSetId
          required: false
          schema:
            type:
              - string
              - 'null'
        - description: Case-insensitive substring of the family's natural name column.
          in: query
          name: search
          required: false
          schema:
            description: Case-insensitive substring of the family's natural name column.
            type:
              - string
              - 'null'
        - description: Administrative scope selected by the caller.
          in: header
          name: x-gproxy-admin-scope
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_Page26'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_Envelope'
          description: Gateway error
      security:
        - consoleSession: []
        - bearer: []
        - anthropicKey: []
        - googleKey: []
components:
  schemas:
    Output_Page26:
      description: |-
        One page of results. `total` counts every row the filters match, not the
        page, so a console can render a pager without a second request.
      properties:
        items:
          items:
            $ref: '#/components/schemas/Output_PriceRateDto'
          type: array
        limit:
          format: uint64
          minimum: 0
          type: integer
        offset:
          format: uint64
          minimum: 0
          type: integer
        total:
          format: uint64
          minimum: 0
          type: integer
      required:
        - items
        - total
        - offset
        - limit
      type: object
    Output_Envelope:
      properties:
        error:
          $ref: '#/components/schemas/Output_EnvelopeBody'
      required:
        - error
      type: object
    Output_PriceRateDto:
      description: |-
        One billable quantity's price. `value` buys `unit_quantity` units, so a
        per-million token price is `unit_quantity = 1000000`.
      properties:
        conditions:
          description: >-
            None is the fallback rate; otherwise a nonempty object of
            dimensions.
        id:
          type: string
        metric:
          description: A `gproxy_store::entity::pricing::metric` key, or a custom one.
          type: string
        priceRuleId:
          type: string
        priority:
          format: int32
          type: integer
        unit:
          description: '`token`, `count`, `second` or `character`.'
          type: string
        unitQuantity:
          type: string
        value:
          type: string
      required:
        - id
        - priceRuleId
        - metric
        - unit
        - unitQuantity
        - value
        - conditions
        - priority
      type: object
    Output_EnvelopeBody:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
    anthropicKey:
      in: header
      name: x-api-key
      type: apiKey
    googleKey:
      in: header
      name: x-goog-api-key
      type: apiKey
    queryKey:
      in: query
      name: key
      type: apiKey
    consoleSession:
      in: cookie
      name: gproxy_session
      type: apiKey

````

## Related topics

- [GET /admin/api/price-rates/{id}](https://gproxy.leenhawk.com/api-reference/management/get-adminapiprice-rates-1.md)
- [POST /admin/api/price-rates](https://gproxy.leenhawk.com/api-reference/management/post-adminapiprice-rates.md)
- [DELETE /admin/api/price-rates/{id}](https://gproxy.leenhawk.com/api-reference/management/delete-adminapiprice-rates.md)
- [PATCH /admin/api/price-rates/{id}](https://gproxy.leenhawk.com/api-reference/management/patch-adminapiprice-rates.md)
- [POST /admin/api/price-rates/batch](https://gproxy.leenhawk.com/api-reference/management/post-adminapiprice-ratesbatch.md)


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