Class

Purchases

Purchases is the main entry point of the RevenueCat SDK. It provides access to all its features.

Declaration

@objc(RCPurchases) class Purchases

Overview

The Purchases class can be used to access all the features of the RevenueCat SDK. Most features require configuring the SDK before using it.

Topics

Interacting with the SDK

static var shared: Purchases
Returns the already configured instance of Purchases.
static var isConfigured: Bool
Returns true if RevenueCat has already been initialized through configure(withAPIKey:) or one of is overloads.
var delegate: PurchasesDelegate?
Delegate for Purchases instance. The delegate is responsible for handling promotional product purchases and changes to customer information.
static var logLevel: LogLevel
Used to set the log level. Useful for debugging issues with the lovely team @RevenueCat.
static var logHandler: LogHandler
Set a custom log handler for redirecting logs to your own logging system.

Configuring the SDK

static func configure(withAPIKey: String) -> Purchases
Configures an instance of the Purchases SDK with a specified API key.
static func configure(withAPIKey: String, appUserID: String?) -> Purchases
Configures an instance of the Purchases SDK with a specified API key and app user ID.
static func configure(withAPIKey: String, appUserID: String?, observerMode: Bool) -> Purchases
Configures an instance of the Purchases SDK with a custom UserDefaults.
static func configure(withAPIKey: String, appUserID: String?, observerMode: Bool, userDefaults: UserDefaults?) -> Purchases
Configures an instance of the Purchases SDK with a custom UserDefaults.

Displaying Products

func offerings() async throws -> Offerings
Fetch the configured Offerings for this user.
func getOfferings(completion: (Offerings?, Error?) -> Void)
Fetch the configured Offerings for this user.
func products([String]) async -> [StoreProduct]
Fetches the StoreProducts for your IAPs for given productIdentifiers.
func getProducts([String], completion: ([StoreProduct]) -> Void)
Fetches the StoreProducts for your IAPs for given productIdentifiers.

Making Purchases

func purchase(package: Package) async throws -> PurchaseResultData
Initiates a purchase of a Package.
func purchase(package: Package, completion: PurchaseCompletedBlock)
Initiates a purchase of a Package.
func purchase(product: StoreProduct) async throws -> PurchaseResultData
Initiates a purchase of a StoreProduct.
func purchase(product: StoreProduct, completion: PurchaseCompletedBlock)
Initiates a purchase of a StoreProduct.
static var simulatesAskToBuyInSandbox: Bool
Set this property to true only when testing the ask-to-buy / SCA purchases flow. More information available here.
static func canMakePayments() -> Bool
Indicates whether the user is allowed to make payments. More information on when this might be false here

Making Purchases with Subscription Offers

func checkTrialOrIntroDiscountEligibility(productIdentifiers: [String]) async -> [String : IntroEligibility]
Computes whether or not a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether or not you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing). iOS Introductory Offers.
func checkTrialOrIntroDiscountEligibility(productIdentifiers: [String], completion: ([String : IntroEligibility]) -> Void)
Computes whether or not a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether or not you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing). iOS Introductory Offers.
func checkTrialOrIntroDiscountEligibility(product: StoreProduct) async -> IntroEligibilityStatus
Computes whether or not a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether or not you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing). iOS Introductory Offers.
func checkTrialOrIntroDiscountEligibility(product: StoreProduct, completion: (IntroEligibilityStatus) -> Void)
Computes whether or not a user is eligible for the introductory pricing period of a given product. You should use this method to determine whether or not you show the user the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing). iOS Introductory Offers.
func getPromotionalOffer(forProductDiscount: StoreProductDiscount, product: StoreProduct) async throws -> PromotionalOffer
Use this method to find eligibility for this user for iOS Promotional Offers.
func getPromotionalOffer(forProductDiscount: StoreProductDiscount, product: StoreProduct, completion: (PromotionalOffer?, Error?) -> Void)
Use this method to fetch PromotionalOffer to use in purchase(package:promotionalOffer:) or purchase(product:promotionalOffer:). iOS Promotional Offers.
func purchase(package: Package, promotionalOffer: PromotionalOffer) async throws -> PurchaseResultData
Purchase the passed Package. Call this method when a user has decided to purchase a product with an applied discount. Only call this in direct response to user input. From here Purchases will handle the purchase with StoreKit and call the PurchaseCompletedBlock.
func purchase(package: Package, promotionalOffer: PromotionalOffer, completion: PurchaseCompletedBlock)
Purchase the passed Package. Call this method when a user has decided to purchase a product with an applied discount. Only call this in direct response to user input. From here Purchases will handle the purchase with StoreKit and call the PurchaseCompletedBlock.
func purchase(product: StoreProduct, promotionalOffer: PromotionalOffer) async throws -> PurchaseResultData
Use this function if you are not using the Offerings system to purchase a StoreProduct with an applied PromotionalOffer. If you are using the Offerings system, use purchase(package:promotionalOffer:completion:) instead.
func purchase(product: StoreProduct, promotionalOffer: PromotionalOffer, completion: PurchaseCompletedBlock)
Initiates a purchase of a StoreProduct with a PromotionalOffer.

