Interface EntitlementInfo

This object gives you access to all the information about the status of a user's entitlements.

interface EntitlementInfo {
    billingIssueDetectedAt: null | Date;
    expirationDate: null | Date;
    identifier: string;
    isActive: boolean;
    isSandbox: boolean;
    latestPurchaseDate: Date;
    originalPurchaseDate: Date;
    ownershipType: null | OwnershipType;
    periodType: PeriodType;
    productIdentifier: string;
    productPlanIdentifier: null | string;
    store: Store;
    unsubscribeDetectedAt: null | Date;
    willRenew: boolean;
}

Properties

billingIssueDetectedAt expirationDate identifier isActive isSandbox latestPurchaseDate originalPurchaseDate ownershipType periodType productIdentifier productPlanIdentifier store unsubscribeDetectedAt willRenew

Properties

ReadonlybillingIssueDetectedAt

billingIssueDetectedAt: null | Date

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.

ReadonlyexpirationDate

expirationDate: null | Date

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

Readonlyidentifier

identifier: string

The entitlement identifier configured in the RevenueCat dashboard.

ReadonlyisActive

isActive: boolean

True if the user has access to the entitlement.

ReadonlyisSandbox

isSandbox: boolean

False if this entitlement is unlocked via a production purchase.

ReadonlylatestPurchaseDate

latestPurchaseDate: Date

The latest purchase or renewal date for the entitlement.

ReadonlyoriginalPurchaseDate

originalPurchaseDate: Date

The first date this entitlement was purchased.

ReadonlyownershipType

ownershipType: null | OwnershipType

Use this property to determine whether a purchase was made by the current user or shared to them by a family member. This can be useful for onboarding users who have had an entitlement shared with them, but might not be entirely aware of the benefits they now have.

ReadonlyperiodType

periodType: PeriodType

The last period type this entitlement was in.

ReadonlyproductIdentifier

productIdentifier: string

The product identifier that unlocked this entitlement.

ReadonlyproductPlanIdentifier

productPlanIdentifier: null | string

The base plan identifier that unlocked this entitlement (For Google Play subs only).

Readonlystore

store: Store

The store where this entitlement was unlocked from.

ReadonlyunsubscribeDetectedAt

unsubscribeDetectedAt: null | Date

The date an unsubscribe was detected. Can be null. Note: Entitlement may still be active even if user has unsubscribed. Check the EntitlementInfo.isActive property.

ReadonlywillRenew

willRenew: boolean

True if the underlying subscription is set to renew at the end of the billing period (expirationDate). Will always be True if entitlement is for lifetime access.

Settings

Member Visibility

On This Page

Properties