CreateAffiliateLinkDto

apply_for_subscriptionsbooleanRequired

codestringRequired

commission_amountintegerRequired

commission_amount_stepsAffiliateLinkCommissionAmountStepDto[]Required

Represents the commission for a specific subscription renewal billing cycle. A step applies to its exact cycle - see the affiliate link's 'last_commission_amount_step_repeats' for what happens past the last step.

billing_cycle_sequenceintegerRequired

The billing cycle number this commission step applies to. Starts at 1 for the initial purchase.

commission_amountintegerRequired

The commission percentage for this cycle, in tenths of a percent (e.g., 125 = 12.5%).

commission_typeenumRequired

Specifies the type of commission an affiliate earns from referred purchases.

Possible enum values

none
No commission is earned.
fixed
A fixed amount commission (e.g., $5 per purchase). Not yet supported by the affiliate service.
percentage
A percentage-based commission (e.g., 10% of the purchase).

discount_amountintegerRequired

discount_typeenumRequired

Specifies the type of discount offered to customers referred through an affiliate link.

Possible enum values

none
No discount is offered.
fixed
A fixed amount discount (e.g., $5 off).
percentage
A percentage-based discount (e.g., 10% off).

enabledbooleanRequired

last_commission_amount_step_repeatsbooleanRequired

referer_typeenumRequired

Specifies which affiliate link is credited when a customer follows multiple links before purchasing.

Possible enum values

invalid
No referer type specified. This value is typically used as a default or uninitialized state.
first_referer
The first affiliate link the customer followed is credited.
last_referer
The most recent affiliate link the customer followed is credited.

tracking_length_daysintegerRequired

wallet_idstringRequired

Example

{
  "wallet_id": "string",
  "enabled": true,
  "code": "string",
  "referer_type": "invalid",
  "tracking_length_days": 0,
  "apply_for_subscriptions": true,
  "discount_type": "none",
  "discount_amount": 0,
  "commission_type": "none",
  "commission_amount": 0,
  "commission_amount_steps": [
    {
      "billing_cycle_sequence": 0,
      "commission_amount": 0
    }
  ],
  "last_commission_amount_step_repeats": true
}