Cleeng Pass API Reference

After purchasing pass offer, user has access to any offer with tag you set in accessToTags array for period you set in period or expiresAt parameter. Customer will be billed only once.

Read more about all types of Cleeng Offers in Creating Offers

Pass Offer object properties

Name Description
id Offer identifier
publisherEmail E-mail to offer owner. Can be set to associate e-mail address by distributor.
url http://site.com/with-your-content
title Your offer title. Up to 70 chars
description Define a short, but powerful sales message about this offer. Up to 110 chars
period Choose your pass period: day / week / 2weeks / month / 3months / 6months / year
expiresAt Instead of period you can set exactly when your pass will expire. Unix timestamp.
price Float, from 0.14 up to 99.99
applicableTaxRate VAT rate
currency Offer currency same as publisher's currency. Can be changed from my account setting
accessToTags 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.
active if the offer is able to buy, to deactivate offer use deactivatePassOffer method
createdAt unix timestamp
updatedAt unix timestamp

List of Pass API methods

  1. getPassOffer
  2. listPassOffers
  3. createPassOffer
  4. updatePassOffer
  5. deactivatePassOffer
  6. createMultiCurrencyPassOffer
  7. updateMultiCurrencyPassOffer

 

Back to Table Of Contents