The EntitlementInfo object gives you access to all of the information about the status of a user entitlement.

Hierarchy

  • PurchasesEntitlementInfo

Properties

billingIssueDetectedAt: null | string

The date a billing issue was detected. Can be null if there is no billing issue or an issue has been resolved

@note: Entitlement may still be active even if there is a billing issue. Check the isActive property.

expirationDate: null | string

The expiration date for the entitlement, can be null for lifetime access. If the periodType is trial, this is the trial expiration date.

identifier: string

The entitlement identifier configured in the RevenueCat dashboard

isActive: boolean

True if the user has access to this entitlement

isSandbox: boolean

False if this entitlement is unlocked via a production purchase

latestPurchaseDate: string

The latest purchase or renewal date for the entitlement.

originalPurchaseDate: string

The first date this entitlement was purchased.

periodType: string

The last period type this entitlement was in. Either: NORMAL, INTRO, TRIAL.

productIdentifier: string

The product identifier that unlocked this entitlement

store: "PLAY_STORE" | "APP_STORE" | "STRIPE" | "MAC_APP_STORE" | "PROMOTIONAL" | "AMAZON" | "UNKNOWN_STORE"

The store where this entitlement was unlocked from.

unsubscribeDetectedAt: null | string

The date an unsubscribe was detected. Can be null.

@note: Entitlement may still be active even if user has unsubscribed. Check the isActive property.

willRenew: boolean

True if the underlying subscription is set to renew at the end of the billing period (expirationDate).

Generated using TypeDoc