Affiliate Program Object

Attributes
id string
A unique identifier for the affiliate program.
﻿
object string
The value is always affiliate_program.
﻿
label string
The default label of the affiliate program.
﻿
languages object
The titles and descriptions of the affiliate program in all supported languages. The object's keys are a Language Codes﻿ while the values are also objects with the content of the affiliate program.
Exampe
"languages": {
    "en": {
        "label": "20% Commissionn",
        "description": "Awesome affiliate program with 20% commission"
    },
    "de": {
        // German content
    },
    "sv": {
        // Swedish content
    }
}
"languages": {
    "en": {
        "label": "20% Commissionn",
        "description": "Awesome affiliate program with 20% commission"
    },
    "de": {
        // German content
    },
    "sv": {
        // Swedish content
    }
}
﻿
﻿
created_at timestamp
The date the affiliate program was created.
﻿
currency string (currency code)﻿
The currency of the affiliate program.
﻿
commission_amount integer
The fixed commission amount in cents.
﻿
commission_percent decimal
The percentage commission.
﻿
cookie_expiry integer
The lifetime of the affiliate cookie in days. The default value is 30 days.
﻿
description string
The short description of the affiliate program.
﻿
auto_approve boolean
This attribute determines whether affiliates that join the program are automatically approved.
﻿
allow_bonuses boolean
This attribute determines whether affiliates are allowed to offer bonuses (such as eBooks) to customers they refer.
﻿
affiliate_notifications boolean
This attribute determines whether email notifications are sent to the affiliate on every new sale and when commission is deducted due to refunds.
﻿
is_listed boolean
This attribute shows if the affiliate program is listed in the Affiliate Marketplace.
﻿
is_public boolean
This attribute shows whether the affiliate program is publicly visible and whether affiliates are allowed to join.
﻿
payments array of strings
The payment methods that are available for commission payouts.
﻿
destinations array of strings (Country codes﻿)
The country whitelist of the affiliate program.
﻿
subscription_commission_type string
This attribute shows how the commission will be applied to recurring sales. The possible values are forever, repeating and once.
﻿
payment_count integer
The total number of payments to offer commission for recurring subscriptions. Available when subscription_commission_type is set to repeating.
﻿
payout_delay integer
The number of days before a commission is made available to the affiliate.
﻿
banners array of strings
The id of the assets that are used as banners for the affiliate program.
﻿
signup_url string
The URL where affiliates can signup for the affiliate program.
﻿
javascript_url string
The link to the javascript file that you have to install on your domain <head> in order for the affiliate program to track referrals. Required for affiliate programs that are hosted outside of Tamio.
﻿
domain object
An object containing the details of the domain associated with the affiliate program.
﻿
﻿
/
Affiliate Program Object Example
View
﻿
﻿
Affiliate Programs
Create Affiliate Program