RevenueCat

https://revenuecat.github.io/purchases-ios-docs
Admin
RevenueCat is a powerful, reliable, and free in-app purchase server and open-source framework that...
Tokens:186,601
Snippets:2,063
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example: testSDKHealth() usage

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchasesdiagnostics

Swift example showing how to run the SDK health test using PurchasesDiagnostics.default and testSDKHealth().

```swift
let diagnostics = PurchasesDiagnostics.default
do {
    try await diagnostics.testSDKHealth()
} catch {
    print("Diagnostics failed: \(error.localizedDescription)")
}
```

--------------------------------

### init(withAPIKey:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/configuration/builder/init%28withapikey%3A%29

Initializes a new builder with the provided RevenueCat API key. Use this initializer to start configuring the RevenueCat SDK for your app.

```APIDOC
## init(withAPIKey:)

### Description
Creates a new builder with your RevenueCat API key.

### Declaration
```swift
@objc init(withAPIKey apiKey: String)
```

### Parameters
- **apiKey** (String) - Required - The API Key generated for your app from https://app.revenuecat.com/
```

--------------------------------

### setKeyword(_:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/attribution/setkeyword%28_%3A%29

Documentation for the setKeyword(_:) instance method, which sets the subscriber attribute for the install keyword.

```APIDOC
## setKeyword(_:)

### Description
Sets the subscriber attribute associated with the install keyword for the user. Passing an empty string or `nil` will delete the subscriber attribute.

### Declaration
```objc
@objc func setKeyword(_ keyword: String?)
```

### Parameters
- **keyword** (String?) - The install keyword to set as a subscriber attribute. Pass an empty string or `nil` to delete the attribute.
```

--------------------------------

### Configuring and Checking Entitlement Verification

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/verificationresult

Example showing how to configure the Purchases instance with entitlement verification mode and check the verification status of customer info.

```swift
let purchases = Purchases.configure(
  with: Configuration
    .builder(withAPIKey: "")
    .with(entitlementVerificationMode: .informational)
)


let customerInfo = try await purchases.customerInfo()
if !customerInfo.entitlements.verification.isVerified {
  print("Entitlements could not be verified")
}
```

--------------------------------

### Making a purchase with PurchaseParams

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchaseparams

Example of building PurchaseParams with metadata and a promotional offer, then passing it to Purchases.shared.purchase.

```swift
let params = PurchaseParams.Builder(package: package)
                           .with(metadata: ["key": "value"])
                           .with(promotionalOffer: promotionalOffer)
                           .build()
Purchases.shared.purchase(params)
```

--------------------------------

### Configure StoreKit version with Purchases.configure

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/cec_v5_api_migration_guide

Use this configuration to control the StoreKit version. The example sets .storeKit1, recommended for gradual rollout via remote configuration.

```swift
Purchases.configure(with: .builder(withAPIKey: apiKey)
  .with(storeKitVersion: .storeKit1)
  .build())
```

--------------------------------

### init(flavor: String, version: String)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/platforminfo-swift.class

Initializes a new PlatformInfo instance with the given flavor and version strings.

```APIDOC
## init(flavor: String, version: String)

### Description
Initializes a new PlatformInfo instance with the specified flavor and version.

### Declaration
`init(flavor: String, version: String)`

### Parameters
- **flavor** (String) - The platform flavor.
- **version** (String) - The platform version.

```

--------------------------------

### Example: Using a partial range with collection indices (numbers[...3])

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/loglevel/%27...%28_%3A%29-574e1

Uses the prefix closed range operator on a collection's indices to access elements from the start up to and including the given index. The print statement outputs the first four elements: [10, 20, 30, 40].

```swift
let numbers = [10, 20, 30, 40, 50, 60, 70]
print(numbers[...3])
// Prints "[10, 20, 30, 40]"
```

--------------------------------

### commitmentInstallmentPeriod

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/installmentsinfo/commitmentinstallmentperiod

Instance property that provides the duration for each installment of a commitment installment plan.

```APIDOC
## commitmentInstallmentPeriod

### Description
The duration for each installment.

### Declaration
```objc
@objc var commitmentInstallmentPeriod: SubscriptionPeriod { get }
```

### Return Value
- **SubscriptionPeriod** - The duration for each installment.
```

--------------------------------

### init(offeringIdentifier:placementIdentifier:targetingContext:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/presentedofferingcontext/init%28offeringidentifier%3Aplacementidentifier%3Atargetingcontext%3A%29

Initializes a PresentedOfferingContext with the given offering identifier, optional placement identifier, and optional targeting context.

```APIDOC
## init(offeringIdentifier:placementIdentifier:targetingContext:)

### Description
Initializes a `PresentedOfferingContext` with the specified offering identifier, placement identifier, and targeting context.

### Declaration

**macOS**
```objc
@objc init(
    offeringIdentifier: String,
    placementIdentifier: String?,
    targetingContext: PresentedOfferingContext.TargetingContext?
)
```

**iOS**
```objc
@objc init(
    offeringIdentifier: String,
    placementIdentifier: String?,
    targetingContext: TargetingContext?
)
```

### Parameters
- **offeringIdentifier** (String) - Required - The identifier of the offering.
- **placementIdentifier** (String?) - Optional - The identifier of the placement.
- **targetingContext** (PresentedOfferingContext.TargetingContext? or TargetingContext?) - Optional - The targeting context associated with the offering.
```

--------------------------------

### init(localizedTitle:price:localizedPriceString:productIdentifier:productType:localizedDescription:subscriptionGroupIdentifier:subscriptionPeriod:isFamilyShareable:introductoryDiscount:discounts:locale:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/teststoreproduct/init%28localizedtitle%3Aprice%3Alocalizedpricestring%3Aproductidentifier%3Aproducttype%3Alocalizeddescription%3Asubscriptiongroupidentifier%3Asubscriptionperiod%3Aisfamilyshareable%3Aintroductorydiscount%3Adiscounts%3Alocale%3A%29

