RCEntitlementInfo

@interface RCEntitlementInfo : NSObject

/**
 The entitlement identifier configured in the RevenueCat dashboard
 */
@property (readonly) NSString *identifier;

/**
 True if the user has access to this entitlement
 */
@property (readonly) BOOL isActive;

/**
 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.
 */
@property (readonly) BOOL willRenew;

/**
 The last period type this entitlement was in
 Either: RCNormal, RCIntro, RCTrial
 */
@property (readonly) RCPeriodType periodType;

/**
 The latest purchase or renewal date for the entitlement.
 */
@property (readonly) NSDate *latestPurchaseDate;

/**
 The first date this entitlement was purchased
 */
@property (readonly) NSDate *originalPurchaseDate;

/**
 The expiration date for the entitlement, can be `nil` for lifetime access.
 If the `periodType` is `trial`, this is the trial expiration date.
 */
@property (readonly) NSDate * _Nullable expirationDate;

/**
 The store where this entitlement was unlocked from
 Either: RCAppStore, RCMacAppStore, RCPlayStore, RCStripe, RCPromotional, RCUnknownStore
 */
@property (readonly) RCStore store;

/**
 The product identifier that unlocked this entitlement
 */
@property (readonly) NSString *productIdentifier;

/**
 False if this entitlement is unlocked via a production purchase
 */
@property (readonly) BOOL isSandbox;

/**
 The date an unsubscribe was detected. Can be `nil`.
 
 Note: Entitlement may still be active even if user has unsubscribed. Check the `isActive` property.
 */
@property (readonly) NSDate * _Nullable unsubscribeDetectedAt;

/**
 The date a billing issue was detected. Can be `nil` 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.
 */
@property (readonly) NSDate * _Nullable billingIssueDetectedAt;

@end

Undocumented

  • The entitlement identifier configured in the RevenueCat dashboard

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull identifier;
  • True if the user has access to this entitlement

    Declaration

    Objective-C

    @property (readonly, atomic) BOOL isActive;
  • 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.

    Declaration

    Objective-C

    @property (readonly, atomic) BOOL willRenew;
  • The last period type this entitlement was in Either: RCNormal, RCIntro, RCTrial

    Declaration

    Objective-C

    @property (readonly, atomic) RCPeriodType periodType;
  • The latest purchase or renewal date for the entitlement.

    Declaration

    Objective-C

    @property (readonly, atomic) NSDate *_Nonnull latestPurchaseDate;
  • The first date this entitlement was purchased

    Declaration

    Objective-C

    @property (readonly, atomic) NSDate *_Nonnull originalPurchaseDate;
  • The expiration date for the entitlement, can be nil for lifetime access. If the periodType is trial, this is the trial expiration date.

    Declaration

    Objective-C

    @property (readonly, atomic) NSDate *_Nullable expirationDate;
  • The store where this entitlement was unlocked from Either: RCAppStore, RCMacAppStore, RCPlayStore, RCStripe, RCPromotional, RCUnknownStore

    Declaration

    Objective-C

    @property (readonly, atomic) RCStore store;
  • The product identifier that unlocked this entitlement

    Declaration

    Objective-C

    @property (readonly, atomic) NSString *_Nonnull productIdentifier;
  • False if this entitlement is unlocked via a production purchase

    Declaration

    Objective-C

    @property (readonly, atomic) BOOL isSandbox;
  • The date an unsubscribe was detected. Can be nil.

    Note: Entitlement may still be active even if user has unsubscribed. Check the isActive property.

    Declaration

    Objective-C

    @property (readonly, atomic) NSDate *_Nullable unsubscribeDetectedAt;
  • The date a billing issue was detected. Can be nil 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.

    Declaration

    Objective-C

    @property (readonly, atomic) NSDate *_Nullable billingIssueDetectedAt;