Purchases Flutter

https://pub.dev/documentation/purchases_flutter/latest
Admin
Purchases Flutter is an open-source framework that wraps StoreKit, Google Play Billing, and...
Tokens:41,575
Snippets:736
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### setKeyword(String keyword)

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Sets the subscriber attribute associated with the install keyword for the user.

```APIDOC
## setKeyword(String keyword) → Future<void>

### Description
Subscriber attribute associated with the install keyword for the user.

### Method
setKeyword

### Parameters
- **keyword** (String) - Required - The install keyword value.

### Return Type
Future<void>

```

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

### setCampaign(String campaign)

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Sets the subscriber attribute associated with the install campaign for the user.

```APIDOC
## setCampaign(String campaign) → Future<void>

### Description
Subscriber attribute associated with the install campaign for the user.

### Method
setCampaign

### Parameters
- **campaign** (String) - Required - The install campaign value.

### Return Type
Future<void>

```

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

### getCustomerInfo

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Gets current customer info, which will normally be cached.

```APIDOC
## [STATIC_METHOD] getCustomerInfo() → Future<CustomerInfo>

### Description
Gets current customer info, which will normally be cached.

### Method
STATIC_METHOD

### Signature
`getCustomerInfo() → Future<CustomerInfo>`

### Returns
Future<CustomerInfo> - The current customer info.
```

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

### setMediaSource(String mediaSource)

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Sets the subscriber attribute associated with the install media source for the user.

```APIDOC
## setMediaSource(String mediaSource) → Future<void>

### Description
Subscriber attribute associated with the install media source for the user.

### Method
setMediaSource

### Parameters
- **mediaSource** (String) - Required - The install media source value.

### Return Type
Future<void>

```

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

### configure

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Sets up Purchases with your API key and an app user id.

```APIDOC
## [STATIC_METHOD] configure(PurchasesConfiguration purchasesConfiguration) → Future<void>

### Description
Sets up Purchases with your API key and an app user id.

### Method
STATIC_METHOD

### Signature
`configure(PurchasesConfiguration purchasesConfiguration) → Future<void>`

### Parameters
- **purchasesConfiguration** (PurchasesConfiguration) - Required - The configuration object containing your API key and app user id.

### Returns
Future<void> - Completes when configuration is done.
```

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

### hashCode

Source: https://pub.dev/documentation/purchases_flutter/latest/models_verified_reward/VerifiedUnsupportedReward-class.html

Gets the hash code for this object. This property is inherited from Object and has no setter.

```APIDOC
## hashCode

### Description
The hash code for this object. This property is inherited from Object and has no setter.

### Property
int get hashCode

### Returns
int - The hash code for this object.

```

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

### IntroductoryPrice constructor

Source: https://pub.dev/documentation/purchases_flutter/latest/models_introductory_price/IntroductoryPrice-class.html

Creates an IntroductoryPrice instance with the specified price, price string, period, cycles, period unit, and period number of units.

```APIDOC
## IntroductoryPrice(double price, String priceString, String period, int cycles, PeriodUnit periodUnit, int periodNumberOfUnits)

### Description
Creates an IntroductoryPrice instance with the given price, formatted price string, billing period, number of cycles, period unit, and number of units in the period.

### Parameters
- **price** (double) - Required - The introductory price in local currency.
- **priceString** (String) - Required - The formatted introductory price including currency sign.
- **period** (String) - Required - The billing period in ISO 8601 format.
- **cycles** (int) - Required - The number of subscription billing periods for which the introductory price applies.
- **periodUnit** (PeriodUnit) - Required - The unit for the billing period (DAY, WEEK, MONTH, YEAR).
- **periodNumberOfUnits** (int) - Required - The number of units for the billing period.

### Example
```dart
IntroductoryPrice(
  price: 3.99,
  priceString: '€3.99',
  period: 'P1M',
  cycles: 3,
  periodUnit: PeriodUnit.month,
  periodNumberOfUnits: 1,
);
```
```

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

### runtimeType

Source: https://pub.dev/documentation/purchases_flutter/latest/models_verified_reward/VerifiedUnsupportedReward-class.html

Gets a representation of the runtime type of the object. This property is inherited from Object and has no setter.

```APIDOC
## runtimeType

### Description
A representation of the runtime type of the object. This property is inherited from Object and has no setter.

### Property
Type get runtimeType

### Returns
Type - The runtime type of the object.

```

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

### Offering constructor

Source: https://pub.dev/documentation/purchases_flutter/latest/models_offering_wrapper/Offering-class.html

Creates an Offering instance with the specified identifier, server description, metadata, and available packages, along with optional package types and web checkout URL.

```APIDOC
## Offering(String identifier, String serverDescription, Map<String, Object> metadata, List<Package> availablePackages, {Package? lifetime, Package? annual, Package? sixMonth, Package? threeMonth, Package? twoMonth, Package? monthly, Package? weekly, String? webCheckoutUrl})

### Description
Creates an Offering instance with the given properties.

### Parameters
- **identifier** (String) - Required - Unique identifier defined in RevenueCat dashboard.
- **serverDescription** (String) - Required - Offering description defined in RevenueCat dashboard.
- **metadata** (Map<String, Object>) - Required - Offering metadata defined in RevenueCat dashboard.
- **availablePackages** (List<Package>) - Required - Array of Package objects available for purchase.
- **lifetime** (Package?) - Optional - Lifetime package type configured in the RevenueCat dashboard, if available.
- **annual** (Package?) - Optional - Annual package type configured in the RevenueCat dashboard, if available.
- **sixMonth** (Package?) - Optional - Six month package type configured in the RevenueCat dashboard, if available.
- **threeMonth** (Package?) - Optional - Three month package type configured in the RevenueCat dashboard, if available.
- **twoMonth** (Package?) - Optional - Two month package type configured in the RevenueCat dashboard, if available.
- **monthly** (Package?) - Optional - Monthly package type configured in the RevenueCat dashboard, if available.
- **weekly** (Package?) - Optional - Weekly package type configured in the RevenueCat dashboard, if available.
- **webCheckoutUrl** (String?) - Optional - URL to use for web checkout for this offering. Null if not available.
```

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