Creates a TestStoreProduct instance with the given parameters. Use this initializer to define a test product for StoreKit testing.

```APIDOC
## Initializer: init(localizedTitle:price:localizedPriceString:productIdentifier:productType:localizedDescription:subscriptionGroupIdentifier:subscriptionPeriod:isFamilyShareable:introductoryDiscount:discounts:locale:)

### Description
Creates a TestStoreProduct instance with the specified properties. This initializer is used to construct a test product for StoreKit testing.

### Declaration
```swift
init(
    localizedTitle: String,
    price: Decimal,
    localizedPriceString: String,
    productIdentifier: String,
    productType: StoreProduct.ProductType,
    localizedDescription: String,
    subscriptionGroupIdentifier: String? = nil,
    subscriptionPeriod: SubscriptionPeriod? = nil,
    isFamilyShareable: Bool = false,
    introductoryDiscount: TestStoreProductDiscount? = nil,
    discounts: [TestStoreProductDiscount] = [],
    locale: Locale = .current
)
```

### Parameters
- **localizedTitle** (String) - Required - The localized title of the product.
- **price** (Decimal) - Required - The price of the product.
- **localizedPriceString** (String) - Required - The localized price string.
- **productIdentifier** (String) - Required - The unique identifier of the product.
- **productType** (StoreProduct.ProductType) - Required - The type of the product (e.g., consumable, non-consumable, subscription).
- **localizedDescription** (String) - Required - The localized description of the product.
- **subscriptionGroupIdentifier** (String?) - Optional - The subscription group identifier, defaults to nil.
- **subscriptionPeriod** (SubscriptionPeriod?) - Optional - The subscription period, defaults to nil.
- **isFamilyShareable** (Bool) - Optional - Whether the product is family shareable, defaults to false.
- **introductoryDiscount** (TestStoreProductDiscount?) - Optional - The introductory discount, defaults to nil.
- **discounts** ([TestStoreProductDiscount]) - Optional - An array of discounts, defaults to empty array.
- **locale** (Locale) - Optional - The locale, defaults to .current.

### Return Value
An initialized TestStoreProduct instance.

### Example
```swift
let product = TestStoreProduct(
    localizedTitle: "Premium",
    price: 9.99,
    localizedPriceString: "$9.99",
    productIdentifier: "com.example.premium",
    productType: .subscription,
    localizedDescription: "Premium subscription",
    subscriptionGroupIdentifier: "group1",
    subscriptionPeriod: SubscriptionPeriod(value: 1, unit: .month),
    isFamilyShareable: true,
    introductoryDiscount: TestStoreProductDiscount(...),
    discounts: [],
    locale: Locale(identifier: "en_US")
)
```
```

--------------------------------

### Example: Creating a PartialRangeThrough with ...5.0

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/loglevel/%27...%28_%3A%29-574e1

Creates a partial range up to and including the upper bound, here 5.0. The example then checks membership with contains(_:), showing 4.0 and 5.0 are included and 6.0 is not.

```swift
let throughFive = ...5.0


throughFive.contains(4.0)     // true
throughFive.contains(5.0)     // true
throughFive.contains(6.0)     // false
```

--------------------------------

### getOfferings(completion:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchasestype/getofferings%28completion%3A%29

Fetch the configured Offerings for this user. This method is required and allows you to configure your in-app products via RevenueCat and greatly simplifies management. Offerings will be fetched and cached on instantiation so that, by the time they are needed, your prices are loaded for your purchase flow.

```APIDOC
## getOfferings(completion:)

### Description
Fetch the configured `Offerings` for this user. This method is required and allows you to configure your in-app products via RevenueCat and greatly simplifies management. `Offerings` will be fetched and cached on instantiation so that, by the time they are needed, your prices are loaded for your purchase flow.

### Declaration

**iOS**
```swift
func getOfferings(completion: @escaping ((Offerings?, PublicError?) -> Void))
```

**macOS**
```swift
func getOfferings(completion: @escaping ((Offerings?, PublicError?) -> Void))
```

### Parameters
- `completion` - A completion block called when offerings are available. Called immediately if offerings are cached. `Offerings` will be `nil` if an error occurred.
```

--------------------------------

### commitmentInstallmentsCount

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/installmentsinfo/commitmentinstallmentscount

Number of installments the customer commits to paying.

```APIDOC
## commitmentInstallmentsCount

### Description
Number of installments the customer commits to paying.

### Declaration
```
@objc var commitmentInstallmentsCount: Int { get }
```

```

--------------------------------

### billingPlanType

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/installmentsinfo/billingplantype

Returns the billing plan used for the installments.

```APIDOC
## billingPlanType

### Description
Returns the billing plan used for the installments.

### Declaration
```swift
@objc var billingPlanType: BillingPlanType { get }
```
```

--------------------------------

### init(offeringIdentifier: String)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/presentedofferingcontext

Initialize a PresentedOfferingContext with an offering identifier.

```APIDOC
## init(offeringIdentifier: String)

### Description
Initializes a PresentedOfferingContext with the given offering identifier.

### Declaration
`init(offeringIdentifier: String)`

### Parameters
- **offeringIdentifier** (String) - The identifier of the Offering containing this Package.

```

--------------------------------

### customerInfo()

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/customerinfo%28%29

Get latest available customer info.

```APIDOC
## customerInfo()

### Description
Get latest available customer info.

### Declaration
```swift
func customerInfo() async throws -> CustomerInfo
```

### Related Symbols
- `customerInfo(fetchPolicy:)`
- `customerInfoStream`
```

--------------------------------

