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

# List affiliate commissions

> Retrieve a paginated list of an affiliate’s commissions. Filter by settlement status (pending, approved, paid).



## OpenAPI

````yaml get /v1/affiliates/{id}/commissions
openapi: 3.0.0
info:
  title: Creem API
  description: >-
    Creem is an all-in-one platform for managing subscriptions and recurring
    revenue, tailored specifically for today's SaaS companies. It enables you to
    boost revenue, enhance customer retention, and scale your operations
    seamlessly.
  version: v1
  contact:
    name: Creem Support
    url: https://creem.io
    email: support@creem.io
  license:
    name: Commercial
    url: https://creem.io/terms
  termsOfService: https://creem.io/terms
servers:
  - url: https://api.creem.io
    description: Production — live API for processing real transactions and data.
    x-speakeasy-server-id: prod
  - url: https://test-api.creem.io
    description: Test — sandbox API for development and testing with no real charges.
    x-speakeasy-server-id: test
security: []
tags: []
externalDocs:
  description: Creem Documentation
  url: https://docs.creem.io
paths:
  /v1/affiliates/{id}/commissions:
    get:
      tags:
        - Affiliates
      summary: List affiliate commissions
      description: >-
        Retrieve a paginated list of an affiliate’s commissions. Filter by
        settlement status (pending, approved, paid).
      operationId: listAffiliateCommissions
      parameters:
        - name: id
          required: true
          in: path
          description: The unique identifier of the affiliate
          schema:
            type: string
        - name: status
          required: false
          in: query
          description: >-
            The settlement status of the commission. `pending` while on hold,
            `approved` once cleared and available, `paid` once settled by a
            payout.
          schema:
            $ref: '#/components/schemas/CommissionStatus'
        - name: page_number
          required: false
          in: query
          description: The page number for pagination.
          schema:
            default: 1
            example: 1
            type: number
        - name: page_size
          required: false
          in: query
          description: The number of items per page.
          schema:
            default: 10
            example: 10
            type: number
      responses:
        '200':
          description: Successfully retrieved affiliate commissions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommissionListEntity'
        '400':
          description: Bad Request - Invalid input parameters
        '401':
          description: Unauthorized - Invalid or missing API key
        '404':
          description: Not Found - Resource does not exist
      security:
        - ApiKey: []
components:
  schemas:
    CommissionStatus:
      type: string
      description: >-
        The settlement status of the commission. `pending` while on hold,
        `approved` once cleared and available, `paid` once settled by a payout.
      enum:
        - pending
        - approved
        - paid
    CommissionListEntity:
      type: object
      properties:
        items:
          description: List of commission items
          items:
            $ref: '#/components/schemas/CommissionEntity'
          type: array
        pagination:
          description: Pagination details for the list
          allOf:
            - $ref: '#/components/schemas/PaginationEntity'
      required:
        - items
        - pagination
    CommissionEntity:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the object.
        mode:
          $ref: '#/components/schemas/EnvironmentMode'
        object:
          type: string
          description: >-
            String representing the object's type. Objects of the same type
            share the same value.
          example: commission
        affiliate:
          type: string
          description: The ID of the affiliate this commission belongs to.
          example: aff_1234567890
        amount:
          type: number
          description: The commission amount in cents. 1000 = $10.00
          example: 600
        currency:
          type: string
          description: >-
            Three-letter ISO currency code, in uppercase, for the commission
            amount.
          example: USD
        status:
          $ref: '#/components/schemas/CommissionStatus'
          example: pending
        sale:
          type: string
          description: >-
            The ID of the sale transaction that generated this commission, if
            available.
          example: tran_1234567890
          nullable: true
        created_at:
          type: number
          description: Creation date of the commission as a timestamp.
      required:
        - id
        - mode
        - object
        - affiliate
        - amount
        - currency
        - status
        - created_at
    PaginationEntity:
      type: object
      properties:
        total_records:
          type: number
          description: Total number of records in the list
          example: 0
        total_pages:
          type: number
          description: Total number of pages available
          example: 0
        current_page:
          type: number
          description: The current page number
          example: 1
        next_page:
          type: number
          description: The next page number, or null if there is no next page
          example: 2
          nullable: true
        prev_page:
          type: number
          description: The previous page number, or null if there is no previous page
          example: null
          nullable: true
      required:
        - total_records
        - total_pages
        - current_page
        - next_page
        - prev_page
    EnvironmentMode:
      type: string
      description: String representing the environment.
      enum:
        - test
        - prod
        - sandbox
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can find your API key in the Creem
        dashboard under Settings > API Keys.

````