Skip to main content
GET
Retrieve override
Required permissions:
  • affiliate:basic:read

Autorizaciones

Authorization
string
header
requerido

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

affiliate:basic:read

Parámetros de ruta

id
string
requerido

The affiliate ID.

Ejemplo:

"aff_xxxxxxxxxxxxxx"

override_id
string
requerido

The override ID.

Respuesta

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
requerido

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

Opciones disponibles:
first_payment,
all_payments
applies_to_products
enum<string> | null
requerido

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

Opciones disponibles:
single_product,
all_products

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

commission_type
enum<string>
requerido

The type of commission (percentage or flat_fee).

Opciones disponibles:
percentage,
flat_fee
commission_value
number
requerido

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

Ejemplo:

6.9

id
string
requerido

The unique identifier for the affiliate override.

Ejemplo:

"affov_xxxxxxxxxxxx"

override_type
enum<string>
requerido

The type of override (standard or rev_share).

Opciones disponibles:
standard,
rev_share
plan_id
string | null
requerido

The plan ID (for standard overrides). Null for a product-wide override, which sets the terms for plans added to the product later.

Ejemplo:

"plan_xxxxxxxxxxxxx"

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

product_id
string | null
requerido

The product ID (for rev-share overrides, and for product-wide overrides that set the terms for plans added to the product later).

revenue_basis
enum<string> | null
requerido

The revenue calculation basis (pre_fees or post_fees).

Opciones disponibles:
pre_fees,
post_fees
total_referral_earnings_usd
number
requerido

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

Ejemplo:

6.9