### init(localizedTitle:price:currencyCode:localizedPriceString:productIdentifier:productType:localizedDescription:subscriptionGroupIdentifier:subscriptionPeriod:isFamilyShareable:introductoryDiscount:discounts:locale:installmentsInfo:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/teststoreproduct/init%28localizedtitle%3Aprice%3Acurrencycode%3Alocalizedpricestring%3Aproductidentifier%3Aproducttype%3Alocalizeddescription%3Asubscriptiongroupidentifier%3Asubscriptionperiod%3Aisfamilyshareable%3Aintroductorydiscount%3Adiscounts%3Alocale%3Ainstallmentsinfo%3A%29

Initializes a new TestStoreProduct with the specified properties. This initializer allows you to create a test product for use in testing scenarios.

```APIDOC
## init(localizedTitle:price:currencyCode:localizedPriceString:productIdentifier:productType:localizedDescription:subscriptionGroupIdentifier:subscriptionPeriod:isFamilyShareable:introductoryDiscount:discounts:locale:installmentsInfo:)

### Description
Creates a new `TestStoreProduct` with the specified properties.

### Declaration
```swift
init(
    localizedTitle: String,
    price: Decimal,
    currencyCode: String,
    localizedPriceString: String,
    productIdentifier: String,
    productType: StoreProduct.ProductType,
    localizedDescription: String,
    subscriptionGroupIdentifier: String? = nil,
    subscriptionPeriod: SubscriptionPeriod? = nil,
    isFamilyShareable: Bool = false,
    introductoryDiscount: TestStoreProductDiscount? = nil,
    discounts: [TestStoreProductDiscount] = [],
    locale: Locale,
    installmentsInfo: InstallmentsInfo? = nil
)
```

### Parameters
- **localizedTitle** (String) - Required - The localized title of the product
- **price** (Decimal) - Required - The price of the product
- **currencyCode** (String) - Required - The currency code (e.g., "USD", "EUR")
- **localizedPriceString** (String) - Required - The localized price string (e.g., "$3.99")
- **productIdentifier** (String) - Required - The product identifier
- **productType** (StoreProduct.ProductType) - Required - The type of product
- **localizedDescription** (String) - Required - The localized description
- **subscriptionGroupIdentifier** (String?) - Optional - Optional subscription group identifier
- **subscriptionPeriod** (SubscriptionPeriod?) - Optional - Optional subscription period
- **isFamilyShareable** (Bool) - Optional - Whether the product is family shareable (default: false)
- **introductoryDiscount** (TestStoreProductDiscount?) - Optional - Optional introductory discount
- **discounts** ([TestStoreProductDiscount]) - Optional - Array of discounts (default: [])
- **locale** (Locale) - Required - The locale that should be used when formatting prices. It is important that this matches with the price strings passed (e.g., localizedPriceString)
- **installmentsInfo** (InstallmentsInfo?) - Optional - Optional installments info
```

--------------------------------

### init(product:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchaseparams/builder/init%28product%3A%29

Initializes a new PurchaseParams builder with a StoreProduct for direct purchase.

```APIDOC
## init(product:)

### Description
Creates a new builder with a `StoreProduct` for purchasing when not using the `Offerings` system.

### Declaration
```objc
@objc init(product: StoreProduct)
```

### Parameters
- **product** (StoreProduct) - The `StoreProduct` the user intends to purchase.

### Discussion
Use this initializer if you are not using the `Offerings` system to purchase a `StoreProduct`. If you are using the `Offerings` system, use `init(package:)` instead.
```

--------------------------------

### packages

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/paywalldata/configuration/packages

Gets or sets the list of package identifiers that this paywall will display.

```APIDOC
## packages

### Description
Gets or sets the list of package identifiers that this paywall will display.

### Declaration
```swift
var packages: [String] { get set }
```

```

--------------------------------

### PurchaseParams

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchaseparams

Documentation for the PurchaseParams class, including its declaration, usage example, and relationships.

```APIDOC
## PurchaseParams

### Description
`PurchaseParams` is a class that can be used to add configuration options when making a purchase. It follows the builder pattern.

### Declaration
```
@objc(RCPurchaseParams) final class PurchaseParams
```

### Overview
Example making a purchase using `PurchaseParams`:
```
let params = PurchaseParams.Builder(package: package)
                           .with(metadata: ["key": "value"])
                           .with(promotionalOffer: promotionalOffer)
                           .build()
Purchases.shared.purchase(params)
```

### Topics
- `class Builder` - The Builder for `PurchaseParams`.

### Relationships
- Inherits From: `ObjectiveC.NSObject`
- Conforms To: `ObjectiveC.NSObjectProtocol`, `Swift.CVarArg`, `Swift.CustomDebugStringConvertible`, `Swift.CustomStringConvertible`, `Swift.Equatable`, `Swift.Hashable`, `Swift.Sendable`
```

--------------------------------

### beginRefundRequest(forProduct:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchasestype/beginrefundrequest%28forproduct%3A%29

Documentation for the beginRefundRequest(forProduct:) instance method.

```APIDOC
## beginRefundRequest(forProduct:)

### Description
Presents a refund request sheet in the current window scene for the latest transaction associated with the `productID`.

### Declaration
```swift
@objc(beginRefundRequestForProduct:completion:) func beginRefundRequest(forProduct productID: String) async throws -> RefundRequestStatus
```

### Parameters
- **productID** (String) - The `productID` to begin a refund request for. If the request was successful, there will be a `RefundRequestStatus`. Keep in mind the status could be `RefundRequestStatus.userCancelled`.

### Return Value
- **RefundRequestStatus** - The status of the refund request. If the request was unsuccessful, there will be an `Error` and `RefundRequestStatus.error`.

### Discussion
Throws an error if the request was unsuccessful.
```

--------------------------------

### Create and use Configuration with builder pattern

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/configuration

