List overrides

Returns a paginated list of overrides for an affiliate.

Required permissions:

• affiliate:basic:read

GET /affiliates/{id}/overrides

JavaScript

JavaScript

import Whop from '@whop/sdk';

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

// Automatically fetches more pages as needed.
for await (const overrideListResponse of client.affiliates.overrides.list('aff_xxxxxxxxxxxxxx')) {
  console.log(overrideListResponse.id);
}

200

{
  "data": [
    {
      "id": "affov_xxxxxxxxxxxx",
      "commission_value": 6.9,
      "plan_id": "plan_xxxxxxxxxxxxx",
      "product_id": "<string>",
      "product_direct_link": "<string>",
      "checkout_direct_link": "<string>",
      "total_referral_earnings_usd": 6.9
    }
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Authorizations

Authorization · string · header · required

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 ***************************

Path Parameters

id · string · required

The affiliate ID.

Example:

"aff_xxxxxxxxxxxxxx"

Query Parameters

after · string | null

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

before · string | null

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

first · integer | null

Returns the first n elements from the list.

Example:

42

last · integer | null

Returns the last n elements from the list.

Example:

42

override_type · enum<string> | null

Filter by override type (standard or rev_share).

Available options: standard, rev_share

Response

200

application/json

A successful response

The connection type for AffiliateOverride.

data · object[] · required

A list of nodes.

Show child attributes

page_info · object · required

Information to aid in pagination.

Show child attributes