POST
/
monetization
/
entitlements
/
v1
curl --request POST \
  --url https://api.mottostreaming.com/monetization/entitlements/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "<string>",
  "project_id": "<string>",
  "offer_id": "<string>",
  "expiration_time": "2023-11-07T05:31:56Z",
  "source_type": "<string>",
  "source_id": "<string>",
  "concurrency_limit": "<string>",
  "origin_country_code": "<string>"
}'
{
  "entitlement": {
    "user_id": "<string>",
    "project_id": "<string>",
    "offer_id": "<string>",
    "expiration_time": "2023-11-07T05:31:56Z",
    "source_type": "<string>",
    "source_id": "<string>",
    "concurrency_limit": "<string>",
    "origin_country_code": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Entitlements represent an end-users permission to access event or creative work content.

user_id
string
required

The ID of the user who is entitled to access the content. The user ID must be contained in the JWT token that the user authenticates with on the content-delivery API.

project_id
string
required
offer_id
string
required

The offer that the user is entitled to access. For more information, see Offer.

expiration_time
string

The time at which the entitlement is no longer valid. If not provided, the entitlement will not expire.

source_type
string

A string representing the type of the source of the entitlement. For example, cleeng or motto.

source_id
string

An identifier of the source of the entitlement. For example, the Cleeng transaction ID or the Motto transaction ID.

concurrency_limit
string

The amount of devices that can concurrently view the content associated with this entitlement from a single account. If not provided, there is no limit. This typically refers to the number of devices that can concurrently view the content associated with the offer, but may deviate in certain conditions (e.g. when the entitlement is created via this API and should have a different limit, or when the offer's concurrency limit has changed since the original entitlement was created).

origin_country_code
string

The two-character ISO 3166-1 alpha-2 country code of the country where the user obtained the entitlement. This may be used to bypass geo-restrictions in certain conditions, e.g. when the user is traveling and is protected by EU regulations (https://europa.eu/youreurope/citizens/consumers/internet-telecoms/access-online-content-abroad/index_en.htm). If not provided, the entitlement will not be able to bypass geo-restrictions.

Response

200
application/json
OK
entitlement
object

Entitlements represent an end-users permission to access event or creative work content.