Shows how to build a `Configuration` object with the builder, set properties like app user ID, user defaults, and timeouts, then pass it to `Purchases.configure(with:)`.

```swift
let configuration = Configuration.Builder(withAPIKey: "MyKey")
                                .with(appUserID: "SomeAppUserID")
                                .with(userDefaults: myUserDefaults)
                                .with(networkTimeout: 15)
                                .with(storeKit1Timeout: 15)
                                .build()
 Purchases.configure(with: configuration)
```

--------------------------------

### var offeringIdentifier: String { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/package/offeringidentifier

Returns the identifier of the Offering containing this Package.

```APIDOC
## var offeringIdentifier: String { get }

### Description
Returns the identifier of the `Offering` containing this `Package`.

### Declaration
```swift
var offeringIdentifier: String { get }
```

### Return Value
The identifier of the `Offering` containing this `Package`.
```

--------------------------------

### init(paywallId:offering:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/custompaywallimpressionparams/init%28paywallid%3Aoffering%3A%29

Initializer for creating custom paywall impression parameters from an offering.

```APIDOC
## init(paywallId:offering:)

### Description
Creates parameters for a custom paywall impression from the offering it was obtained from. Use this initializer when presenting a paywall for an offering that is not the current offering (for example, a placement-resolved offering). The SDK will derive both the offering identifier and the presented offering context (placement and targeting information) from the provided offering.

### Declaration
```swift
@objc convenience init(
    paywallId: String? = nil,
    offering: Offering
)
```

### Parameters
- **paywallId** (String?) - Optional - An optional identifier for the custom paywall being shown.
- **offering** (Offering) - Required - The offering associated with the custom paywall.
```

--------------------------------

### purchaseDate

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/subscriptioninfo/purchasedate

A read-only property that provides the date when the last subscription period started.

```APIDOC
## purchaseDate

### Description
Date when the last subscription period started.

### Declaration
swift
@objc let purchaseDate: Date


### Property
- **purchaseDate** (Date) - Read-only. The date when the last subscription period started.
```

--------------------------------

### Configure Purchases with Configuration.Builder

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/configure%28with%3A%29-6oipy

Example usage of configure(with:). It builds a Configuration using Configuration.Builder, setting the API key, the purchasesAreCompletedBy option to .revenueCat, and an optional appUserID. The resulting Purchases instance is set as a singleton and can be accessed via shared.

```swift
 Purchases.configure(
     with: Configuration.Builder(withAPIKey: Constants.apiKey)
              .with(purchasesAreCompletedBy: .revenueCat)
              .with(appUserID: "<app_user_id>")
              .build()
     )
```

--------------------------------

### init(identifier:packageType:storeProduct:presentedOfferingContext:webCheckoutUrl:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/package/init%28identifier%3Apackagetype%3Astoreproduct%3Apresentedofferingcontext%3Awebcheckouturl%3A%29

Initializes a Package object with the specified properties.

```APIDOC
## init(identifier:packageType:storeProduct:presentedOfferingContext:webCheckoutUrl:)

### Description
Initializes a `Package` object with the given identifier, package type, store product, presented offering context, and optional web checkout URL.

### Declaration
```swift
@objc init(
    identifier: String,
    packageType: PackageType,
    storeProduct: StoreProduct,
    presentedOfferingContext: PresentedOfferingContext,
    webCheckoutUrl: URL?
)
```

### Parameters
- **identifier** (String) - The identifier of the package.
- **packageType** (PackageType) - The type of the package.
- **storeProduct** (StoreProduct) - The store product associated with the package.
- **presentedOfferingContext** (PresentedOfferingContext) - The context in which the offering was presented.
- **webCheckoutUrl** (URL?) - An optional URL for web checkout.
```

--------------------------------

### StartPurchaseBlock

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/startpurchaseblock

Type alias for a block that starts a purchase. It accepts a PurchaseCompletedBlock and returns Void.

```APIDOC
## StartPurchaseBlock

### Description
Type alias for a block that starts a purchase in the RevenueCat Purchases SDK. It is used in the `purchases(_:readyForPromotedProduct:purchase:)` delegate method.

### Declaration

**iOS**
```swift
typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
```

**macOS**
```swift
typealias StartPurchaseBlock = (@escaping PurchaseCompletedBlock) -> Void
```

### Parameters
- **PurchaseCompletedBlock** (closure) - Required - A completion block that is called when the purchase completes.

### Return Value
Void
```

--------------------------------

### commitmentTotalPrice

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/installmentsinfo/commitmenttotalprice

Read-only property that returns the total price the customer commits to paying across all installments.

```APIDOC
## commitmentTotalPrice

### Description
Total price the customer commits to paying across all installments.

### Declaration
```objc
@objc var commitmentTotalPrice: Decimal { get }
```

### Return Value
- **Decimal** - The total commitment price across all installments.
```

--------------------------------

### init(offeringId: String)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/exitoffer

Creates an exit offer with the specified offering identifier.

```APIDOC
## init(offeringId: String)

### Description
Creates an exit offer with the specified offering identifier.

### Declaration
```swift
init(offeringId: String)
```

### Parameters
- **offeringId** (String) - The identifier of the offering to show as an exit offer.

### Return Value
An ExitOffer instance.
```

--------------------------------

### InstallmentsInfo

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/installmentsinfo

Class representing information about the installments that a subscriber will pay across multiple billing periods.

