Skip to main content
POST

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Consumer offer in a create request.

consumer
Consumer · object
required

Consumer information

offer
Offer · object
required

Offer.

source
Source · object

Metadata related to the creation or activation process. Will be attached to all entitlements created by this API request.

redirectionParameters
Redirectionparameters · object

Parameters to manage redirects to external websites and related callbacks. Required only if creating the consumer offer requires the consumer to interact with an external website (e.g. a third-party payment page).

Response

Accepted

Consumer offer in a create response.

consumerOffer
ConsumerOfferCreationDetail · object
required

Consumer offer detail

entitlements
Entitlement · object[]
required

Entitlements created under this consumer offer.