Subscription Status

func getCustomerInfo(completion: (CustomerInfo?, Error?) -> Void)
Get latest available customer info.
func customerInfo() async throws -> CustomerInfo
Get latest available customer info. Returns a value immediately if CustomerInfo is cached.
var customerInfoStream: AsyncStream<CustomerInfo>
Returns an AsyncStream of CustomerInfo changes, starting from the last known value.

Identifying Users

var appUserID: String
var isAnonymous: Bool
Returns true if the appUserID has been generated by RevenueCat, false otherwise.
func logIn(String) async throws -> (customerInfo: CustomerInfo, created: Bool)
This function will log in the current user with an appUserID.
func logIn(String, completion: (CustomerInfo?, Bool, Error?) -> Void)
This function will log in the current user with an appUserID.
func logOut() async throws -> CustomerInfo
Logs out the Purchases client, clearing the saved appUserID.
func logOut(completion: ((CustomerInfo?, Error?) -> Void)?)
Logs out the Purchases client, clearing the saved appUserID.

Managing Subscriptions

func syncPurchases() async throws -> CustomerInfo
This method will post all purchases associated with the current App Store account to RevenueCat and become associated with the current appUserID.
func syncPurchases(completion: ((CustomerInfo?, Error?) -> Void)?)
This method will post all purchases associated with the current App Store account to RevenueCat and become associated with the current appUserID.
func restorePurchases() async throws -> CustomerInfo
This method will post all purchases associated with the current App Store account to RevenueCat and become associated with the current appUserID. If the receipt is being used by an existing user, the current appUserID will be aliased together with the appUserID of the existing user. Going forward, either appUserID will be able to reference the same user.
func restorePurchases(completion: ((CustomerInfo?, Error?) -> Void)?)
This method will post all purchases associated with the current App Store account to RevenueCat and become associated with the current appUserID. If the receipt is being used by an existing user, the current appUserID will be aliased together with the appUserID of the existing user. Going forward, either appUserID will be able to reference the same user.
func showManageSubscriptions() async throws
Use this function to open the manage subscriptions modal.
func showManageSubscriptions(completion: (Error?) -> Void)
Use this function to open the manage subscriptions page.

Subscriber Attributes

func setAttributes([String : String])
Subscriber attributes are useful for storing additional, structured information on a user. Since attributes are writable using a public key they should not be used for managing secure or sensitive information such as subscription status, coins, etc.
func setAd(String?)
Subscriber attribute associated with the install ad for the user
func setEmail(String?)
Subscriber attribute associated with the email address for the user.
func setDisplayName(String?)
Subscriber attribute associated with the display name for the user.
func setKeyword(String?)
Subscriber attribute associated with the install keyword for the user
func setCampaign(String?)
Subscriber attribute associated with the install campaign for the user.
func setCreative(String?)
Subscriber attribute associated with the install ad creative for the user.
func setAdGroup(String?)
Subscriber attribute associated with the install ad group for the user
func setPushToken(Data?)
Subscriber attribute associated with the push token for the user.
func setMediaSource(String?)
Subscriber attribute associated with the install media source for the user.
func setPhoneNumber(String?)
Subscriber attribute associated with the phone number for the user.
func setAttributes([String : String])
Subscriber attributes are useful for storing additional, structured information on a user. Since attributes are writable using a public key they should not be used for managing secure or sensitive information such as subscription status, coins, etc.
func collectDeviceIdentifiers()
Automatically collect subscriber attributes associated with the device identifiers

