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

# Retrieve override

> Retrieves the details of a specific affiliate override.

Required permissions:
 - `affiliate:basic:read`



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/whopsdk/openapi.documented.yml get /affiliates/{id}/overrides/{override_id}
openapi: 3.1.0
info:
  title: Whop API
  description: >-
    The Whop REST API. Please see
    https://docs.whop.com/developer/api/getting-started for more details.
  termsOfService: https://whop.com/tos-developer-api/
  version: 1.0.0
servers:
  - url: https://api.whop.com/api/v1
    description: Production Whop API
security: []
tags:
  - name: Products
    description: Products
  - name: Plans
    description: Plans
  - name: Payments
    description: Payments
  - name: Refunds
    description: Refunds
  - name: Disputes
    description: Disputes
  - name: Dispute alerts
    description: Dispute alerts
  - name: Resolution center cases
    description: Resolution center cases
  - name: Checkout configurations
    description: Checkout configurations
  - name: Setup intents
    description: Setup intents
  - name: Payment methods
    description: Payment methods
  - name: Invoices
    description: Invoices
  - name: Promo codes
    description: Promo codes
  - name: Card transactions
    description: Card transactions
  - name: Ledger accounts
    description: Ledger accounts
  - name: Transfers
    description: Transfers
  - name: Withdrawals
    description: Withdrawals
  - name: Payout methods
    description: Payout methods
  - name: Verifications
    description: Verifications
  - name: Payout accounts
    description: Payout accounts
  - name: Topups
    description: Topups
  - name: Users
    description: Users
  - name: Companies
    description: Companies
  - name: Authorized users
    description: Authorized users
  - name: Fee markups
    description: Fee markups
  - name: Members
    description: Members
  - name: Memberships
    description: Memberships
  - name: Leads
    description: Leads
  - name: Entries
    description: Entries
  - name: Shipments
    description: Shipments
  - name: Reviews
    description: Reviews
  - name: Company token transactions
    description: Company token transactions
  - name: Affiliates
    description: Affiliates
  - name: Experiences
    description: Experiences
  - name: Forums
    description: Forums
  - name: Forum posts
    description: Forum posts
  - name: Chat channels
    description: Chat channels
  - name: Support channels
    description: Support channels
  - name: Messages
    description: Messages
  - name: Reactions
    description: Reactions
  - name: Dm members
    description: Dm members
  - name: Dm channels
    description: Dm channels
  - name: Notifications
    description: Notifications
  - name: Courses
    description: Courses
  - name: Course chapters
    description: Course chapters
  - name: Course lessons
    description: Course lessons
  - name: Course students
    description: Course students
  - name: Course lesson interactions
    description: Course lesson interactions
  - name: Apps
    description: Apps
  - name: Webhooks
    description: Webhooks
  - name: App builds
    description: App builds
  - name: Access tokens
    description: Access tokens
  - name: Account links
    description: Account links
  - name: Files
    description: Files
  - name: Ai chats
    description: Ai chats
  - name: Bounties
    description: Bounties
  - name: Stats
    description: Stats
  - name: Ad campaigns
    description: Ad campaigns
  - name: Ad groups
    description: Ad groups
  - name: Ads
    description: Ads
  - name: Conversions
    description: Conversions