### PromotionalOffer(String identifier, String keyIdentifier, String nonce, String signature, int timestamp)

Source: https://pub.dev/documentation/purchases_flutter/latest/models_promotional_offer/PromotionalOffer-class.html

Creates a PromotionalOffer instance with the specified identifier, key identifier, nonce, signature, and timestamp.

```APIDOC
## PromotionalOffer(String identifier, String keyIdentifier, String nonce, String signature, int timestamp)

### Description
Creates a PromotionalOffer instance with the specified identifier, key identifier, nonce, signature, and timestamp.

### Parameters
- **identifier** (String) - Required - Identifier agreed upon with the App Store for a discount of your choosing.
- **keyIdentifier** (String) - Required - The identifier of the public/private key pair agreed upon with the App Store when the keys were generated.
- **nonce** (String) - Required - One-time use random entropy-adding value for security.
- **signature** (String) - Required - The cryptographic signature generated by your private key.
- **timestamp** (int) - Required - Timestamp of when the signature is created.

### Return Value
A new PromotionalOffer instance.
```

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

### IntroductoryPrice.fromJson

Source: https://pub.dev/documentation/purchases_flutter/latest/models_introductory_price/IntroductoryPrice-class.html

Creates an IntroductoryPrice instance from a JSON map.

```APIDOC
## IntroductoryPrice.fromJson(Map<String, dynamic> json)

### Description
Factory constructor that creates an IntroductoryPrice instance from a JSON map.

### Parameters
- **json** (Map<String, dynamic>) - Required - The JSON map containing the introductory price data.

### Example
```dart
final introductoryPrice = IntroductoryPrice.fromJson(jsonMap);
```
```

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

### SubscriptionInfo Constructor

Source: https://pub.dev/documentation/purchases_flutter/latest/models_subscription_info_wrapper/SubscriptionInfo-class.html

Creates a SubscriptionInfo instance with the specified product identifier, purchase date, sandbox status, active status, and renewal flag, along with optional parameters for additional subscription details.

```APIDOC
## SubscriptionInfo Constructor

### Description
Creates a SubscriptionInfo instance with the specified product identifier, purchase date, sandbox status, active status, and renewal flag, along with optional parameters for additional subscription details.

### Signature
```dart
SubscriptionInfo(
  String productIdentifier,
  String purchaseDate,
  bool isSandbox,
  bool isActive,
  bool willRenew, {
  String? originalPurchaseDate,
  String? expiresDate,
  Store store = Store.unknownStore,
  String? unsubscribeDetectedAt,
  String? billingIssuesDetectedAt,
  String? gracePeriodExpiresDate,
  OwnershipType ownershipType = OwnershipType.unknown,
  PeriodType periodType = PeriodType.unknown,
  String? refundedAt,
  String? storeTransactionId,
  String? autoResumeDate,
  String? displayName,
  String? managementURL,
  String? productPlanIdentifier,
})
```

### Parameters
- **productIdentifier** (String) - Required - The product identifier.
- **purchaseDate** (String) - Required - Date when the last subscription period started.
- **isSandbox** (bool) - Required - Whether the purchase was made in sandbox mode.
- **isActive** (bool) - Required - Whether the subscription is currently active.
- **willRenew** (bool) - Required - Whether the subscription will renew at the next billing period.
- **originalPurchaseDate** (String?) - Optional - Date when this subscription first started.
- **expiresDate** (String?) - Optional - Date when the subscription expires/expired.
- **store** (Store) - Optional - Store where the subscription was purchased. Defaults to Store.unknownStore.
- **unsubscribeDetectedAt** (String?) - Optional - Date when RevenueCat detected that auto-renewal was turned off.
- **billingIssuesDetectedAt** (String?) - Optional - Date when RevenueCat detected billing issues.
- **gracePeriodExpiresDate** (String?) - Optional - Date when any grace period expires.
- **ownershipType** (OwnershipType) - Optional - How the customer received access. Defaults to OwnershipType.unknown.
- **periodType** (PeriodType) - Optional - Type of the current subscription period. Defaults to PeriodType.unknown.
- **refundedAt** (String?) - Optional - Date when RevenueCat detected a refund.
- **storeTransactionId** (String?) - Optional - The transaction id in the store.
- **autoResumeDate** (String?) - Optional - Date the paused subscription will automatically resume.
- **displayName** (String?) - Optional - Display name of the subscription.
- **managementURL** (String?) - Optional - URL to manage the subscription in the store.
- **productPlanIdentifier** (String?) - Optional - Base plan identifier that unlocked the subscription.
```

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

### setAd(String ad)

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Sets the subscriber attribute associated with the install ad for the user.

```APIDOC
## setAd(String ad) → Future<void>

### Description
Subscriber attribute associated with the install ad for the user.

### Method
setAd

### Parameters
- **ad** (String) - Required - The install ad value.

### Return Type
Future<void>

```

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

### PresentedOfferingContext constructor

