Check Entitlements

Entitlements are the stable access keys your app should check after configure, purchase, restore, or sync. Product IDs and package IDs can change; entitlement keys are what your app uses to decide access. Use a small set of keys, such as:

premium
pro
credits_pack

Most subscription apps start with one key: premium.

Basic access check

let info = try await AppActor.shared.getCustomerInfo()
let isPremium = info.hasActiveEntitlement("premium")

lifecycleScope.launch {
    val info = AppActor.shared.getCustomerInfo()
    val isPremium = info.hasActiveEntitlement("premium")
}

final info = await AppActor.instance.getCustomerInfo();
final isPremium = info.hasActiveEntitlement('premium');

const info = await AppActor.instance.getCustomerInfo();
const isPremium = info.hasActiveEntitlement("premium");

This is the right check for ordinary UI routing: show premium tab, hide onboarding upsell, or decide whether to show a paywall.

High-trust access check

If the feature is expensive, server-backed, or abuse-prone, also check verification state.

let info = try await AppActor.shared.getCustomerInfo()

let canUnlock = info.hasActiveEntitlement("premium") &&
    info.verification.isVerified &&
    !info.isComputedOffline

val info = AppActor.shared.getCustomerInfo()

val canUnlock = info.hasActiveEntitlement("premium") &&
    info.verification.isVerified &&
    !info.isComputedOffline

final info = await AppActor.instance.getCustomerInfo();

final canUnlock = info.hasActiveEntitlement('premium') &&
    info.verification.isVerified &&
    !info.isComputedOffline;

const info = await AppActor.instance.getCustomerInfo();

const canUnlock =
  info.hasActiveEntitlement('premium') &&
  (info.verification === AppActorVerificationResult.Verified ||
    info.verification === AppActorVerificationResult.VerifiedOnDevice) &&
  !info.isComputedOffline;

For backend resources, use Server-side Access Checks instead of trusting only the device.

Entitlement status matrix

Status	Access?	How to treat it
`active`	Yes	Grant access.
`grace`	Yes	Grant access while `gracePeriodExpiresAt` is still valid.
`billing_retry`	No	Show billing recovery messaging, not premium access.
`expired`	No	Show paywall or renewal path.
`revoked`	No	Show paywall or support messaging.

SDK helpers already encode this active-access rule. If you are reading raw backend user data, check isActive or explicitly allow only active and valid grace.

When to refresh customer info

Refresh customer info after:

app configure or sign-in
purchase success
restore success
quiet sync
receipt queue drain
returning online after offline access
support-driven account recovery

final result = await AppActor.instance.purchasePackage(package);

if (result.customerInfo?.hasActiveEntitlement('premium') == true) {
  showPremiumHome();
} else {
  final fresh = await AppActor.instance.getCustomerInfo();
  if (fresh.hasActiveEntitlement('premium')) showPremiumHome();
}

Offline fallback

Use offline entitlement keys for continuity, not as fresh billing truth.

let offlineKeys = await AppActor.shared.activeEntitlementKeysOffline()
let canTemporarilyShowPremium = offlineKeys.contains("premium")

val offlineKeys = AppActor.shared.activeEntitlementKeysOffline()
val canTemporarilyShowPremium = "premium" in offlineKeys

final offlineKeys = await AppActor.instance.activeEntitlementKeysOffline();
final canTemporarilyShowPremium = offlineKeys.contains('premium');

const offlineKeys = await AppActor.instance.activeEntitlementKeysOffline();
const canTemporarilyShowPremium = offlineKeys.has('premium');

Refresh with getCustomerInfo() once the network returns.

Rules of thumb

use entitlement keys like premium or pro for access
do not unlock premium from the selected package alone
refresh customer info after purchase and recovery flows
handle cached or offline-computed customer state intentionally
check verification for high-trust access
protect backend resources with your backend, not with mobile-only checks

Read Trusted Entitlements for response verification rules and Making Purchases for purchase-result handling.

Overview

Get Started

Testing and Go Live

Features

Remote Config

Experiments

Platform Resources

AI-Ready

Check Entitlements

Basic access check

High-trust access check

Entitlement status matrix

When to refresh customer info

Offline fallback

Rules of thumb

​Basic access check

​High-trust access check

​Entitlement status matrix

​When to refresh customer info

​Offline fallback

​Rules of thumb

Basic access check

High-trust access check

Entitlement status matrix

When to refresh customer info

Offline fallback

Rules of thumb