Integrations

func setAdjustID(String?)
Subscriber attribute associated with the Adjust Id for the user. Required for the RevenueCat Adjust integration.
func setAppsflyerID(String?)
Subscriber attribute associated with the Appsflyer Id for the user. Required for the RevenueCat Appsflyer integration.
func setAirshipChannelID(String?)
Subscriber attribute associated with the Airship Channel ID for the user. Required for the RevenueCat Airship integration.
func setMparticleID(String?)
Subscriber attribute associated with the mParticle Id for the user. Recommended for the RevenueCat mParticle integration.
func setOnesignalID(String?)
Subscriber attribute associated with the OneSignal Player ID for the user. Required for the RevenueCat OneSignal integration.
func setFBAnonymousID(String?)
Subscriber attribute associated with the Facebook SDK Anonymous Id for the user. Recommended for the RevenueCat Facebook integration.

Advanced Configuration

var finishTransactions: Bool
Whether transactions should be finished automatically. true by default. * - Warning: Setting this value to false will prevent the SDK from finishing transactions. * In this case, you must finish transactions in your app, otherwise they will remain in the queue and * will turn up every time the app is opened. * More information on finishing transactions manually is available here.
func invalidateCustomerInfoCache()
Invalidates the cache for customer information.
static var forceUniversalAppStore: Bool
Set this property to true only if you’re transitioning an existing Mac app from the Legacy Mac App Store into the Universal Store, and you’ve configured your RevenueCat app accordingly. Contact RevenueCat support before using this.
static var automaticAppleSearchAdsAttributionCollection: Bool
Enable automatic collection of Apple Search Ads attribution. Defaults to false.
static var proxyURL: URL?
Set this property to your proxy URL before configuring Purchases only if you’ve received a proxy key value from your RevenueCat contact.
static var verboseLogs: Bool
Setting this to true adds additional information to the default log handler: Filename, line, and method data. You can also access that information for your own logging system by using verboseLogHandler.
static var verboseLogHandler: VerboseLogHandler
Set a custom log handler for redirecting logs to your own logging system.
var allowSharingAppStoreAccount: Bool
Deprecated
Deprecated

Classes

class PlatformInfo

Instance Methods

func checkTrialOrIntroDiscountEligibility([String]) async -> [String : IntroEligibility] Deprecated
func checkTrialOrIntroDiscountEligibility([String], completion: ([String : IntroEligibility]) -> Void) Deprecated
func getEligiblePromotionalOffers(forProduct: StoreProduct) async -> [PromotionalOffer]
Finds the subset of discounts that’s eligible for the current user.
func setCleverTapID(String?)
Subscriber attribute associated with the CleverTap ID for the user. Required for the RevenueCat CleverTap integration.

Type Properties

static var debugLogsEnabled: Bool
Enable debug logging. Useful for debugging issues with the lovely team @RevenueCat.
Deprecated
static var frameworkVersion: String
Current version of the Purchases framework.
static var platformInfo: Purchases.PlatformInfo?

Type Methods

static func addAttributionData([String : Any], from: AttributionNetwork, forNetworkUserId: String?)
Send your attribution data to RevenueCat so you can track the revenue generated by your different campaigns.
Deprecated
static func addAttributionData([String : Any], fromNetwork: AttributionNetwork)
Send your attribution data to RevenueCat so you can track the revenue generated by your different campaigns.
Deprecated
static func configure(withAPIKey: String, appUserID: String?, observerMode: Bool, userDefaults: UserDefaults?, useStoreKit2IfAvailable: Bool) -> Purchases
Configures an instance of the Purchases SDK with a custom userDefaults.
static func configure(withAPIKey: String, appUserID: String?, observerMode: Bool, userDefaults: UserDefaults?, useStoreKit2IfAvailable: Bool, dangerousSettings: DangerousSettings?) -> Purchases
Configures an instance of the Purchases SDK with a custom userDefaults.

Default Implementations

PurchasesOrchestratorDelegate Implementations

Relationships

Inherits From

    Conforms To

    • ObjectiveC.NSObjectProtocol
    • Swift.CVarArg
    • Swift.CustomDebugStringConvertible
    • Swift.CustomStringConvertible
    • Swift.Equatable
    • Swift.Hashable