Source: https://pub.dev/documentation/purchases_flutter/latest/models_presented_offering_context_wrapper/PresentedOfferingContext-class.html

Creates a new PresentedOfferingContext instance with the given offering identifier, placement identifier, and targeting context.

```APIDOC
## PresentedOfferingContext(String offeringIdentifier, String? placementIdentifier, PresentedOfferingTargetingContext? targetingContext)

### Description
Creates a new PresentedOfferingContext instance with the specified offering identifier, placement identifier, and targeting context.

### Parameters
- **offeringIdentifier** (String) - Required - The identifier of the offering used to obtain this object.
- **placementIdentifier** (String?) - Optional - The identifier of the placement used to obtain this object.
- **targetingContext** (PresentedOfferingTargetingContext?) - Optional - The revision of the targeting used to obtain this object.

### Example
```dart
final context = PresentedOfferingContext(
  offeringIdentifier: 'offering_1',
  placementIdentifier: 'placement_1',
  targetingContext: targetingContext,
);
```
```

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

### setCreative(String creative)

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Sets the subscriber attribute associated with the install ad creative for the user.

```APIDOC
## setCreative(String creative) → Future<void>

### Description
Subscriber attribute associated with the install ad creative for the user.

### Method
setCreative

### Parameters
- **creative** (String) - Required - The install ad creative value.

### Return Type
Future<void>

```

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

### getOfferings

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Fetch the configured offerings for this users.

```APIDOC
## [STATIC_METHOD] getOfferings() → Future<Offerings>

### Description
Fetch the configured offerings for this users. Offerings allows you to configure your in-app products via RevenueCat and greatly simplifies management. See the guide for more info.

### Method
STATIC_METHOD

### Signature
`getOfferings() → Future<Offerings>`

### Returns
Future<Offerings> - The configured offerings.
```

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

### setAdGroup(String adGroup)

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

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

```APIDOC
## setAdGroup(String adGroup) → Future<void>

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

### Method
setAdGroup

### Parameters
- **adGroup** (String) - Required - The install ad group value.

### Return Type
Future<void>

```

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

### PromotionalOffer.fromJson(Map<String, dynamic> json)

Source: https://pub.dev/documentation/purchases_flutter/latest/models_promotional_offer/PromotionalOffer-class.html

Creates a PromotionalOffer instance from a JSON map.

```APIDOC
## PromotionalOffer.fromJson(Map<String, dynamic> json)

### Description
Creates a PromotionalOffer instance from a JSON map.

### Parameters
- **json** (Map<String, dynamic>) - Required - The JSON map containing the promotional offer data.

### Return Value
A new PromotionalOffer instance.
```

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

### Purchases Static Methods

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Static methods for the Purchases class in the RevenueCat Flutter SDK, covering setup, subscriber attributes, purchase syncing, and paywall tracking.

```APIDOC
## setPushToken(String pushToken) → Future<void>

### Description
Subscriber attribute associated with the push token for the user.

### Method
setPushToken

### Parameters
- **pushToken** (String) - Required - The push token to associate with the user.

### Returns
Future<void>
```

```APIDOC
## setSimulatesAskToBuyInSandbox(bool enabled) → Future<void>

### Description
iOS only. Set this property to true _only_ when testing the ask-to-buy / SCA purchases flow. More information: http://errors.rev.cat/ask-to-buy

### Method
setSimulatesAskToBuyInSandbox

### Parameters
- **enabled** (bool) - Required - Whether to simulate ask-to-buy in sandbox.

### Returns
Future<void>
```

```APIDOC
## setSingularDeviceID(String singularDeviceID) → Future<void>

### Description
Subscriber attribute associated with the Singular Device ID (SDID) for the user. Required for the RevenueCat Singular integration when using Singular's Event Endpoint V2.

### Method
setSingularDeviceID

### Parameters
- **singularDeviceID** (String) - Required - The Singular Device ID (SDID) to associate with the user.

### Returns
Future<void>
```

```APIDOC
## setTenjinAnalyticsInstallationID(String tenjinAnalyticsInstallationID) → Future<void>

### Description
Subscriber attribute associated with the Tenjin Installation ID for the user. Required for the RevenueCat Tenjin integration.

### Method
setTenjinAnalyticsInstallationID

### Parameters
- **tenjinAnalyticsInstallationID** (String) - Required - The Tenjin Installation ID to associate with the user.

### Returns
Future<void>
```

```APIDOC
## setup(String apiKey, {String? appUserId, PurchasesAreCompletedBy? purchasesAreCompletedBy, String? userDefaultsSuiteName, StoreKitVersion? storeKitVersion, bool useAmazon = false, bool usesStoreKit2IfAvailable = false}) → Future<void>

### Description
Sets up Purchases with your API key and an app user id.

### Method
setup

### Parameters
- **apiKey** (String) - Required - Your RevenueCat API key.
- **appUserId** (String?) - Optional - An app user id.
- **purchasesAreCompletedBy** (PurchasesAreCompletedBy?) - Optional - Determines who completes purchases.
- **userDefaultsSuiteName** (String?) - Optional - The suite name for UserDefaults.
- **storeKitVersion** (StoreKitVersion?) - Optional - The StoreKit version to use.
- **useAmazon** (bool) - Optional - Whether to use Amazon. Defaults to false.
- **usesStoreKit2IfAvailable** (bool) - Optional - Whether to use StoreKit 2 if available. Defaults to false.

### Returns
Future<void>
```

