updateMultiCurrencySubscriptionOffer

❗️

Deprecated

This API endpoint is deprecated. If you would like to create or modify an offer with localization, you can do so directly in the Cleeng dashboard.

Update different offers for different countries using localizedData array. Plase note, that you are unable to edit currency.

📘

You can try that method by clicking here

Parameters

NameTypeDescription
publisherToken*stringYou can find your publisher token at api-keys page.
multiCurrencyOfferId*stringE.g. if you create multicurrency offer and you get couple of ids: A767351455_FR, A767351455_US, A767351455_GB. multiCurrencyOfferId is just A767351455
offerData*objectNo 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
-descriptionstringAdditional offer description, up to 110 chars
-freePeriodsintSet your free periods number
-freeDaysintSet your free days number
-accessToTagsarrayTo 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.
localizedDataarrayNo description
-country*string2-letter country code
-currencystringChoose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF
-priceflaotOffer price (in publisher's currency)
-periodstringSubscription period: week / month / 3months / 6months / year
-titlestringTitle of the offer, up to 70 chars.
-urlstringUrl to content
-descriptionstringAdditional offer description, up to 110 chars
-freePeriodsintSet your free periods number
-freeDaysintSet your free days number
-accessToTagsarrayTo 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.
-geoRestrictionEnabledboolSet "true" to enable geo-restriction on this offer
-geoRestrictionTypestringChoose type of geo-restriction: whitelist / blacklist
-geoRestrictionCountriesarrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries.

API Request/Response

Request

{
    "method":"updateMultiCurrencySubscriptionOffer",
    "params":{
      "publisherToken":"klj_nerb324sPLhmzLtp4mDmdc8slwNNyALt-1Xn2Hy0Icfay",
      "multiCurrencyOfferId":"S740060915",
      "offerData":{
        "price":"10",
        "period":"year",
        "accessToTags":[

        ]
      },
      "localizedData":[
        {
          "country":"US",
          "currency":"USD",
          "price":"11",
          "title":"Test offer for US customers"
        },
        {
          "country":"FR",
          "currency":"EUR",
          "price":"9"
        }
      ]
    },
    "jsonrpc":"2.0",
    "id":1
 }

Response

{
    "result":{
      "multiCurrencyOfferId":"S740060915",
      "offers":[
        {
          "id":"S740060915_FR",
          "publisherEmail":"[email protected]",
          "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":9,
          "applicableTaxRate":"0.21",
          "period":"year",
          "expiresAt":null,
          "accessToTags":[

          ]
        },
        {
          "id":"S740060915_US",
          "publisherEmail":"[email protected]",
          "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":11,
          "applicableTaxRate":"0.21",
          "period":"year",
          "expiresAt":null,
          "accessToTags":[

          ]
        }
      ]
    },
    "id":"1",
    "error":null,
    "jsonrpc":"2.0"
  }