```APIDOC
## InstallmentsInfo

### Description
Information about the installments that a subscriber will pay across multiple billing periods.

### Declaration
```
@objc(RCInstallmentsInfo) final class InstallmentsInfo
```

### Initializers

#### init(commitmentInstallmentsCount:commitmentInstallmentPeriod:installmentBillingPrice:installmentBillingDisplayPrice:commitmentTotalPeriod:commitmentTotalPrice:commitmentTotalDisplayPrice:billingPlanType:)
Creates a new `InstallmentsInfo`.

### Instance Properties

- `var billingPlanType: BillingPlanType` - The billing plan used for the installments.
- `var commitmentInstallmentPeriod: SubscriptionPeriod` - The duration for each installment.
- `var commitmentInstallmentsCount: Int` - Number of installments the customer commits to paying.
- `var commitmentTotalDisplayPrice: String` - Localized display price for `commitmentTotalPrice`.
- `var commitmentTotalPeriod: SubscriptionPeriod` - Total duration of the customer’s installment commitment.
- `var commitmentTotalPrice: Decimal` - Total price the customer commits to paying across all installments.
- `var hash: Int` - Hash value.
- `var installmentBillingDisplayPrice: String` - Localized display price for `installmentBillingPrice`.
- `var installmentBillingPrice: Decimal` - Price charged for each installment billing period.

### Instance Methods

- `func isEqual(Any?) -> Bool` - Returns a Boolean value indicating whether two values are equal.

### Relationships

- Inherits From: `ObjectiveC.NSObject`
- Conforms To: `ObjectiveC.NSObjectProtocol`, `Swift.CVarArg`, `Swift.CustomDebugStringConvertible`, `Swift.CustomStringConvertible`, `Swift.Equatable`, `Swift.Hashable`, `Swift.Sendable`
```

--------------------------------

### init(currency:amount:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/productpaidprice/init%28currency%3Aamount%3A%29

Initializer for ProductPaidPrice that takes a currency string and an amount double.

```APIDOC
## init(currency:amount:)

### Description
Initializes a ProductPaidPrice object with the given currency and amount, maintaining backward compatibility.

### Declaration
```swift
convenience init(
    currency: String,
    amount: Double
)
```

### Parameters
- **currency** (String) - The currency paid.
- **amount** (Double) - The amount paid.
```

--------------------------------

### configure(with:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/configure%28with%3A%29-6oipy

Configures an instance of the Purchases SDK with a specified Configuration object. The instance is set as a singleton and can be accessed via the shared property.

```APIDOC
## configure(with:)

### Description
Configures an instance of the Purchases SDK with a specified `Configuration` object. The instance is set as a singleton and can be accessed via the `shared` property.

### Declaration
```swift
@discardableResult @objc(configureWithConfiguration:) static func configure(with configuration: Configuration) -> Purchases
```

### Parameters
- **configuration** (Configuration) - Required - The `Configuration` object you wish to use to configure `Purchases`.

### Return Value
An instantiated `Purchases` object that has been set as a singleton.

### Discussion
The instance will be set as a singleton. You should access the singleton instance using `shared`. See `Configuration.Builder` for more information about configurable properties.

### Example
```swift
Purchases.configure(
    with: Configuration.Builder(withAPIKey: Constants.apiKey)
             .with(purchasesAreCompletedBy: .revenueCat)
             .with(appUserID: "<app_user_id>")
             .build()
)
```

### See Also
- `static func configure(withAPIKey: String) -> Purchases` - Configures an instance of the Purchases SDK with a specified API key.
- `class PurchasesDiagnostics` - Allows you to ensure that the SDK is set up correctly by diagnosing configuration errors. To run the test, simply call `testSDKHealth()`.
```

--------------------------------

### commitmentTotalPeriod

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/installmentsinfo/commitmenttotalperiod

Instance property that returns the total duration of the customer's installment commitment as a SubscriptionPeriod.

```APIDOC
## commitmentTotalPeriod

### Description
Total duration of the customer's installment commitment.

### Declaration
```objc
@objc var commitmentTotalPeriod: SubscriptionPeriod { get }
```

### Return Value
- **SubscriptionPeriod** - The total duration of the installment commitment.
```

--------------------------------

### getOfferings(completion: (Offerings?, PublicError?) -> Void)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat

Fetch the configured `Offerings` for this user.

```APIDOC
## [FUNCTION] getOfferings(completion: (Offerings?, PublicError?) -> Void)

### Description
Fetch the configured `Offerings` for this user.

### Method
func

### Endpoint
getOfferings(completion: (Offerings?, PublicError?) -> Void)

### Parameters
#### Parameters
- **completion** (closure) - Required - A completion block that receives the offerings and an optional error.

### Response
#### Success Response
- **Offerings** - The configured offerings for the user.

#### Error Response
- **PublicError** - An error if the fetch fails.

```

--------------------------------

### BillingPlanType.monthly

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/billingplantype/monthly

A static property representing the monthly billing plan, where the user pays in monthly installments.

```APIDOC
## BillingPlanType.monthly

### Description
Monthly billing plan, where the user pays in monthly installments.

### Declaration
```swift
@objc(RCMonthly) static let monthly: BillingPlanType
```

```

--------------------------------

### Set email using attribution

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/attribution

Example of using the `attribution` property to set a subscriber email.

```swift
Purchases.shared.attribution.setEmail(“nobody@example.com”)
```

--------------------------------

### init(identifier:packageType:storeProduct:offeringIdentifier:webCheckoutUrl:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/package/init%28identifier%3Apackagetype%3Astoreproduct%3Aofferingidentifier%3Awebcheckouturl%3A%29

Initializes a Package object with the specified identifier, package type, store product, offering identifier, and optional web checkout URL.

```APIDOC
## init(identifier:packageType:storeProduct:offeringIdentifier:webCheckoutUrl:)

### Description
Initializes a `Package` object with the specified identifier, package type, store product, offering identifier, and optional web checkout URL.

### Declaration
```swift
@objc convenience init(
    identifier: String,
    packageType: PackageType,
    storeProduct: StoreProduct,
    offeringIdentifier: String,
    webCheckoutUrl: URL?
)
```

### Parameters
- **identifier** (String) - Required - The identifier of the package.
- **packageType** (PackageType) - Required - The type of the package.
- **storeProduct** (StoreProduct) - Required - The store product associated with the package.
- **offeringIdentifier** (String) - Required - The identifier of the offering that contains this package.
- **webCheckoutUrl** (URL?) - Optional - The URL for web checkout, if applicable.
```