```APIDOC
## showInAppMessages({Set<InAppMessageType>? types}) → Future<void>

### Description
Displays the specified store in-app message types to the user if there are any available to be shown.

### Method
showInAppMessages

### Parameters
- **types** (Set<InAppMessageType>?) - Optional - The set of in-app message types to display.

### Returns
Future<void>
```

```APIDOC
## syncAmazonPurchase(String productID, String receiptID, String amazonUserID, String? isoCurrencyCode, double? price, {int? purchaseTime}) → Future<void>

### Description
This method will send a purchase to the RevenueCat backend. This function should only be called if you are in Amazon observer mode or performing a client side migration of your current users to RevenueCat.

### Method
syncAmazonPurchase

### Parameters
- **productID** (String) - Required - The product identifier.
- **receiptID** (String) - Required - The receipt identifier.
- **amazonUserID** (String) - Required - The Amazon user ID.
- **isoCurrencyCode** (String?) - Optional - The ISO currency code.
- **price** (double?) - Optional - The price.
- **purchaseTime** (int?) - Optional - The purchase time.

### Returns
Future<void>
```

```APIDOC
## syncAttributesAndOfferingsIfNeeded() → Future<Offerings>

### Description
Syncs subscriber attributes and then fetches the configured offerings for this user. This method is intended to be called when using Targeting Rules with Custom Attributes. Any subscriber attributes should be set before calling this method to ensure the returned offerings are applied with the latest subscriber attributes.

### Method
syncAttributesAndOfferingsIfNeeded

### Parameters
None

### Returns
Future<Offerings>
```

```APIDOC
## syncObserverModeAmazonPurchase(String productID, String receiptID, String amazonUserID, String? isoCurrencyCode, double? price) → Future<void>

### Description
This method will send a purchase to the RevenueCat backend. This function should only be called if you are in Amazon observer mode or performing a client side migration of your current users to RevenueCat.

### Method
syncObserverModeAmazonPurchase

### Parameters
- **productID** (String) - Required - The product identifier.
- **receiptID** (String) - Required - The receipt identifier.
- **amazonUserID** (String) - Required - The Amazon user ID.
- **isoCurrencyCode** (String?) - Optional - The ISO currency code.
- **price** (double?) - Optional - The price.

### Returns
Future<void>
```

```APIDOC
## syncPurchases() → Future<void>

### Description
This method will send all the purchases to the RevenueCat backend.

### Method
syncPurchases

### Parameters
None

### Returns
Future<void>
```

```APIDOC
## trackCustomPaywallImpression({CustomPaywallImpressionParams? params}) → Future<void>

### Description
Custom Paywall Tracking. Tracks a custom paywall impression.

### Method
trackCustomPaywallImpression

### Parameters
- **params** (CustomPaywallImpressionParams?) - Optional - The parameters for the custom paywall impression.

### Returns
Future<void>
```

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

### PresentedOfferingTargetingContext constructor

Source: https://pub.dev/documentation/purchases_flutter/latest/models_presented_offering_targeting_context_wrapper/PresentedOfferingTargetingContext-class.html

Creates a new PresentedOfferingTargetingContext instance with the given revision and rule ID.

```APIDOC
## PresentedOfferingTargetingContext(int revision, String ruleId)

### Description
Creates a new PresentedOfferingTargetingContext instance with the specified revision and rule ID.

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

### Return Value
A new PresentedOfferingTargetingContext instance.
```

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

### Purchases.checkTrialOrIntroductoryPriceEligibility

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter

Checks whether the user is eligible for a trial or introductory price for the given product identifiers. Returns a map of product identifiers to IntroEligibility objects.

```APIDOC
## Purchases.checkTrialOrIntroductoryPriceEligibility

### Description
Checks whether the user is eligible for a trial or introductory price for the given product identifiers. Returns a map of product identifiers to IntroEligibility objects.

### Method
checkTrialOrIntroductoryPriceEligibility

### Parameters
- **productIdentifiers** (List<String>) - Required - The list of product identifiers to check.

### Request Example
```dart
Map<String, IntroEligibility> eligibility = await Purchases.checkTrialOrIntroductoryPriceEligibility(["product_id"]);
```

### Response
- **Map<String, IntroEligibility>** (Map<String, IntroEligibility>) - A map of product identifiers to eligibility status.
```

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

### Storefront.fromJson(Map<String, dynamic> json)

Source: https://pub.dev/documentation/purchases_flutter/latest/models_storefront/Storefront-class.html

Creates a Storefront instance from a JSON map.

```APIDOC
## Storefront.fromJson(Map<String, dynamic> json)

### Description
Creates a Storefront instance from a JSON map.

### Factory Constructor
Storefront.fromJson(Map<String, dynamic> json)

### Parameters
- **json** (Map<String, dynamic>) - Required - The JSON map to deserialize from.

```

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

### Purchases.configure

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter

Configures the RevenueCat SDK with the provided configuration. Must be called before using other methods.

```APIDOC
## Purchases.configure

### Description
Configures the RevenueCat SDK with the provided configuration. Must be called before using other methods.

### Method
configure

### Parameters
- **configuration** (PurchasesConfiguration) - Required - The configuration object containing API key, app user ID, and other settings.

### Request Example
```dart
Purchases.configure(PurchasesConfiguration("api_key"));
```

### Response
No return value.
```

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

### Storefront({required String countryCode})

Source: https://pub.dev/documentation/purchases_flutter/latest/models_storefront/Storefront-class.html

Creates a new Storefront instance with the given country code.

```APIDOC
## Storefront({required String countryCode})

### Description
Creates a new Storefront instance with the given country code.

### Constructor
Storefront({required String countryCode})

### Parameters
- **countryCode** (String) - Required - Country code of the current store account.

```

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

