Skip to main content
Entitlements represent access rights to premium features in your app. When a user makes a purchase, Qonversion automatically grants the corresponding entitlements. You can also grant or revoke entitlements manually via the API.

Key concepts

  • Active entitlement — The user currently has access to this feature.
  • Source — Where the entitlement originated: appstore, playstore, stripe, manual, or unknown.
  • Expiration — Subscription-based entitlements have an expires timestamp. Non-recurring purchases may not expire.

Entitlement object

FieldTypeDescription
idstringEntitlement identifier (e.g., plus, premium)
activebooleanWhether the user currently has the entitlement
startedintegerActivation timestamp (Unix epoch seconds)
expiresintegerExpiration timestamp (Unix epoch seconds)
sourcestringPurchase origin (appstore, playstore, stripe, manual)
productobjectAssociated product details

Available endpoints

MethodEndpointDescription
GET/users/{user_id}/entitlementsRetrieve all entitlements for a user
POST/users/{user_id}/entitlementsGrant an entitlement to a user
DELETE/users/{user_id}/entitlements/{id}Revoke an entitlement from a user

Authentication

  • GET requires a Project Key.
  • POST and DELETE require a Secret Key (sk_ prefix). Never expose the secret key in client-side code.