--------------------------------

### configure(withAPIKey:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/configure%28withapikey%3A%29

Configures an instance of the Purchases SDK with a specified API key. The instance is set as a singleton, accessible via `shared`.

```APIDOC
## configure(withAPIKey:)

### Description
Configures an instance of the Purchases SDK with a specified API key. The instance will be set as a singleton, accessible via `shared`.

### Method
`static func configure(withAPIKey apiKey: String) -> Purchases`

### Parameters
- **apiKey** (String) - Required - The API Key generated for your app from https://app.revenuecat.com/

### Return Value
An instantiated `Purchases` object that has been set as a singleton.

### Discussion
Use this initializer if your app does not have an account system. `Purchases` will generate a unique identifier for the current device and persist it to `NSUserDefaults`. This also affects the behavior of `restorePurchases(completion:)`.

### See Also
- `static func configure(with: Configuration) -> Purchases` - Configures an instance of the Purchases SDK with a specified `Configuration`.
- `class PurchasesDiagnostics` - `PurchasesDiagnostics` allows you to ensure that the SDK is set up correctly by diagnosing configuration errors. To run the test, simply call `testSDKHealth()`.
```

--------------------------------

### init(light:dark:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/paywalldata/configuration/colorinformation

Initializes a ColorInformation instance with light and optional dark color sets.

```APIDOC
## init(light:dark:)

### Description
Initializes a `ColorInformation` instance with the provided light and optional dark color sets.

### Declaration
```swift
init(light: PaywallData.Configuration.Colors, dark: PaywallData.Configuration.Colors?)
```

### Parameters
- **light** (PaywallData.Configuration.Colors) - Required - The set of colors for the light color scheme.
- **dark** (PaywallData.Configuration.Colors?) - Optional - The set of colors for the dark color scheme.
```

--------------------------------

### var helpAnchor: String? { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchasesreceiptparser/error/helpanchor

A read-only property that returns an optional localized help message.

```APIDOC
## Property: helpAnchor

### Description
A localized message providing "help" text if the user requests help.

### Declaration
```swift
var helpAnchor: String? { get }
```

### Parameters
None

### Return Value
- **String?** - An optional localized help message.

### Discussion
This property is read-only and provides a help anchor string that can be used to display help text to the user.
```

--------------------------------

### Create TestStoreProduct and Offering

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/teststoreproduct

Creates a TestStoreProduct and an Offering that uses it. The product is configured with a monthly auto-renewable subscription, and the offering includes a monthly package that references the product via toStoreProduct().

```swift
let product = TestStoreProduct(
    localizedTitle: "PRO monthly",
    price: 3.99,
    localizedPriceString: "$3.99",
    productIdentifier: "com.revenuecat.product",
    productType: .autoRenewableSubscription,
    localizedDescription: "Description",
    subscriptionGroupIdentifier: "group",
    subscriptionPeriod: .init(value: 1, unit: .month)
)


let offering = Offering(
    identifier: "offering",
    serverDescription: "Main offering",
    metadata: [:],
    availablePackages: [
        .init(
            identifier: "monthly",
            packageType: .monthly,
            storeProduct: product.toStoreProduct(),
            offeringIdentifier: offering
        ),
    ]
)
```

--------------------------------

### var recoverySuggestion: String? { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchasesreceiptparser/error/recoverysuggestion

A localized message describing how one might recover from the failure.

```APIDOC
## Property: recoverySuggestion

### Description
A localized message describing how one might recover from the failure.

### Declaration
```swift
var recoverySuggestion: String? { get }
```

### Parameters
None

### Return Value
A localized message describing how one might recover from the failure.
```

--------------------------------

### override var description: String { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/storeproductdiscount/description

An overridden property that provides a textual description of the StoreProductDiscount instance.

```APIDOC
## Property: description

### Description
An overridden property that returns a string representation of the StoreProductDiscount.

### Declaration
```swift
override var description: String { get }
```

### Parameters
None

### Return Value
A string describing the StoreProductDiscount instance.

### Example
```swift
let discount = StoreProductDiscount(...)
print(discount.description)
```
```

--------------------------------

### var appUserID: String { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/appuserid

The appUserID used by Purchases. If not passed on initialization this will be generated and cached by Purchases.

```APIDOC
## appUserID

### Description
The `appUserID` used by `Purchases`. If not passed on initialization this will be generated and cached by `Purchases`.

### Declaration
```swift
var appUserID: String { get }
```

### Return Value
- **appUserID** (String) - The app user ID string.

### See Also
- `var isAnonymous: Bool` - The `appUserID` used by `Purchases`. If not passed on initialization this will be generated and cached by `Purchases`.
- `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, PublicError?) -> 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?, PublicError?) -> Void)?)` - Logs out the `Purchases` client, clearing the saved `appUserID`.

```

--------------------------------

### init(package:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchaseparams/builder/init%28package%3A%29

Initializer for creating a PurchaseParams builder with a Package.

```APIDOC
## init(package:)

### Description
Creates a new builder with a `Package`.

### Declaration
```objc
@objc init(package: Package)
```

### Parameters
- **package** (Package) - The `Package` the user intends to purchase.
```

--------------------------------

### var localizedConfigurationByTier: [String : PaywallData.LocalizedConfiguration]? { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/paywalldata/localizedconfigurationbytier

Returns the `PaywallData.LocalizedConfiguration` to be used based on `Locale.preferredLocales` or the default locale.