### purchasePackageWithWinBackOffer

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a package applying a given win-back offer.

```APIDOC
## purchasePackageWithWinBackOffer

### Description
iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a package applying a given win-back offer.

### Method
Static method

### Signature
`Future<PurchaseResult> purchasePackageWithWinBackOffer(Package package, WinBackOffer winBackOffer)`

### Parameters
- **package** (Package) - Required - The package to purchase.
- **winBackOffer** (WinBackOffer) - Required - The win-back offer to apply.

### Returns
`Future<PurchaseResult>` - The result of the purchase.
```

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

### StoreProductChangeInfo constructor

Source: https://pub.dev/documentation/purchases_flutter/latest/models_store_product_change/StoreProductChangeInfo-class.html

Constructs a StoreProductChangeInfo with the old product identifier and an optional replacement mode.

```APIDOC
## StoreProductChangeInfo constructor

### Description
Constructs a StoreProductChangeInfo.

### Constructor
StoreProductChangeInfo(String oldProductIdentifier, {StoreReplacementMode? replacementMode})

### Parameters
- **oldProductIdentifier** (String) - Required - The old product identifier to change from.
- **replacementMode** (StoreReplacementMode?) - Optional - The replacement mode to use when changing from the old product.

### Properties
- **oldProductIdentifier** (String) - final - The old product identifier to change from.
- **replacementMode** (StoreReplacementMode?) - final - The replacement mode to use when changing from the old product.

### Inherited Properties
- **hashCode** (int) - no setter - The hash code for this object.
- **runtimeType** (Type) - no setter - A representation of the runtime type of the object.

### Inherited Methods
- **noSuchMethod**(Invocation invocation) → dynamic - Invoked when a nonexistent method or property is accessed.
- **toString**() → String - A string representation of this object.

### Operators
- **operator ==**(Object other) → bool - The equality operator.
```

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

### Price(String formatted, int amountMicros, String currencyCode)

Source: https://pub.dev/documentation/purchases_flutter/latest/models_price_wrapper/Price-class.html

Creates a Price instance with the given formatted price, amount in micro-units, and currency code. This is a const constructor.

```APIDOC
## Price(String formatted, int amountMicros, String currencyCode)

### Description
Creates a Price instance with the given formatted price, amount in micro-units, and currency code.

### Constructor
`const Price(String formatted, int amountMicros, String currencyCode)`

### Parameters
- **formatted** (String) - Required - Formatted price of the item, including its currency sign. For example $3.00.
- **amountMicros** (int) - Required - Price in micro-units, where 1,000,000 micro-units equal one unit of the currency.
- **currencyCode** (String) - Required - ISO 4217 currency code for price and original price.

```

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

### EntitlementInfos(Map<String, EntitlementInfo> all, Map<String, EntitlementInfo> active, {VerificationResult verification = VerificationResult.notRequested})

Source: https://pub.dev/documentation/purchases_flutter/latest/models_entitlement_infos_wrapper/EntitlementInfos-class.html

Constructs an EntitlementInfos instance with the given maps of all and active entitlements, and an optional verification result.

```APIDOC
## EntitlementInfos(Map<String, EntitlementInfo> all, Map<String, EntitlementInfo> active, {VerificationResult verification = VerificationResult.notRequested})

### Description
Constructs an EntitlementInfos instance with the given maps of all and active entitlements, and an optional verification result.

### Parameters
- **all** (Map<String, EntitlementInfo>) - Required - Map of all EntitlementInfo objects (active and inactive) keyed by entitlement identifier.
- **active** (Map<String, EntitlementInfo>) - Required - Map of active EntitlementInfo objects keyed by entitlement identifier.
- **verification** (VerificationResult) - Optional - The result of entitlement verification, defaults to VerificationResult.notRequested.

### Return Value
A new EntitlementInfos instance.
```

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

### purchaseProductWithWinBackOffer

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a product applying a given win-back offer.

```APIDOC
## purchaseProductWithWinBackOffer

### Description
iOS only, requires iOS 18.0 or greater with StoreKit 2. Purchase a product applying a given win-back offer.

### Method
Static method

### Signature
`Future<PurchaseResult> purchaseProductWithWinBackOffer(StoreProduct product, WinBackOffer winBackOffer)`

### Parameters
- **product** (StoreProduct) - Required - The product to purchase.
- **winBackOffer** (WinBackOffer) - Required - The win-back offer to apply.

### Returns
`Future<PurchaseResult>` - The result of the purchase.
```

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

### PresentedOfferingContext.fromJson

Source: https://pub.dev/documentation/purchases_flutter/latest/models_presented_offering_context_wrapper/PresentedOfferingContext-class.html

Creates a PresentedOfferingContext instance from a JSON map.

```APIDOC
## PresentedOfferingContext.fromJson(Map<String, dynamic> json)

### Description
Factory constructor that creates a PresentedOfferingContext instance from a JSON map.

### Parameters
- **json** (Map<String, dynamic>) - Required - The JSON map containing the offering context data.

### Example
```dart
final context = PresentedOfferingContext.fromJson(jsonMap);
```
```

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

### checkTrialOrIntroductoryPriceEligibility

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

iOS only. Computes whether or not a user is eligible for the introductory pricing period of a given product.

