Retrieve entitlement status

Retrieves the entitlement status for the given content key.

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-api-version

string

required

The version of the Customer API you are using.

x-supertab-client-id

string

required

Your Client ID with Supertab. Used to identify the website on which Customer is making a Purchase.

Example:

"live_client.4df706b5-297a-49c5-a4cd-2a10eca12ff9"

Path Parameters

content_key

string

required

The content_key to check access for

Example:

"site.cf637646-71a4-430d-aaea-a66f1a48a83c"

Response

200

application/json

Successful Response

A customer's entitlement status to a given content_key

content_key

string

required

The content_key being checked

Example:

"site.cf637646-71a4-430d-aaea-a66f1a48a83c"

has_entitlement

boolean

required

If the customer has access to this content

expires

string | null

required

When the customer's access will expire

recurs_at

string | null

required

If this access is a result of a subscription, the time the subscription will renew unless cancelled by the customer.