The User Entitlement is access to some premium features of your application. Examples of entitlements could be:
- YouTube Premium
- Netflix Standard, Netflix Premium
- Duolingo Plus
Most applications have only one entitlement that provides premium access.
The Object Attributes
{
"active": true,
"expires": 1654215637,
"id": "plus",
"product": {
"product_id": "main",
"subscription": {
"current_period_type": "normal",
"renew_state": "will_renew"
}
},
"source": "appstore",
"started": 1652438020
}
| Field | Type | Description |
|---|---|---|
| id | string | The entitlement ID. For example, premium |
| 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 | The expiration time for the entitlement is measured in seconds since the Unix epoch and denotes when the entitlement will no longer be available. |
| product | object | A product granted the entitlement. |
| source | string | Source of the purchase via which the entitlement was activated. Values: – appstore: App Store– playstore: Play Store– stripe: Stripe– unknown: unable to detect the source– manual: the entitlement was activated manually |
Product attributes
| Field | Type | Description |
|---|---|---|
| product_id | string | The product identifier in Qonversion. |
| subscription | string | Subscription linked to the product. Exists only for subscription type products. |
Subscription attributes
| Field | Type | Description |
|---|---|---|
| current_period_type | string | Possible values: – normal: the product is in it's normal period– trial: free trial period– intro: introductory pricing period |
| renew_state | string | A renewal state of the product. It can have the following values: – will_renew: subscription is active, and auto-renew status is on– canceled: auto-renew status is off– billing_issue: there was some billing issue. |