```APIDOC
## [STATIC_METHOD] checkTrialOrIntroductoryPriceEligibility(List<String> productIdentifiers) → Future<Map<String, IntroEligibility>>

### Description
iOS only. 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).

### Method
STATIC_METHOD

### Signature
`checkTrialOrIntroductoryPriceEligibility(List<String> productIdentifiers) → Future<Map<String, IntroEligibility>>`

### Parameters
- **productIdentifiers** (List<String>) - Required - The list of product identifiers to check eligibility for.

### Returns
Future<Map<String, IntroEligibility>> - A map of product identifiers to eligibility results.
```

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

### PresentedOfferingTargetingContext.fromJson

Source: https://pub.dev/documentation/purchases_flutter/latest/models_presented_offering_targeting_context_wrapper/PresentedOfferingTargetingContext-class.html

Creates a PresentedOfferingTargetingContext instance from a JSON map.

```APIDOC
## PresentedOfferingTargetingContext.fromJson(Map<String, dynamic> json)

### Description
Factory constructor that creates a PresentedOfferingTargetingContext instance from a JSON map.

### Parameters
- **json** (Map<String, dynamic>) - Required - The JSON map containing the data.

### Return Value
A new PresentedOfferingTargetingContext instance.
```

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

### ReadyForPromotedProductPurchaseListener typedef

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/ReadyForPromotedProductPurchaseListener.html

Defines the signature for a listener that handles promoted in-app purchases on iOS. The listener receives the product identifier and a startPurchase function that must be called when the app is ready to process the purchase.

```APIDOC
## ReadyForPromotedProductPurchaseListener typedef

### Description
A listener called when a user initiates a promoted in-app purchase from the App Store on iOS. The listener provides the product identifier and a startPurchase function that should be invoked when the app is ready to handle the purchase.

### Signature
```dart
typedef ReadyForPromotedProductPurchaseListener = void Function(
  String productIdentifier,
  Future<PromotedPurchaseResult> Function() startPurchase,
);
```

### Parameters
- **productIdentifier** (String) - The product identifier associated with the promoted purchase.
- **startPurchase** (Future<PromotedPurchaseResult> Function()) - A function that should be called when the app is ready to handle the purchase. If the purchase should never be made, this function can be ignored.

### Usage Notes
- This listener is iOS only.
- If the app is not in a state to make a purchase, cache the startPurchase block and call it later when the app is ready.
- If the purchase should never be made, do not call the startPurchase block.
- Can be tested by opening a link like: `itms-services://?action=purchaseIntent&bundleId=<BUNDLE_ID>&productIdentifier=<SKPRODUCT_ID>`

### Related Articles
- Apple Documentation
```

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

### PricingPhase constructor

Source: https://pub.dev/documentation/purchases_flutter/latest/models_pricing_phase_wrapper/PricingPhase-class.html

Creates a PricingPhase instance with the specified billing period, recurrence mode, billing cycle count, price, and offer payment mode.

```APIDOC
## PricingPhase(Period? billingPeriod, RecurrenceMode? recurrenceMode, int? billingCycleCount, Price price, OfferPaymentMode? offerPaymentMode)

### Description
Creates a PricingPhase instance with the specified billing period, recurrence mode, billing cycle count, price, and offer payment mode.

### Parameters
- **billingPeriod** (Period?) - Required - Billing period for which the PricingPhase applies.
- **recurrenceMode** (RecurrenceMode?) - Required - Recurrence mode of the PricingPhase.
- **billingCycleCount** (int?) - Required - Number of cycles for which the pricing phase applies. Null for infiniteRecurring or finiteRecurring recurrence modes.
- **price** (Price) - Required - Price of the PricingPhase.
- **offerPaymentMode** (OfferPaymentMode?) - Required - Indicates how the pricing phase is charged for finiteRecurring pricing phases.

### Example
```dart
PricingPhase(
  billingPeriod: Period.month,
  recurrenceMode: RecurrenceMode.finiteRecurring,
  billingCycleCount: 6,
  price: Price(amount: 9.99, currency: 'USD'),
  offerPaymentMode: OfferPaymentMode.payAsYouGo,
)
```
```

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

### getEligibleWinBackOffersForPackage

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

iOS only, requires iOS 18.0 or greater with StoreKit 2.

```APIDOC
## [STATIC_METHOD] getEligibleWinBackOffersForPackage(Package package) → Future<List<WinBackOffer>>

### Description
iOS only, requires iOS 18.0 or greater with StoreKit 2.

### Method
STATIC_METHOD

### Signature
`getEligibleWinBackOffersForPackage(Package package) → Future<List<WinBackOffer>>`

### Parameters
- **package** (Package) - Required - The package to get eligible win-back offers for.

### Returns
Future<List<WinBackOffer>> - The list of eligible win-back offers.
```

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

### purchasePackage

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Makes a purchase. Returns a PurchaseResult object. Throws a PlatformException if the purchase is unsuccessful.

```APIDOC
## purchasePackage

### Description
Makes a purchase. Returns a PurchaseResult object. Throws a PlatformException if the purchase is unsuccessful. Check if PurchasesErrorHelper.getErrorCode is PurchasesErrorCode.purchaseCancelledError to check if the user cancelled the purchase.

### Method
Static method

### Signature
`Future<PurchaseResult> purchasePackage(Package packageToPurchase, {UpgradeInfo? upgradeInfo, GoogleProductChangeInfo? googleProductChangeInfo, bool? googleIsPersonalizedPrice})`

### Parameters
- **packageToPurchase** (Package) - Required - The package to purchase.
- **upgradeInfo** (UpgradeInfo?) - Optional - Upgrade information.
- **googleProductChangeInfo** (GoogleProductChangeInfo?) - Optional - Google product change information.
- **googleIsPersonalizedPrice** (bool?) - Optional - Whether the price is personalized.

