Affiliates API
Affiliate Programs
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 appendix docid\ kfbmx4q3dxjtduqf75yx1 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 } } created at timestamp the date the affiliate program was created currency string appendix docid\ kfbmx4q3dxjtduqf75yx1 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 ( appendix docid\ kfbmx4q3dxjtduqf75yx1 ) 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 { "object" "affiliate program", "products" \[ "caf80f0e 6f00 4e53 839b 847b7fe07fa0" ], "domain" { "id" "bc06950e 226c 4a6f 82b1 bff6fe170374", "domain" "google com" }, "label" "test", "languages" { "en" { "label" "20% commissionn", "description" "awesome affiliate program with 20% commission" }, }, "created at" 1671586309, "signup url" "https //tamio com?affiliate program id=d628c45b 271c 4070 ab43 c2c1cc369eef", "id" "d628c45b 271c 4070 ab43 c2c1cc369eef", "currency" "eur", "commission amount" 10000, "commission percent" 0, "description" "test", "payout delay" 0, "subscription commission type" "once", "destinations" \[ "worldwide" ], "payments" \[ "utrust", "bitpay" ], "is public" false, "auto approve" true, "is listed" true, "allow bonuses" true, "payment count" null, "affiliate notifications" true, "banners" null }