These docs are for v2.0. Click to read the latest docs for v2.1.

createMultiCurrencyRentalOffer

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

📘

You can try that method by clicking here

Parameters

NameTypeDescription
publisherToken*stringYou can find your publisher token at api-keys page.
offerData*objectNo description
-price*floatOffer price (in publisher's currency), value between 0.14 and 99.99
-title*stringTitle of the offer, up to 70 chars.
-period*integerAmount of time after which purchase will expire (in hours)
-url*stringUrl to content
-descriptionstringAdditional offer description, up to 110 chars
-tagsstringTags attached to offer.
localizedData*array-
-country*string2-letter country code
-currency*stringChoose one: USD, EUR, GBP, CAD, AUD, NZD, SEK, DKK, NOK, TRL, ZAR, XOF
-price*floatvalue between 0.14 and 99.99
-title*stringTitle of the offer, up to 70 chars.
-urlstringUrl to content
-descriptionstringAdditional offer description, up to 110 chars
-videoIdstringLink offer with unique video asset id
-contentExternalIdstringThis parameter is for your own usage. You can put here id of article or video, anything what can make your offer clearer for you.
-contentExternalDatastringIf you want to store a few extra elements related to the sale you can use this string to store additional data.
-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":"createMultiCurrencyRentalOffer",
  "params":{
    "publisherToken":"klj_nerb324sPLhmzLtp4mDmdc8slwNNyAdt-1Xn2Hy0Icfay",
      "offerData":{
        "price":"10",
        "title":"Tasty and healthy food",
        "period":"24",
        "url":"http:\/\/www.testoffer.com",
        "description":"Test offer description",
        "tags":[
        ]
       },
      "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": "R841924054",
		"offers": [{
			"id": "R841924054_US",
			"publisherEmail": "[email protected]",
			"url": "http:\/\/www.testoffer.com",
			"title": "Test offer for US customers",
			"description": "Test offer description",
			"currency": "USD",
			"averageRating": 4,
			"active": true,
			"createdAt": 1384260473,
			"updatedAt": 1384260473,
			"price": 10,
			"applicableTaxRate": "0.21",
			"tags": [],
			"period": "24",
			"videoId": "",
			"contentExternalId": 0,
			"contentExternalData": null
		}, {
			"id": "R841924054_FR",
			"publisherEmail": "[email protected]",
			"url": "http:\/\/testoffer.com\/fr",
			"title": "Test offer for French customers",
			"description": "Test offer description",
			"currency": "EUR",
			"averageRating": 4,
			"active": true,
			"createdAt": 1384260473,
			"updatedAt": 1384260473,
			"price": 8,
			"applicableTaxRate": "0.21",
			"tags": [],
			"period": "24",
			"videoId": "",
			"contentExternalId": 0,
			"contentExternalData": null
		}]
	},
	"id": "1",
	"error": null,
	"jsonrpc": "2.0"
}