### Returns
`Future<PurchaseResult>` - The result of the purchase.
```

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

### Offering.fromJson

Source: https://pub.dev/documentation/purchases_flutter/latest/models_offering_wrapper/Offering-class.html

Factory constructor that creates an Offering instance from a JSON map.

```APIDOC
## Offering.fromJson(Map<String, dynamic> json)

### Description
Creates an Offering instance from a JSON map.

### Parameters
- **json** (Map<String, dynamic>) - Required - The JSON map containing the offering data.
```

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

### getProducts

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

Fetches product info for the given product identifiers. Returns a list of StoreProduct objects or throws an error if products are not properly configured in RevenueCat.

```APIDOC
## getProducts

### Description
Fetches product info for the given product identifiers. Returns a list of StoreProduct objects or throws an error if products are not properly configured in RevenueCat or if there is another error while retrieving them.

### Method
Static method

### Signature
`Future<List<StoreProduct>> getProducts(List<String> productIdentifiers, {ProductCategory productCategory = ProductCategory.subscription, PurchaseType type = PurchaseType.subs})`

### Parameters
- **productIdentifiers** (List<String>) - Required - The list of product identifiers to fetch.
- **productCategory** (ProductCategory) - Optional - The category of the products. Defaults to `ProductCategory.subscription`.
- **type** (PurchaseType) - Optional - The purchase type. Defaults to `PurchaseType.subs`.

### Returns
`Future<List<StoreProduct>>` - A list of StoreProduct objects.
```

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

### purchaseProduct

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

It is now recommended to use Purchases.purchaseStoreProduct to make a purchase with a StoreProduct if you can.

```APIDOC
## purchaseProduct

### Description
It is now recommended to use Purchases.purchaseStoreProduct to make a purchase with a StoreProduct if you can.

### Method
Static method

### Signature
`Future<PurchaseResult> purchaseProduct(String productIdentifier, {UpgradeInfo? upgradeInfo, PurchaseType type = PurchaseType.subs})`

### Parameters
- **productIdentifier** (String) - Required - The product identifier.
- **upgradeInfo** (UpgradeInfo?) - Optional - Upgrade information.
- **type** (PurchaseType) - Optional - The purchase type. Defaults to `PurchaseType.subs`.

### Returns
`Future<PurchaseResult>` - The result of the purchase.
```

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

### IntroductoryPrice properties

Source: https://pub.dev/documentation/purchases_flutter/latest/models_introductory_price/IntroductoryPrice-class.html

Properties of the IntroductoryPrice class that provide access to the introductory price details.

```APIDOC
## Properties

### cycles → int
- **Description**: Number of subscription billing periods for which the user will be given the introductory price, such as 3.
- **Type**: int
- **Final**: yes

### period → String
- **Description**: Billing period of the introductory price, specified in ISO 8601 format.
- **Type**: String
- **Final**: yes

### periodNumberOfUnits → int
- **Description**: Number of units for the billing period of the introductory price.
- **Type**: int
- **Final**: yes

### periodUnit → PeriodUnit
- **Description**: Unit for the billing period of the introductory price, can be DAY, WEEK, MONTH or YEAR.
- **Type**: PeriodUnit
- **Final**: yes

### price → double
- **Description**: Introductory price of a subscription in the local currency.
- **Type**: double
- **Final**: yes

### priceString → String
- **Description**: Formatted introductory price of a subscription, including its currency sign, such as €3.99.
- **Type**: String
- **Final**: yes
```

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

### Purchases.getCurrentOfferingForPlacement

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter

Fetches the current offering for a given placement. Returns an Offering object.

```APIDOC
## Purchases.getCurrentOfferingForPlacement

### Description
Fetches the current offering for a given placement. Returns an Offering object.

### Method
getCurrentOfferingForPlacement

### Parameters
- **placementIdentifier** (String) - Required - The identifier of the placement.

### Request Example
```dart
Offering? offering = await Purchases.getCurrentOfferingForPlacement("placement_id");
```

### Response
- **Offering?** (Offering?) - The offering for the placement, or null if not found.
```

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

### Purchases.getCurrentOfferingForPlacement

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter

Fetches the current offering for a given placement. Returns an Offering object.

```APIDOC
## Purchases.getCurrentOfferingForPlacement

### Description
Fetches the current offering for a given placement. Returns an Offering object.

### Method
getCurrentOfferingForPlacement

### Parameters
- **placementIdentifier** (String) - Required - The identifier of the placement.

### Request Example
```dart
Offering? offering = await Purchases.getCurrentOfferingForPlacement("placement_id");
```

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

### Purchases.getOfferings

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter

Fetches the offerings configured in the RevenueCat dashboard. Returns an Offerings object containing all offerings.

```APIDOC
## Purchases.getOfferings

### Description
Fetches the offerings configured in the RevenueCat dashboard. Returns an Offerings object containing all offerings.

### Method
getOfferings

### Parameters
None.

### Request Example
```dart
Offerings offerings = await Purchases.getOfferings();
```

### Response
- **Offerings** (Offerings) - The offerings object containing all offerings.
```

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

### getEligibleWinBackOffersForProduct

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

iOS only, requires iOS 18.0 or greater with StoreKit 2.

```APIDOC
## [STATIC_METHOD] getEligibleWinBackOffersForProduct(StoreProduct product) → Future<List<WinBackOffer>>

### Description
iOS only, requires iOS 18.0 or greater with StoreKit 2.

### Method
STATIC_METHOD

### Signature
`getEligibleWinBackOffersForProduct(StoreProduct product) → Future<List<WinBackOffer>>`

### Parameters
- **product** (StoreProduct) - Required - The product to get eligible win-back offers for.

### Returns
Future<List<WinBackOffer>> - The list of eligible win-back offers.
```

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

