Skip to main content
Entitlements model premium access in your app. In v4 there are two layers: entitlement definitions (the list of entitlements available in the project, managed under /v4/entitlements) and user entitlements (grants attached to a specific user, under /v4/users/{user_id}/entitlements).

​
Key concepts

  • Definition — Project-level entitlement (e.g., plus, premium). Defines the ID, an optional description, and the products that grant it.
  • User entitlement — A grant tied to a specific user, either earned via a purchase or granted manually.
  • Source — appstore, playstore, stripe, paddle, manual, or unknown.
  • Expiration — Subscriptions expire; non-recurring entitlements may be permanent. To grant one by hand, POST /users/{user_id}/entitlements takes entitlement_id (required) and an optional expires_at in Unix seconds. Omit expires_at, or send null or 0, to grant without expiry; a positive value must be in the future.

​
Available endpoints

​
Authentication

All v4 endpoints require a Secret Key. Granting or revoking a user entitlement is a privileged operation in the manifest sense, but the token type is the same as for reads. See Authentication.