paths:
  /affiliates/{id}/overrides/{override_id}:
    get:
      tags:
        - Affiliates
      summary: Retrieve override
      description: |-
        Retrieves the details of a specific affiliate override.

        Required permissions:
         - `affiliate:basic:read`
      operationId: retrieveOverrideAffiliate
      parameters:
        - name: id
          in: path
          required: true
          description: The affiliate ID.
          schema:
            type: string
            example: aff_xxxxxxxxxxxxxx
        - name: override_id
          in: path
          required: true
          description: The override ID.
          schema:
            type: string
      responses:
        '200':
          description: A successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: The unique identifier for the affiliate override.
                    example: affov_xxxxxxxxxxxx
                  override_type:
                    $ref: '#/components/schemas/AffiliateOverrideRoles'
                    description: The type of override (standard or rev_share).
                  commission_type:
                    $ref: '#/components/schemas/AffiliatePayoutTypes'
                    description: The type of commission (percentage or flat_fee).
                  commission_value:
                    type: number
                    description: >-
                      The commission amount. A percentage (1-100) when
                      commission_type is percentage, or a dollar amount when
                      flat_fee.
                    example: 6.9
                  applies_to_payments:
                    oneOf:
                      - $ref: '#/components/schemas/AffiliateAppliesToPayments'
                      - type: 'null'
                    description: >-
                      Whether the commission applies to the first payment only
                      or all payments (standard overrides only).
                  plan_id:
                    type:
                      - string
                      - 'null'
                    description: The plan ID (for standard overrides).
                    example: plan_xxxxxxxxxxxxx
                  product_id:
                    type:
                      - string
                      - 'null'
                    description: The product ID (for rev-share overrides).
                  applies_to_products:
                    oneOf:
                      - $ref: '#/components/schemas/AffiliateAppliesToProducts'
                      - type: 'null'
                    description: >-
                      Whether this rev-share override applies to a single
                      product or all products (rev-share only).
                  revenue_basis:
                    oneOf:
                      - $ref: '#/components/schemas/AffiliateRevenueBases'
                      - type: 'null'
                    description: The revenue calculation basis (pre_fees or post_fees).
                  product_direct_link:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The product page direct link for referrals (standard
                      overrides only).
                  checkout_direct_link:
                    type:
                      - string
                      - 'null'
                    description: >-
                      The checkout direct link for referrals (standard overrides
                      only).
                  total_referral_earnings_usd:
                    type: number
                    description: >-
                      The total earnings paid to this affiliate for referrals to
                      this specific plan, in USD.
                    example: 6.9
                required:
                  - id
                  - override_type
                  - commission_type
                  - commission_value
                  - applies_to_payments
                  - plan_id
                  - product_id
                  - applies_to_products
                  - revenue_basis
                  - product_direct_link
                  - checkout_direct_link
                  - total_referral_earnings_usd
                description: >-
                  A commission configuration for an affiliate, defining payout
                  terms for a specific plan or revenue share
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: invalid_request_error
                  code: parameter_missing
                  message: 'Missing required parameter: amount.'
                  param: amount
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: unauthorized
                  message: Invalid or missing API key
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: forbidden
                  message: You do not have permission to access this resource
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: not_found
                  message: Resource not found
        '422':
          description: Verification required
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error: null
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                      message:
                        type: string
                      code:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A short string indicating the specific error code,
                          e.g. 'parameter_missing', 'parameter_invalid',
                          'invalid_json'
                      param:
                        type:
                          - string
                          - 'null'
                        description: The parameter that caused the error, if applicable
                    required:
                      - type
                      - message
                required:
                  - error
              example:
                error:
                  type: internal_server_error
                  message: An unexpected error occurred
      security:
        - bearerAuth:
            - affiliate:basic:read
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Whop from '@whop/sdk';


            const client = new Whop({
              apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
            });


            const override = await
            client.affiliates.overrides.retrieve('override_id', {
              id: 'aff_xxxxxxxxxxxxxx',
            });


            console.log(override.id);
        - lang: Python
          source: |-
            import os
            from whop_sdk import Whop

            client = Whop(
                api_key=os.environ.get("WHOP_API_KEY"),  # This is the default and can be omitted
            )
            override = client.affiliates.overrides.retrieve(
                override_id="override_id",
                id="aff_xxxxxxxxxxxxxx",
            )
            print(override.id)
        - lang: Ruby
          source: >-
            require "whop_sdk"


            whop = WhopSDK::Client.new(api_key: "My API Key")


            override = whop.affiliates.overrides.retrieve("override_id", id:
            "aff_xxxxxxxxxxxxxx")


            puts(override)
components:
  schemas:
    AffiliateOverrideRoles:
      type: string
      enum:
        - standard
        - rev_share
      description: The role of an affiliate override (standard or rev_share)
    AffiliatePayoutTypes:
      type: string
      enum:
        - percentage
        - flat_fee
      description: The types of payouts an affiliate can have
    AffiliateAppliesToPayments:
      type: string
      enum:
        - first_payment
        - all_payments
      description: >-
        Whether the affiliate commission applies to the first payment or all
        payments
    AffiliateAppliesToProducts:
      type: string
      enum:
        - single_product
        - all_products
      description: Whether a rev-share override applies to a single product or all products
    AffiliateRevenueBases:
      type: string
      enum:
        - pre_fees
        - post_fees
      description: The calculation method for affiliate rev-share percentages
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        A company API key, company scoped JWT, app API key, or user OAuth token.
        You must prepend your key/token with the word 'Bearer', which will look
        like `Bearer ***************************`
      scheme: bearer
      bearerFormat: auth-scheme

````