EntitlementInfo class

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

Annotations

• @freezed

Constructors

EntitlementInfo(@JsonKey(name: 'identifier') String identifier, @JsonKey(name: 'isActive') bool isActive, @JsonKey(name: 'willRenew') bool willRenew, @JsonKey(name: 'latestPurchaseDate') String latestPurchaseDate, @JsonKey(name: 'originalPurchaseDate') String originalPurchaseDate, @JsonKey(name: 'productIdentifier') String productIdentifier, @JsonKey(name: 'isSandbox') bool isSandbox, {@Default(OwnershipType.unknown) @JsonKey(name: 'ownershipType', unknownEnumValue: OwnershipType.unknown) OwnershipType ownershipType, @Default(Store.unknownStore) @JsonKey(name: 'store', unknownEnumValue: Store.unknownStore) Store store, @Default(PeriodType.unknown) @JsonKey(name: 'periodType', unknownEnumValue: PeriodType.unknown) PeriodType periodType, @JsonKey(name: 'expirationDate') String? expirationDate, @JsonKey(name: 'unsubscribeDetectedAt') String? unsubscribeDetectedAt, @JsonKey(name: 'billingIssueDetectedAt') String? billingIssueDetectedAt})

const

factory

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.

no setter, inherited

copyWith → $EntitlementInfoCopyWith<EntitlementInfo>

no setter, inherited

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.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

identifier → String

The entitlement identifier configured in the RevenueCat dashboard

no setter, inherited

isActive → bool

True if the user has access to this entitlement

no setter, inherited

isSandbox → bool

False if this entitlement is unlocked via a production purchase

no setter, inherited

latestPurchaseDate → String

The latest purchase or renewal date for the entitlement.

no setter, inherited

originalPurchaseDate → String

The first date this entitlement was purchased

no setter, inherited

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.

no setter, inherited

periodType → PeriodType

The last period type this entitlement was in

no setter, inherited

productIdentifier → String

The product identifier that unlocked this entitlement

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

store → Store

The store where this entitlement was unlocked from

no setter, inherited

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.

no setter, inherited

willRenew → bool

True if the underlying subscription is set to renew at the end of the billing period (expirationDate).

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited