Skip to main content
POST
Create override

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"

Body

application/json

Autogenerated input type of CreateAffiliateOverride

commission_value
number
required

The commission value (percentage 1-100 or flat fee).

Example:

6.9

id
string
required

The affiliate ID.

override_type
string
required
Allowed value: "standard"
plan_id
string
required

The plan ID (required for standard overrides).

Example:

"plan_xxxxxxxxxxxxx"

applies_to_payments
enum<string> | null

Whether commission applies to first payment or all payments (standard only).

Available options:
first_payment,
all_payments
commission_type
enum<string> | null

The commission type (percentage or flat_fee).

Available options:
percentage,
flat_fee

Response

A successful response

A commission configuration for an affiliate, defining payout terms for a specific plan or revenue share

applies_to_payments
enum<string> | null
required

Whether the commission applies to the first payment only or all payments (standard overrides only).

Available options:
first_payment,
all_payments
applies_to_products
enum<string> | null
required

Whether this rev-share override applies to a single product or all products (rev-share only).

Available options:
single_product,
all_products

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

commission_type
enum<string>
required

The type of commission (percentage or flat_fee).

Available options:
percentage,
flat_fee
commission_value
number
required

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

Example:

6.9

id
string
required

The unique identifier for the affiliate override.

Example:

"affov_xxxxxxxxxxxx"

override_type
enum<string>
required

The type of override (standard or rev_share).

Available options:
standard,
rev_share
plan_id
string | null
required

The plan ID (for standard overrides).

Example:

"plan_xxxxxxxxxxxxx"

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

product_id
string | null
required

The product ID (for rev-share overrides).

revenue_basis
enum<string> | null
required

The revenue calculation basis (pre_fees or post_fees).

Available options:
pre_fees,
post_fees
total_referral_earnings_usd
number
required

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

Example:

6.9