models/com.revenuecat.purchases.kmp.models/EntitlementInfo

EntitlementInfo

class EntitlementInfo(val identifier: String, val isActive: Boolean, val willRenew: Boolean, val periodType: PeriodType, val latestPurchaseDateMillis: Long?, val originalPurchaseDateMillis: Long?, val expirationDateMillis: Long?, val store: Store, val productIdentifier: String, val productPlanIdentifier: String?, val isSandbox: Boolean, val unsubscribeDetectedAtMillis: Long?, val billingIssueDetectedAtMillis: Long?, val ownershipType: OwnershipType, val verification: VerificationResult)

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

Constructors

EntitlementInfo

constructor(identifier: String, isActive: Boolean, willRenew: Boolean, periodType: PeriodType, latestPurchaseDateMillis: Long?, originalPurchaseDateMillis: Long?, expirationDateMillis: Long?, store: Store, productIdentifier: String, productPlanIdentifier: String?, isSandbox: Boolean, unsubscribeDetectedAtMillis: Long?, billingIssueDetectedAtMillis: Long?, ownershipType: OwnershipType, verification: VerificationResult)

Properties

billingIssueDetectedAtMillis

val billingIssueDetectedAtMillis: Long?

The date a billing issue was detected in millis since the Unix epoch. 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.

expirationDateMillis

val expirationDateMillis: Long?

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

identifier

val identifier: String

The entitlement identifier configured in the RevenueCat dashboard.

isActive

val isActive: Boolean

True if the user has access to this entitlement.

isSandbox

val isSandbox: Boolean

False if this entitlement is unlocked via a production purchase.

latestPurchaseDateMillis

val latestPurchaseDateMillis: Long?

Nullable on iOS only not on Android. The latest purchase or renewal date for the entitlement, in millis since the Unix epoch.

originalPurchaseDateMillis

val originalPurchaseDateMillis: Long?

Nullable on iOS only not on Android. The first date this entitlement was purchased in millis since the Unix epoch.

ownershipType

val ownershipType: OwnershipType

periodType

val periodType: PeriodType

The last period type this entitlement was in.

productIdentifier

val productIdentifier: String

The product identifier that unlocked this entitlement.

productPlanIdentifier

val productPlanIdentifier: String?

Play Store only. The base plan identifier that unlocked this entitlement.

store

val store: Store

The store where this entitlement was unlocked from.

unsubscribeDetectedAtMillis

val unsubscribeDetectedAtMillis: Long?

The date an unsubscribe was detected. Can be null.

verification

val verification: VerificationResult

If entitlement verification was enabled, the result of that verification. If not, VerificationResult.NOT_REQUESTED.

willRenew

val 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.