public / com.revenuecat.purchases / EntitlementInfo

EntitlementInfo

class EntitlementInfo : Parcelable

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

Constructors

<init>

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

EntitlementInfo(identifier: String, isActive: Boolean, willRenew: Boolean, periodType: PeriodType, latestPurchaseDate: Date, originalPurchaseDate: Date, expirationDate: Date?, store: Store, productIdentifier: String, isSandbox: Boolean, unsubscribeDetectedAt: Date?, billingIssueDetectedAt: Date?)

Properties

billingIssueDetectedAt

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.

val billingIssueDetectedAt: Date?

expirationDate

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

val expirationDate: Date?

identifier

The entitlement identifier configured in the RevenueCat dashboard.

val identifier: String

isActive

True if the user has access to this entitlement.

val isActive: Boolean

isSandbox

False if this entitlement is unlocked via a production purchase.

val isSandbox: Boolean

latestPurchaseDate

The latest purchase or renewal date for the entitlement.

val latestPurchaseDate: Date

originalPurchaseDate

The first date this entitlement was purchased.

val originalPurchaseDate: Date

periodType

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

val periodType: PeriodType

productIdentifier

The product identifier that unlocked this entitlement.

val productIdentifier: String

store

The store where this entitlement was unlocked from. Either: APP_STORE, MAC_APP_STORE, PLAY_STORE, STRIPE, PROMOTIONAL or UNKNOWN_STORE.

val store: Store

unsubscribeDetectedAt

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

val unsubscribeDetectedAt: Date?

willRenew

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.

val willRenew: Boolean

Functions

hashCode

fun hashCode(): Int