EntitlementInfo class

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

Constructors

EntitlementInfo(String identifier, bool isActive, bool willRenew, String latestPurchaseDate, String originalPurchaseDate, String productIdentifier, bool isSandbox, {OwnershipType ownershipType = OwnershipType.unknown, Store store = Store.unknownStore, PeriodType periodType = PeriodType.unknown, String? expirationDate, String? unsubscribeDetectedAt, String? billingIssueDetectedAt, String? productPlanIdentifier, VerificationResult verification = VerificationResult.notRequested})
const
EntitlementInfo.fromJson(Map<String, dynamic> json)
factory

Properties

billingIssueDetectedAt → 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.
final
expirationDate → String?
The expiration date for the entitlement, can be null for lifetime access. If the periodType is PeriodType.trial, this is the trial expiration date.
final
hashCode → int
The hash code for this object.
no setterinherited
identifier → String
The entitlement identifier configured in the RevenueCat dashboard
final
isActive → bool
True if the user has access to this entitlement
final
isSandbox → bool
False if this entitlement is unlocked via a production purchase
final
latestPurchaseDate → String
The latest purchase or renewal date for the entitlement.
final
originalPurchaseDate → String
The first date this entitlement was purchased
final
ownershipType → 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.
final
periodType → PeriodType
The last period type this entitlement was in
final
productIdentifier → String
The product identifier that unlocked this entitlement
final
productPlanIdentifier → String?
The base plan identifier that unlocked this entitlement (Google only).
final
props → List<Object?>
The list of properties that will be used to determine whether two instances are equal.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
store → Store
The store where this entitlement was unlocked from
final
stringify → bool?
If set to true, the toString method will be overridden to output this instance's props.
no setterinherited
unsubscribeDetectedAt → String?
The date an unsubscribe was detected. Can be null if it's still subscribed or product is not a subscription. @note: Entitlement may still be active even if user has unsubscribed. Check the isActive property.
final
verification → VerificationResult
If entitlement verification was enabled, the result of that verification. If not, VerificationResult.NOT_REQUESTED.
final
willRenew → bool
True if the underlying subscription is set to renew at the end of the billing period (expirationDate).
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited