createMultiCurrencySubscriptionOffer()


Create different offers for different countries and currencies using localizedData array.

Parameters:

Name Type Description
publisherToken string You can find your publisher token at api-keys page.
offerData object No description
-pricefloatOffer price (in publisher's currency)
-periodstringSubscription period: week / month / 3months / 6months / year
-titlestringTitle of the offer, up to 70 chars.
-urlstringUrl to content
-description stringAdditional offer description, up to 110 chars
-associateEmail stringSet your associate email
-freePeriods intSet your free periods number
-freeDays intSet your free days number
-accessToTags arrayTo which tags customer has access. Multiple tags are defined as "OR" (not "AND"). Set "(all)" if you want to give access to all of your offers.
-countrystring2-letter country code
-currencystringChoose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF
-pricefloatvalue between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-urlstringUrl to content
-description stringAdditional offer description, up to 110 chars
-geoRestrictionEnabled boolSet "true" to enable geo-restriction on this offer
-geoRestrictionType stringChoose type of geo-restriction: whitelist / blacklist
-geoRestrictionCountries arrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries.
localizedData array No description
-pricefloatOffer price (in publisher's currency)
-periodstringSubscription period: week / month / 3months / 6months / year
-titlestringTitle of the offer, up to 70 chars.
-urlstringUrl to content
-description stringAdditional offer description, up to 110 chars
-associateEmail stringSet your associate email
-freePeriods intSet your free periods number
-freeDays intSet your free days number
-accessToTags arrayTo which tags customer has access. Multiple tags are defined as "OR" (not "AND"). Set "(all)" if you want to give access to all of your offers.
-countrystring2-letter country code
-currencystringChoose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF
-pricefloatvalue between 0.14 and 99.99
-titlestringTitle of the offer, up to 70 chars.
-urlstringUrl to content
-description stringAdditional offer description, up to 110 chars
-geoRestrictionEnabled boolSet "true" to enable geo-restriction on this offer
-geoRestrictionType stringChoose type of geo-restriction: whitelist / blacklist
-geoRestrictionCountries arrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries.

- required parameter


Request:

[
    {
        "method": "createMultiCurrencySubscriptionOffer",
        "params": {
            "publisherToken": "klj_nerb324sPLhmzLtp4mDmdc8slwNNyALt-1Xn2Hy0Icfay",
            "offerData": {
                "price": "10",
                "period": "month",
                "title": "Tasty and healthy food",
                "url": "http:\/\/www.testoffer.com",
                "description": "Test offer description",
                "associateEmail": "associate@email.com",
                "accessToTags": []
            },
            "localizedData": [
                {
                    "country": "US",
                    "currency": "USD",
                    "price": "10",
                    "title": "Test offer for US customers"
                },
                {
                    "country": "FR",
                    "currency": "EUR",
                    "price": "8",
                    "title": "Test offer for French customers",
                    "url": "http:\/\/testoffer.com\/fr"
                }
            ]
        },
        "jsonrpc": "2.0",
        "id": 1
    }
]

Response:

[
    {
        "result": {
            "multiCurrencyOfferId": "S740060915",
            "offers": [
                {
                    "id": "S740060915_US",
                    "publisherEmail": "associate@email.com",
                    "title": "Test offer for US customers",
                    "description": "Test offer description",
                    "url": "http:\/\/www.testoffer.com",
                    "currency": "USD",
                    "country": "US",
                    "active": true,
                    "createdAt": 1384263564,
                    "updatedAt": 1384263564,
                    "price": 10,
                    "applicableTaxRate": "0.21",
                    "period": "month",
                    "expiresAt": null,
                    "accessToTags": []
                },
                {
                    "id": "S740060915_FR",
                    "publisherEmail": "associate@email.com",
                    "title": "Test offer for French customers",
                    "description": "Test offer description",
                    "url": "http:\/\/testoffer.com\/fr",
                    "currency": "EUR",
                    "country": "FR",
                    "active": true,
                    "createdAt": 1384263564,
                    "updatedAt": 1384263564,
                    "price": 8,
                    "applicableTaxRate": "0.21",
                    "period": "month",
                    "expiresAt": null,
                    "accessToTags": []
                }
            ]
        },
        "id": "1",
        "error": null,
        "jsonrpc": "2.0"
    }
]

Remember! you can always check it by yourself using API Console - createMultiCurrencySubscriptionOffer()

Back to Subscription Offers


We use cookies to ensure that we provide you the best service and website experience. Read our Cookie policy for more details.