Sign in

v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

Create an offer

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.

post/offers

Headers

Content-Typestring
X-Publisher-Tokenstring required

Request body

titlestring required

Offer title, up to 70 characters

descriptionstring

Offer description, up to 255 characters

typestring required

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

tagsstring[]

Tags to which a customer has access.

urlstring

Url to your content described in the offer

imageUrlstring

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

sessionsLimitinteger

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

seasonGroupIdstring

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

giftableboolean

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

countryCodestring

A 2-letter country code. Allowed values: ISO-3166 country code without UK.

Response

200

idstring
longIdstring
typestring
activeboolean
titlestring
descriptionstring
urlstring
imageUrlstring
hasLandingPageboolean
createdAtinteger
updatedAtinteger
{"stackTrail":"paths:/offers:post:responses:200:content:application/json:schema:properties:sessionsLimit","oasType":"schema","type":"unknown"}
giftableboolean

Example response

{
  "id": "S229081230",
  "longId": "S229081230_PL",
  "type": "subscription",
  "active": true,
  "title": "Test subscription",
  "description": "Description of test subsription",
  "url": "https://example-url.com",
  "externalProperties": {
    "custom-attribute": "custom value"
  },
  "price": {
    "amount": 10,
    "currency": "EUR",
    "taxIncluded": true
  },
  "geoRestriction": {
    "type": "whitelist",
    "countries": [
      "NL"
    ]
  },
  "createdAt": 1649144282,
  "updatedAt": 1649144282,
  "billingCycle": {
    "periodUnit": "month",
    "amount": 1
  },
  "freeTrial": {
    "type": "period",
    "duration": 1
  }
}