DocsAPI ReferenceDiscussionsBlogGithub

User Entitlements

The User Entitlement (aka Permission) is access to some premium features of your application. Examples of entitlements could be:‌

  • YouTube Premium
  • Netflix Standart, Netflix Premium
  • Duolingo Plus

Most applications have only one entitlement that provides premium access.

Endpoints

POST /v2/user/:id/entitlements DELETE /v2/user/:id/entitlements/:entitlement

The User Entitlement Object

Field

Type

Description

entitlement_id

string

The entitlement ID. For example, premium

user_id

string

The ID of the user the entitlement belongs to.

active

bool

true means a user has active entitlement.

Please note, active = true does not mean that a subscription will be renewed.
A user can have active entitlement, while auto-renewal for the subscription was switched off.

started

timestamp

Time at which the entitlement was started. Measured in seconds since the Unix epoch.

expires

timestamp

Time at which the entitlement expires and is no longer available. Measured in seconds since the Unix epoch.

object

string

The value is user_entitlement. String representing the object’s type.