updateMultiCurrencySubscriptionOffer

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

Name

Type

Description

publisherToken*

string

You can find your publisher token at api-keys page.

multiCurrencyOfferId*

string

E.g. if you create multicurrency offer and you get couple of ids: A767351455_FR, A767351455_US, A767351455_GB. multiCurrencyOfferId is just A767351455

offerData*

object

No description

-price

float

Offer price (in publisher's currency)

-period

string

Subscription period: week / month / 3months / 6months / year

-title

string

Title of the offer, up to 70 chars.

-url

string

Url to content

-description

string

Additional offer description, up to 110 chars

-freePeriods

int

Set your free periods number

-freeDays

int

Set your free days number

-accessToTags

array

To 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.

localizedData

array

No description

-country*

string

2-letter country code

-currency

string

Choose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF

-price

flaot

Offer price (in publisher's currency)

-period

string

Subscription period: week / month / 3months / 6months / year

-title

string

Title of the offer, up to 70 chars.

-url

string

Url to content

-description

string

Additional offer description, up to 110 chars

-freePeriods

int

Set your free periods number

-freeDays

int

Set your free days number

-accessToTags

array

To 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.

-geoRestrictionEnabled

bool

Set "true" to enable geo-restriction on this offer

-geoRestrictionType

string

Choose type of geo-restriction: whitelist / blacklist

-geoRestrictionCountries

array

Based 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"
  }