```APIDOC
## Property: localizedConfigurationByTier

### Description
Returns the `PaywallData.LocalizedConfiguration` to be used based on `Locale.preferredLocales` or the default locale.

### Declaration
**macOS**
```swift
var localizedConfigurationByTier: [String : PaywallData.LocalizedConfiguration]? { get }
```

**iOS**
```swift
var localizedConfigurationByTier: [String : LocalizedConfiguration]? { get }
```

### Return Value
The `PaywallData.LocalizedConfiguration` to be used based on `Locale.preferredLocales` or the default locale.
```

--------------------------------

### init(id:templateName:config:localizationByTier:assetBaseURL:revision:locale:zeroDecimalPlaceCountries:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/paywalldata/init%28id%3Atemplatename%3Aconfig%3Alocalizationbytier%3Aassetbaseurl%3Arevision%3Alocale%3Azerodecimalplacecountries%3A%29

Initializer for creating a test multi-tier PaywallData with a single localization.

```APIDOC
## init(id:templateName:config:localizationByTier:assetBaseURL:revision:locale:zeroDecimalPlaceCountries:)

### Description
Creates a test multi-tier `PaywallData` with a single localization.

### Declaration
**iOS**
```swift
init(
    id: String? = nil,
    templateName: String,
    config: Configuration,
    localizationByTier: [String : LocalizedConfiguration],
    assetBaseURL: URL,
    revision: Int = 0,
    locale: Locale = .current,
    zeroDecimalPlaceCountries: [String] = []
)
```

**macOS**
```swift
init(
    id: String? = nil,
    templateName: String,
    config: PaywallData.Configuration,
    localizationByTier: [String : PaywallData.LocalizedConfiguration],
    assetBaseURL: URL,
    revision: Int = 0,
    locale: Locale = .current,
    zeroDecimalPlaceCountries: [String] = []
)
```

### Parameters
- **id** (String?) - Optional - The identifier for the paywall.
- **templateName** (String) - Required - The name of the template.
- **config** (Configuration) - Required - The configuration for the paywall.
- **localizationByTier** ([String : LocalizedConfiguration]) - Required - A dictionary mapping tiers to their localized configurations.
- **assetBaseURL** (URL) - Required - The base URL for assets.
- **revision** (Int) - Optional - The revision number, defaults to 0.
- **locale** (Locale) - Optional - The locale, defaults to `.current`.
- **zeroDecimalPlaceCountries** ([String]) - Optional - An array of countries that use zero decimal places, defaults to empty array.
```

--------------------------------

### var subtitle: String? { get set }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/paywalldata/localizedconfiguration-swift.struct/subtitle

The subtitle of the paywall screen. This property is a read-write optional string.

```APIDOC
## Property: subtitle

### Description
The subtitle of the paywall screen.

### Declaration
```swift
var subtitle: String? { get set }
```

### Parameters
- **subtitle** (String?) - Optional - The subtitle of the paywall screen.

### Return Value
- **String?** - The subtitle of the paywall screen, or nil if not set.
```

--------------------------------

### var hasPaywall: Bool { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/offering/haspaywall

A read-only Boolean property that indicates whether the offering contains a paywall.

```APIDOC
## var hasPaywall: Bool { get }

### Description
Whether the offering contains a paywall.

### Declaration
```swift
var hasPaywall: Bool { get }
```

### Properties
- **hasPaywall** (Bool) - Read-only - Indicates whether the offering contains a paywall.
```

--------------------------------

### PresentedOfferingContext.TargetingContext

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/presentedofferingcontext/targetingcontext-swift.class

Documentation for the PresentedOfferingContext.TargetingContext class, including its initializer and properties.

```APIDOC
## PresentedOfferingContext.TargetingContext

### Description
Stores information about a targeting rule used to obtain an offering.

### Declaration
```swift
@objc(RCTargetingContext) final class TargetingContext
```

### Initializers

#### init(revision:ruleId:)
Initializes a `TargetingContext` with the given revision and rule ID.

- **Parameters**
  - `revision` (Int) - The revision of the targeting used to obtain this object.
  - `ruleId` (String) - The rule id from the targeting used to obtain this object.

### Instance Properties

- `let revision: Int` - The revision of the targeting used to obtain this object.
- `let ruleId: String` - The rule id from the targeting used to obtain this object.

### Relationships
- Inherits From: `ObjectiveC.NSObject`
- Conforms To: `ObjectiveC.NSObjectProtocol`, `Swift.CVarArg`, `Swift.CustomDebugStringConvertible`, `Swift.CustomStringConvertible`, `Swift.Equatable`, `Swift.Hashable`, `Swift.Sendable`
```

--------------------------------

### var localizedDescription: String { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/checksum/checksumvalidationfailure/localizeddescription

Retrieves the localized description for this error. This property is read-only and returns a String.

```APIDOC
## Property: localizedDescription

### Description
Retrieves the localized description for this error.

### Declaration
```swift
var localizedDescription: String { get }
```

### Parameters
None.

### Return Value
A String containing the localized description of the error.

### Example
```swift
let errorDescription = error.localizedDescription
```
```

--------------------------------

### checkTrialOrIntroDiscountEligibility(product:completion:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/checktrialorintrodiscounteligibility%28product%3Acompletion%3A%29

Computes whether a user is eligible for the introductory pricing period of a given product. Use this to decide whether to show the normal price or the introductory price. Trials are considered a type of introductory pricing.

```APIDOC
## checkTrialOrIntroDiscountEligibility(product:completion:)

### Description
Computes whether or not a user is eligible for the introductory pricing period of a given product. Use this method to determine whether to show the normal product price or the introductory price. This also applies to trials (trials are considered a type of introductory pricing).

### Declaration
**macOS**
```swift
@objc(checkTrialOrIntroDiscountEligibilityForProduct:completion:)
func checkTrialOrIntroDiscountEligibility(product: StoreProduct,
                                          completion: @escaping (IntroEligibilityStatus) -> Void)
