Create an offer

post

https://api.sandbox.cleeng.com/3.1/offers

Use this endpoint to create offers. Supported offer types include subscription (including seasonal subscription), pass, live event (previously called live pay-per-view), and one-time purchase (previously called TVOD). (For more information on offers, see What is a Cleeng offer?). With this endpoint, you can also create offer localizations - versions of your offer for different countries and currencies.

Body Params

title

string

required

Offer title, up to 70 characters

description

string

Offer description, up to 255 characters

type

string

required

Offer type. Allowed values: 'subscription', 'pass', 'live', 'vod'.

geoRestriction

object

geoRestriction might be object or null (if not specified). If geoRestrictionis an object, then type and countries are required.

tags

array of strings

Tags to which a customer has access.

tags

price

object

required

Offer price. The offer price may be equal to zero. If it is above zero, it must be higher than the set minimum price (the minimum price differs per offer type and currency).

billingCycle

object

The parameter is required for 'subscription' offer type.

entitlement

object

The parameter is required for 'pass' and 'vod' offer types. Either expiresAt or duration is used depending on the offer type.

event

object

The parameter is required for 'live' offer type.

freeTrial

object

Used only in 'subscription' offer type.

url

string

Url to your content described in the offer

imageUrl

string

Url to an image for an offer; up to 255 characters.

externalProperties

object

Object with string values.

appStoreProductIds

object

ID of an offer in a given App store.

sessionsLimit

int32

The number of allowed simultaneous sessions. Allowed values: Integer greater than 0 or null if disabled, not required at creation.

localizations

array of objects

Offer localizations - versions of your offer for different countries.

localizations

seasonGroupId

string

Required conditionally when billing cycle: season Format: UUID. This is the identifier of a seasonal schedule - a group of seasons, each with its start and end date defined. (For more information on seasonal schedules, see Seasonal subscriptions.)

giftable

boolean

Whether an offer can be purchased as a gift. Default: false.

Headers

Content-Type

string

Defaults to application/json

X-Publisher-Token

string

required

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json