Documentation

Entitlement Events

This section provides a detailed overview of Entitlement Events

Entitlement Events are generated by the Purchasely Platform when premium accesses are created/modified/removed (because of a purchase, renewal, refund, payment issue, ...).

There are 2 different Entitlements Events:

Transaction EventUsed toTriggered when
ACTIVATEActivate the user’s entitlements
  1. a new subscription starts
  2. a subscription is renewed
  3. an In-App Purchase (consumable / non consumable) is purchased
  4. a subscription or a non consumable is "stolen" from another user, following a restore or sign-in/sign-up
  5. a subscription starts because of a plan change (following an up-selling, down-selling or cross-selling)
  6. a subscription enters in grace period
  7. a subscription is resumed after being paused (Google Play Store only)
  8. a subscription is resumed after a billing retry or a grace period
  9. a refund has been asked by the user via Apple Care but the developer refuses it from the App Store Connect Console (tricky one we know 😅...)
DEACTIVATEDeactivate the user’s entitlements
  1. a subscription is effectively terminated
  2. a subscription enters in billing retry
  3. a subscription or an In-App Purchase has been refunded
  4. a subscription or a non consumable has been transferred to another user, following a restore or sign-in/sign-up
  5. a subscription ends because of a plan change (following an up-selling, down-selling or cross-selling)
  6. a subscription is being paused (Google Play Store only)

They are both composed of a JSON payload which includes all the relevant data to manage entitlements (more details on their attributes).

For more information on how to manage entitlements with your backend, refer to Backend entitlements.

Updated 4 months ago

What’s Next

Want to know how to leverage these events to manage entitlements with your own backend?

Did this page help you?