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

# Retrieve commission

> Retrieve a commission by id

Returns commission details for the authenticated developer.



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/checkout-intents/openapi.documented.yml get /api/v1/commissions/{id}
openapi: 3.0.0
info:
  title: Universal Checkout API
  version: 1.0.5
  description: >-
    Turn any product URL into a completed checkout. Instantly retrieve price,
    tax, and shipping for any product, and let users buy without ever leaving
    your native AI experience.


    View the [Rye API docs](https://docs.rye.com).
  termsOfService: https://rye.com/terms-of-service
  license:
    name: UNLICENSED
  contact:
    name: Rye
    email: dev@rye.com
    url: https://docs.rye.com
servers:
  - url: https://staging.api.rye.com
security: []
paths:
  /api/v1/commissions/{id}:
    get:
      tags:
        - Commissions
      summary: Retrieve commission
      description: |-
        Retrieve a commission by id

        Returns commission details for the authenticated developer.
      operationId: GetCommission
      parameters:
        - description: The id of the commission to look up
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Commission details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissionResponse'
        '401':
          description: Authentication Failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
      security:
        - bearerAuth:
            - billing:read
components:
  schemas:
    CommissionResponse:
      properties:
        finalizedAt:
          type: string
          format: date-time
          description: >-
            Time the commission moved to a terminal status. Unset until
            finalized.
        updatedAt:
          type: string
          format: date-time
          description: Time the commission last changed (e.g. status transition).
        createdAt:
          type: string
          format: date-time
          description: Time the commission was first recorded.
        ryeFee:
          $ref: '#/components/schemas/Money'
          description: Fee retained by Rye.
        developerCommission:
          $ref: '#/components/schemas/Money'
          description: Commission amount paid to the developer.
        settlementDirection:
          $ref: '#/components/schemas/SettlementDirection'
          description: Whether Rye owes the developer or vice versa once settled.
        status:
          $ref: '#/components/schemas/CommissionStatus'
          description: Lifecycle status, e.g. pending, finalized, refunded.
        type:
          $ref: '#/components/schemas/CommissionType'
          description: Kind of commission, e.g. surcharge, discount_code, affiliate.
        checkoutIntentId:
          type: string
          description: The checkout intent this commission was generated from.
        id:
          type: string
          description: Unique identifier for this commission.
      required:
        - updatedAt
        - createdAt
        - ryeFee
        - developerCommission
        - settlementDirection
        - status
        - type
        - checkoutIntentId
        - id
      type: object
      description: A commission earned (or owed) on a completed checkout intent.
    AuthenticationError:
      properties:
        name:
          type: string
        message:
          type: string
        stack:
          type: string
      required:
        - name
        - message
      type: object
      additionalProperties: false
    NotFoundError:
      properties:
        name:
          type: string
        message:
          type: string
        stack:
          type: string
      required:
        - name
        - message
      type: object
      additionalProperties: false
    Money:
      properties:
        currencyCode:
          type: string
          example: USD
        amountSubunits:
          type: integer
          format: int32
          example: 1500
      required:
        - currencyCode
        - amountSubunits
      type: object
    SettlementDirection:
      type: string
      enum:
        - rye_owes_developer
        - developer_owes_rye
      description: 'Direction of settlement: who owes whom once the commission is finalized.'
    CommissionStatus:
      type: string
      enum:
        - pending
        - confirmed
        - updated
        - finalized
        - refunded
        - expired
      description: Lifecycle status of a commission record.
    CommissionType:
      type: string
      enum:
        - surcharge
        - promo_arbitrage
        - discount_code
        - affiliate
        - out_of_band
      description: >-
        Type of commission earned on an order. Canonical definition used by

        both the API contract and the internal `@rye-com/ci-commissions`
        package.
  securitySchemes:
    bearerAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Rye API key

````