Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Affiliates

Create override

Creates a commission override for an affiliate.

Required permissions:

  • affiliate:create
post/affiliates/{id}/overrides

Path parameters

idstring required
Example:aff_xxxxxxxxxxxxxx

The affiliate ID.

Request body

OR

Example request

{
  "commission_value": 6.9,
  "plan_id": "plan_xxxxxxxxxxxxx"
}

Response

A successful response

applies_to_payments'first_payment' | 'all_payments' required

Whether the affiliate commission applies to the first payment or all payments

applies_to_products'single_product' | 'all_products' required

Whether a rev-share override applies to a single product or all products

checkout_direct_linkstring nullable required

The checkout direct link for referrals (standard overrides only).

commission_type'percentage' | 'flat_fee' required

The types of payouts an affiliate can have

commission_valuenumber required

The commission amount. A percentage (1-100) when commission_type is percentage, or a dollar amount when flat_fee.

idstring required

The unique identifier for the affiliate override.

override_type'standard' | 'rev_share' required

The role of an affiliate override (standard or rev_share)

plan_idstring nullable required

The plan ID (for standard overrides).

product_direct_linkstring nullable required

The product page direct link for referrals (standard overrides only).

product_idstring nullable required

The product ID (for rev-share overrides).

revenue_basis'pre_fees' | 'post_fees' required

The calculation method for affiliate rev-share percentages

total_referral_earnings_usdnumber required

The total earnings paid to this affiliate for referrals to this specific plan, in USD.

Example response

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