RCEntitlementInfo


@interface RCEntitlementInfo : NSObject

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

Show on GitHub

  • The entitlement identifier configured in the RevenueCat dashboard

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull identifier;
    Show on GitHub

  • True if the user has access to this entitlement

    Declaration

    Objective-C

    @property (readonly) BOOL isActive;
    Show on GitHub

  • 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) BOOL willRenew;
    Show on GitHub

  • The last period type this entitlement was in Either: RCNormal, RCIntro, RCTrial

    Declaration

    Objective-C

    @property (readonly) RCPeriodType periodType;
    Show on GitHub

  • The latest purchase or renewal date for the entitlement.

    Declaration

    Objective-C

    @property (readonly) NSDate *_Nonnull latestPurchaseDate;
    Show on GitHub

  • The first date this entitlement was purchased

    Declaration

    Objective-C

    @property (readonly) NSDate *_Nonnull originalPurchaseDate;
    Show on GitHub

  • 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, nullable) NSDate *expirationDate;
    Show on GitHub

  • The store where this entitlement was unlocked from Either: RCAppStore, RCMacAppStore, RCPlayStore, RCStripe, RCPromotional, RCUnknownStore

    Declaration

    Objective-C

    @property (readonly) RCStore store;
    Show on GitHub

  • The product identifier that unlocked this entitlement

    Declaration

    Objective-C

    @property (readonly) NSString *_Nonnull productIdentifier;
    Show on GitHub

  • False if this entitlement is unlocked via a production purchase

    Declaration

    Objective-C

    @property (readonly) BOOL isSandbox;
    Show on GitHub

  • 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, nullable) NSDate *unsubscribeDetectedAt;
    Show on GitHub

  • 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, nullable) NSDate *billingIssueDetectedAt;
    Show on GitHub

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

    Declaration

    Objective-C

    @property (readonly) RCPurchaseOwnershipType ownershipType;
    Show on GitHub