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, name, and default products.
  • User entitlement — A grant tied to a specific user, either earned via a purchase or granted manually.
  • Sourceappstore, playstore, stripe, manual, or unknown.
  • Expiration — Subscriptions expire; non-recurring entitlements may be permanent.

Available endpoints

MethodEndpointDescriptionStatus
GET/entitlementsList entitlement definitionsNew
POST/entitlementsCreate an entitlement definitionNew
DELETE/entitlements/{entitlement_id}Delete an entitlement definitionNew
GET/entitlements/{entitlement_id}Get an entitlement definitionNew
PATCH/entitlements/{entitlement_id}Update an entitlement definition (partial)New
GET/users/{user_id}/entitlementsList user entitlementsUpdated — v3
POST/users/{user_id}/entitlementsGrant an entitlement to a userUpdated — v3
DELETE/users/{user_id}/entitlements/{entitlement_id}Revoke a user entitlementUpdated — v3

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.