Affiliates

List overrides

Changed on

Returns a paginated list of overrides for an affiliate.

Required permissions:

  • affiliate:basic:read
get/affiliates/{id}/overrides

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/affiliates/{id}/overrides
  • Auth: HTTP bearer

Path parameters

idstring required
Example:aff_xxxxxxxxxxxxxx

The affiliate ID.

Query parameters

afterstring

Returns the elements in the list that come after the specified cursor.

beforestring

Returns the elements in the list that come before the specified cursor.

firstinteger

Returns the first n elements from the list.

Example:42
lastinteger

Returns the last n elements from the list.

Example:42
override_type'standard' | 'rev_share'

The role of an affiliate override (standard or rev_share)

Response

A successful response

Example response

{
  "data": [
    {
      "commission_value": 6.9,
      "id": "affov_xxxxxxxxxxxx",
      "plan_id": "plan_xxxxxxxxxxxxx",
      "total_referral_earnings_usd": 6.9
    }
  ]
}

Changes

  • f67a043e3190Revision changes
    • breaking

      the query request parameter override_type was restricted to a list of enum values

    • info

      added the new enum value rev_share to the query request parameter override_type

    • info

      added the new enum value standard to the query request parameter override_type

    • info

      for the query request parameter override_type, the type was generalized from no type to string