```

**iOS**
```swift
@objc(checkTrialOrIntroDiscountEligibilityForProduct:completion:)
func checkTrialOrIntroDiscountEligibility(product: StoreProduct,
                                          completion: @escaping (IntroEligibilityStatus) -> Void)
```

### Parameters
- **product** (StoreProduct) - The product for which to compute eligibility.
- **completion** (closure) - A block that receives an `IntroEligibilityStatus`.

### Discussion
- If you're looking to use Promotional Offers instead, use `getPromotionalOffer(forProductDiscount:product:completion:)`.
- Subscription groups are automatically collected for determining eligibility. If RevenueCat can't definitively compute eligibility, it returns `IntroEligibilityStatus.unknown`. The best action on unknown status is to display non-intro pricing to avoid misleading users. Ensure you are testing with the latest iOS version so the subscription group can be collected.

### Related Symbols
- `checkTrialOrIntroDiscountEligibility(productIdentifiers:completion:)`
```

--------------------------------

### configure(with:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/purchases/configure%28with%3A%29-9fs2p

Configures an instance of the Purchases SDK with a specified Configuration.Builder. The instance is set as a singleton and can be accessed via the shared property.

```APIDOC
## configure(with:)

### Description
Configures an instance of the Purchases SDK with a specified `Configuration.Builder`.

### Method
static func configure(with builder: Configuration.Builder) -> Purchases

### Parameters
- **builder** (Configuration.Builder) - Required - The `Configuration.Builder` object you wish to use to configure `Purchases`.

### Return Value
An instantiated `Purchases` object that has been set as a singleton.

### Discussion
The instance will be set as a singleton. You should access the singleton instance using `shared`. See `Configuration.Builder` for more information about configurable properties.

### Example
```swift
Purchases.configure(
    with: .init(withAPIKey: Constants.apiKey)
             .with(purchasesAreCompletedBy: .revenueCat)
             .with(appUserID: "<app_user_id>")
)
```
```

--------------------------------

### setAdGroup(_:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/attribution/setadgroup%28_%3A%29

Sets the subscriber attribute for the install ad group. Passing an empty string or nil deletes the attribute.

```APIDOC
## setAdGroup(_:)

### Description
Sets the subscriber attribute associated with the install ad group for the user.

### Declaration
```objc
@objc func setAdGroup(_ adGroup: String?)
```

### Parameters
- **adGroup** (String?) - Optional - The ad group value. Empty String or `nil` will delete the subscriber attribute.

```

--------------------------------

### init(entitlements:verification:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/entitlementinfos/init%28entitlements%3Averification%3A%29

Initializes an EntitlementInfos instance with the given entitlements dictionary and verification result. Useful for unit testing.

```APIDOC
## init(entitlements:verification:)

### Description
Initializes an `EntitlementInfos` instance. Useful for Unit testing purposes, since the other (internal) initializers require a backend response.

### Declaration
```swift
init(
    entitlements: [String : EntitlementInfo] = [:],
    verification: VerificationResult = .notRequested
)
```

### Parameters
- **entitlements** ([String : EntitlementInfo]) - Optional - A dictionary mapping entitlement identifiers to `EntitlementInfo` objects. Defaults to an empty dictionary.
- **verification** (VerificationResult) - Optional - The verification result for the entitlements. Defaults to `.notRequested`.

```

--------------------------------

### override var debugDescription: String { get }

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/introeligibility/debugdescription

An overridden instance property that returns a debug description of the object as a String.

```APIDOC
## Property: debugDescription

### Description
An overridden instance property that provides a debug description of the object.

### Declaration
```swift
override var debugDescription: String { get }
```

### Parameters
None

### Return Value
A String containing the debug description.

### Example
```swift
let description = object.debugDescription
```
```

--------------------------------

### purchaseDate(forProductIdentifier:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/customerinfo/purchasedate%28forproductidentifier%3A%29

Get the latest purchase or renewal date for a given product identifier. You should use Entitlements though!

```APIDOC
## purchaseDate(forProductIdentifier:)

### Description
Get the latest purchase or renewal date for a given product identifier. You should use Entitlements though!

### Declaration
```objc
@objc func purchaseDate(forProductIdentifier productIdentifier: ProductIdentifier) -> Date?
```

### Parameters
- **productIdentifier** (ProductIdentifier) - Required - Product identifier for subscription product

### Return Value
The purchase date for `productIdentifier`, `nil` if product never purchased
```

--------------------------------

### init(identifier:price:localizedPriceString:paymentMode:subscriptionPeriod:numberOfPeriods:type:)

Source: https://revenuecat.github.io/purchases-ios-docs/5.88.0/documentation/revenuecat/teststoreproductdiscount

Initializes a TestStoreProductDiscount with the specified properties.

```APIDOC
## init(identifier:price:localizedPriceString:paymentMode:subscriptionPeriod:numberOfPeriods:type:)

### Description
Initializes a TestStoreProductDiscount with the specified properties.

### Declaration
swift
init(identifier: String, price: Decimal, localizedPriceString: String, paymentMode: StoreProductDiscount.PaymentMode, subscriptionPeriod: SubscriptionPeriod, numberOfPeriods: Int, type: StoreProductDiscount.DiscountType)


### Parameters
- **identifier** (String) - The identifier of the discount.
- **price** (Decimal) - The discount price of the product in the local currency.
- **localizedPriceString** (String) - The price of this product discount formatted for locale.
- **paymentMode** (StoreProductDiscount.PaymentMode) - The payment mode for this product discount.
- **subscriptionPeriod** (SubscriptionPeriod) - The period for the product discount.
- **numberOfPeriods** (Int) - The number of periods the product discount is available.
- **type** (StoreProductDiscount.DiscountType) - The type of product discount.
```
Tokens:
Raw