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;
    periodType: PeriodType;
    productIdentifier: string;
    store: Store;
    unsubscribeDetectedAt: null | Date;
    willRenew: boolean;
}

Properties

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

Properties

Readonly billingIssueDetectedAt

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.

Readonly expirationDate

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.

Readonly identifier

identifier: string

The entitlement identifier configured in the RevenueCat dashboard.

Readonly isActive

isActive: boolean

True if the user has access to the entitlement.

Readonly isSandbox

isSandbox: boolean

False if this entitlement is unlocked via a production purchase.

Readonly latestPurchaseDate

latestPurchaseDate: Date

The latest purchase or renewal date for the entitlement.

Readonly originalPurchaseDate

originalPurchaseDate: Date

The first date this entitlement was purchased.

Readonly periodType

periodType: PeriodType

The last period type this entitlement was in.

Readonly productIdentifier

productIdentifier: string

The product identifier that unlocked this entitlement.

Readonly store

store: Store

The store where this entitlement was unlocked from.

Readonly unsubscribeDetectedAt

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.

Readonly willRenew

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

Theme

On This Page

billingIssueDetectedAtexpirationDateidentifierisActiveisSandboxlatestPurchaseDateoriginalPurchaseDateperiodTypeproductIdentifierstoreunsubscribeDetectedAtwillRenew