### beginRefundRequestForProduct

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/Purchases-class.html

iOS 15+ only. Presents a refund request sheet in the current window scene for the latest transaction associated with the `product`.

```APIDOC
## [STATIC_METHOD] beginRefundRequestForProduct(StoreProduct product) → Future<RefundRequestStatus>

### Description
iOS 15+ only. Presents a refund request sheet in the current window scene for the latest transaction associated with the `product`.

### Method
STATIC_METHOD

### Signature
`beginRefundRequestForProduct(StoreProduct product) → Future<RefundRequestStatus>`

### Parameters
- **product** (StoreProduct) - Required - The product to request a refund for.

### Returns
Future<RefundRequestStatus> - The result of the refund request.
```

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

### IntroEligibilityStatus enum

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/IntroEligibilityStatus.html

The IntroEligibilityStatus enum represents the possible eligibility statuses for free trials or introductory pricing. Use `checkTrialOrIntroductoryPriceEligibility` to determine the eligibility.

```APIDOC
## IntroEligibilityStatus enum

### Description
Possible IntroEligibility status. Use `checkTrialOrIntroductoryPriceEligibility` to determine the eligibility.

### Values
- **introEligibilityStatusUnknown** - RevenueCat doesn't have enough information to determine eligibility.
- **introEligibilityStatusIneligible** - The user is not eligible for a free trial or intro pricing for this product.
- **introEligibilityStatusEligible** - The user is eligible for a free trial or intro pricing for this product.
- **introEligibilityStatusNoIntroOfferExists** - There is no free trial or intro pricing for this product.

### Properties
- **hashCode** (int) - The hash code for this object. (inherited)
- **index** (int) - A numeric identifier for the enumerated value. (inherited)
- **name** (String) - The name of the enum value. (provided by the EnumName extension)
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited)

### Methods
- **noSuchMethod(Invocation invocation)** (dynamic) - Invoked when a nonexistent method or property is accessed. (inherited)
- **toString()** (String) - A string representation of this object. (inherited)

### Operators
- **operator ==(Object other)** (bool) - The equality operator. (inherited)

### Constants
- **values** (const List<IntroEligibilityStatus>) - A constant List of the values in this enum, in order of their declaration.
```

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

### AdOpenedData constructor

Source: https://pub.dev/documentation/purchases_flutter/latest/models_ad_opened_data/AdOpenedData-class.html

Creates an AdOpenedData instance with required mediator name, ad format, ad unit ID, and impression ID, and optional network name and placement.

```APIDOC
## AdOpenedData Constructor

### Description
Creates an AdOpenedData object representing an opened ad event.

### Constructor
`AdOpenedData({String? networkName, required AdMediatorName mediatorName, required AdFormat adFormat, String? placement, required String adUnitId, required String impressionId})`

### Parameters
- **networkName** (String?) - Optional - The name of the ad network.
- **mediatorName** (AdMediatorName) - Required - The mediator name.
- **adFormat** (AdFormat) - Required - The format of the ad.
- **placement** (String?) - Optional - The placement identifier.
- **adUnitId** (String) - Required - The ad unit ID.
- **impressionId** (String) - Required - The impression ID.

### Example
```dart
AdOpenedData(
  networkName: 'network',
  mediatorName: AdMediatorName.example,
  adFormat: AdFormat.banner,
  placement: 'placement',
  adUnitId: 'ad-unit-id',
  impressionId: 'impression-id',
)
```
```

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

### Price.fromJson(Map<String, dynamic> json)

Source: https://pub.dev/documentation/purchases_flutter/latest/models_price_wrapper/Price-class.html

Creates a Price instance from a JSON map. This is a factory constructor.

```APIDOC
## Price.fromJson(Map<String, dynamic> json)

### Description
Creates a Price instance from a JSON map.

### Constructor
`factory Price.fromJson(Map<String, dynamic> json)`

### Parameters
- **json** (Map<String, dynamic>) - Required - The JSON map containing price data.

```

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

### LogInResult({required bool created, required CustomerInfo customerInfo})

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter/LogInResult-class.html

Constructor for the LogInResult class, which holds the result of the logIn method.

```APIDOC
## LogInResult({required bool created, required CustomerInfo customerInfo})

### Description
Constructs a LogInResult with its properties.

### Parameters
- **created** (bool) - Required - true if the logged in user has been created in the RevenueCat backend for the first time. Note: This won't be valid in the web target.
- **customerInfo** (CustomerInfo) - Required - The CustomerInfo associated to the logged in user.

```

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

### Purchases.getPromotionalOffer

Source: https://pub.dev/documentation/purchases_flutter/latest/purchases_flutter

Fetches a promotional offer for a given product and discount. Returns a PromotionalOffer object.

```APIDOC
## Purchases.getPromotionalOffer

### Description
Fetches a promotional offer for a given product and discount. Returns a PromotionalOffer object.

### Method
getPromotionalOffer

### Parameters
- **product** (StoreProduct) - Required - The product for which to fetch the offer.
- **discount** (StoreProductDiscount) - Required - The discount to apply.

### Request Example
```dart
PromotionalOffer offer = await Purchases.getPromotionalOffer(product, discount);
```

### Response
- **PromotionalOffer** (PromotionalOffer) - The promotional offer.
```
Tokens:
Raw