In App Purchase

https://pub.dev/documentation/in_app_purchase/latest/
Admin
A storefront-independent Flutter plugin that enables in-app purchases through the App Store and...
Tokens:13,685
Snippets:191
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Initialize ProductDetailsResponse

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetailsResponse/ProductDetailsResponse.html

Constructor definition for creating a new ProductDetailsResponse instance.

```dart
ProductDetailsResponse({
  required this.productDetails,
  required this.notFoundIDs,
  this.error,
});
```

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

### Initialize ProductDetails

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/ProductDetails.html

Constructor for creating a new product details object with required fields for identification and pricing.

```dart
ProductDetails({
  required this.id,
  required this.title,
  required this.description,
  required this.price,
  required this.rawPrice,
  required this.currencyCode,
  this.currencySymbol = '',
});
```

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

### ProductDetails constructor

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/ProductDetails.html

Creates a new product details object with the provided details.

```APIDOC
## ProductDetails constructor

### Description
Creates a new product details object with the provided details.

### Signature
ProductDetails({required String id, required String title, required String description, required String price, required double rawPrice, required String currencyCode, String currencySymbol = ''})

### Parameters
- **id** (String) - Required - The unique identifier for the product.
- **title** (String) - Required - The title of the product.
- **description** (String) - Required - The description of the product.
- **price** (String) - Required - The formatted price string.
- **rawPrice** (double) - Required - The raw numerical price value.
- **currencyCode** (String) - Required - The ISO currency code.
- **currencySymbol** (String) - Optional - The currency symbol, defaults to an empty string.
```

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

### ProductDetailsResponse constructor

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetailsResponse/ProductDetailsResponse.html

Creates a new instance of ProductDetailsResponse with the provided product details, not found IDs, and an optional error.

```APIDOC
## ProductDetailsResponse constructor

### Description
Creates a new ProductDetailsResponse with the provided response details.

### Signature
ProductDetailsResponse({required List<ProductDetails> productDetails, required List<String> notFoundIDs, IAPError? error})

### Parameters
- **productDetails** (List<ProductDetails>) - Required - The list of product details retrieved.
- **notFoundIDs** (List<String>) - Required - The list of product IDs that could not be found.
- **error** (IAPError?) - Optional - An optional error object if the request failed.
```

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

### Initialize PurchaseParam

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseParam/PurchaseParam.html

Constructor for creating a new PurchaseParam instance with required product details and an optional application user name.

```dart
PurchaseParam({required this.productDetails, this.applicationUserName});
```

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

### Initialize PurchaseVerificationData

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseVerificationData/PurchaseVerificationData.html

Constructor for creating a new instance of PurchaseVerificationData with required verification fields.

```dart
PurchaseVerificationData({
  required this.localVerificationData,
  required this.serverVerificationData,
  required this.source,
});
```

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

### ProductDetailsResponse Class Overview

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/in_app_purchase-library.html

The response returned by `InAppPurchasePlatform.queryProductDetails`.

```APIDOC
## ProductDetailsResponse

### Description
The response returned by `InAppPurchasePlatform.queryProductDetails`.

### Class
`ProductDetailsResponse`
```

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

### Implementation of queryProductDetails

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/queryProductDetails.html

This snippet shows the implementation of the queryProductDetails method by delegating the call to the InAppPurchasePlatform instance.

```dart
Future<ProductDetailsResponse> queryProductDetails(Set<String> identifiers) =>
    InAppPurchasePlatform.instance.queryProductDetails(identifiers);
```

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

### Future<bool> isAvailable()

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/isAvailable.html

Checks if the payment platform is ready and available. Returns true if available, otherwise false.

```APIDOC
## isAvailable()

### Description
Returns a boolean indicating whether the payment platform is ready and available for in-app purchase operations.

### Signature
`Future<bool> isAvailable()`

### Returns
- **bool** - Returns `true` if the payment platform is ready and available, otherwise `false`.
```

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

### Implement SKPaymentQueueDelegateWrapper

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Create a delegate class to control transaction continuation and price consent display behavior.

```dart
// import for SKPaymentQueueDelegateWrapper
import 'package:in_app_purchase_storekit/store_kit_wrappers.dart';

class ExamplePaymentQueueDelegate implements SKPaymentQueueDelegateWrapper {
  @override
  bool shouldContinueTransaction(
      SKPaymentTransactionWrapper transaction, SKStorefrontWrapper storefront) {
    return true;
  }

  @override
  bool shouldShowPriceConsent() {
    return false;
  }
}
```

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

### Query products for sale

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Fetch product details from the store using a set of product IDs.

```dart
// Set literals require Dart 2.2. Alternatively, use
// `Set<String> _kIds = <String>['product1', 'product2'].toSet()`.
const Set<String> _kIds = <String>{'product1', 'product2'};
final ProductDetailsResponse response =
    await InAppPurchase.instance.queryProductDetails(_kIds);
if (response.notFoundIDs.isNotEmpty) {
  // Handle the error.
}
List<ProductDetails> products = response.productDetails;
```

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

### Check platform availability

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/isAvailable.html

Returns a boolean indicating whether the payment platform is ready.

```dart
Future<bool> isAvailable() => InAppPurchasePlatform.instance.isAvailable();
```

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

### Complete Purchase Implementation

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/completePurchase.html

This implementation delegates the completion of a purchase to the current InAppPurchasePlatform instance.

```dart
Future<void> completePurchase(PurchaseDetails purchase) =>
    InAppPurchasePlatform.instance.completePurchase(purchase);
```

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

### PurchaseParam constructor

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseParam/PurchaseParam.html

Creates a new purchase parameter object with the given product details and optional application user name.

```APIDOC
## PurchaseParam constructor

### Description
Creates a new purchase parameter object with the given data.

### Signature
`PurchaseParam({required ProductDetails productDetails, String? applicationUserName})`

### Parameters
- **productDetails** (ProductDetails) - Required - The product details for the purchase.
- **applicationUserName** (String?) - Optional - An optional user name associated with the application purchase.
```

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

### PurchaseVerificationData constructor

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseVerificationData/PurchaseVerificationData.html

Creates a new instance of PurchaseVerificationData with the required verification strings and source identifier.

```APIDOC
## PurchaseVerificationData constructor

### Description
Creates a new PurchaseVerificationData object with the provided verification information.

### Signature
PurchaseVerificationData({required String localVerificationData, required String serverVerificationData, required String source})

### Parameters
- **localVerificationData** (String) - Required - The local verification data string.
- **serverVerificationData** (String) - Required - The server verification data string.
- **source** (String) - Required - The source of the purchase.
```

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

### Add Dependency

Source: https://pub.dev/packages/in_app_purchase

Add the in_app_purchase package to your pubspec.yaml file.

```yaml
in_app_purchase: ^3.3.0
```

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

### ProductDetails Class Definition

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails-class.html

Details regarding the ProductDetails class structure, properties, and constructor.

```APIDOC
## ProductDetails Class

### Description
The ProductDetails class represents the information of a product available for purchase.

### Constructor
ProductDetails({required String id, required String title, required String description, required String price, required double rawPrice, required String currencyCode, String currencySymbol = ''})

### Properties
- **id** (String) - The identifier of the product.
- **title** (String) - The title of the product.
- **description** (String) - The description of the product.
- **price** (String) - The price of the product, formatted with currency symbol (e.g., "$0.99").
- **rawPrice** (double) - The unformatted price of the product.
- **currencyCode** (String) - The currency code for the price of the product.
- **currencySymbol** (String) - The currency symbol for the locale (e.g., $).
```

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

### Implementation of buyConsumable

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/buyConsumable.html

The implementation delegates the purchase request to the underlying InAppPurchasePlatform instance.

```dart
Future<bool> buyConsumable({required PurchaseParam purchaseParam, bool autoConsume = true}) =>
    InAppPurchasePlatform.instance.buyConsumable(
      purchaseParam: purchaseParam,
      autoConsume: autoConsume,
    );
```

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

### InAppPurchase API Overview

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

Overview of the core classes and structures used for managing in-app purchases.

```APIDOC
## InAppPurchase API

### Description
The InAppPurchase class serves as the primary entry point for making in-app purchases across multiple platforms.

### Key Classes
- **InAppPurchase**: The main API for managing purchase flows.
- **ProductDetails**: Represents information about a specific product.
- **PurchaseDetails**: Contains transaction details for a completed purchase.
- **PurchaseParam**: Parameter object required to initiate a purchase.
- **PurchaseVerificationData**: Data used for verifying the authenticity of a purchase.
- **IAPError**: Captures errors returned by the underlying platform.

### Enums
- **PurchaseStatus**: Represents the current state of a PurchaseDetails object.
```

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

### Initiate StoreKit 2 purchase

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Use Sk2PurchaseParam to include StoreKit 2 specific parameters like win-back offer identifiers on iOS and macOS.

```dart
import 'package:in_app_purchase_storekit/in_app_purchase_storekit.dart';

final productDetails = ...; // Obtained from queryProductDetails

final purchaseParamSk2 = Sk2PurchaseParam(
  productDetails: productDetails,
  winBackOfferId: 'your_win_back_offer_id',
);

await InAppPurchase.instance.buyNonConsumable(
  purchaseParam: purchaseParamSk2,
);
```

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

### ProductDetails Class Overview

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/in_app_purchase-library.html

Represents the information of a product available for purchase.

```APIDOC
## ProductDetails

### Description
The class represents the information of a product.

### Class
`ProductDetails`
```

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

### Initiate a purchase

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Distinguish between consumable and non-consumable products before calling the appropriate purchase method.

```dart
final ProductDetails productDetails = ... // Saved earlier from queryProductDetails().
final PurchaseParam purchaseParam = PurchaseParam(productDetails: productDetails);
if (_isConsumable(productDetails)) {
  InAppPurchase.instance.buyConsumable(purchaseParam: purchaseParam);
} else {
  InAppPurchase.instance.buyNonConsumable(purchaseParam: purchaseParam);
}
// From here the purchase flow will be handled by the underlying store.
// Updates will be delivered to the `InAppPurchase.instance.purchaseStream`.
```

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

### InAppPurchaseException constructor

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchaseException/InAppPurchaseException.html

Creates a new instance of InAppPurchaseException with the required source and error code, and an optional message.

```APIDOC
## InAppPurchaseException(String source, String code, String? message)

### Description
Creates a new InAppPurchaseException instance to represent an error encountered during in-app purchase operations.

### Parameters
- **source** (String) - Required - The source of the error.
- **code** (String) - Required - The specific error code associated with the exception.
- **message** (String?) - Optional - A descriptive message providing more details about the error.
```

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

### buyConsumable

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase-class.html

Initiates the purchase process for a consumable product.

```APIDOC
## buyConsumable

### Description
Buy a consumable product.

### Parameters
- **purchaseParam** (PurchaseParam) - Required - The parameters for the purchase.
- **autoConsume** (bool) - Optional - Whether to automatically consume the product after purchase. Defaults to true.

### Response
- **Future<bool>** - Returns true if the purchase process was initiated successfully.
```

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

### Implementation of buyNonConsumable

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/buyNonConsumable.html

This snippet shows the implementation of the buyNonConsumable method by delegating to the InAppPurchasePlatform instance.

```dart
Future<bool> buyNonConsumable({required PurchaseParam purchaseParam}) =>
    InAppPurchasePlatform.instance.buyNonConsumable(purchaseParam: purchaseParam);
```

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

### Enable StoreKit 1 on iOS/macOS

Source: https://pub.dev/packages/in_app_purchase

Call this method before registering the platform if your application requires StoreKit 1 instead of the default StoreKit 2.

```dart
InAppPurchaseStoreKitPlatform.enableStoreKit1()
```

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

### Importing StoreKit Platform Addition

Source: https://pub.dev/packages/in_app_purchase

Required import for accessing InAppPurchaseStoreKitPlatformAddition functionality.

```dart
import 'package:in_app_purchase_storekit/in_app_purchase_storekit.dart';
```

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

### IAPError Constructor

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError-class.html

Details for creating a new IAPError instance.

```APIDOC
## Constructor: IAPError

### Description
Creates a new IAP error object with the given error details.

### Parameters
- **source** (String) - Required - Which source is the error on.
- **code** (String) - Required - The error code.
- **message** (String) - Required - A human-readable error message.
- **details** (dynamic) - Optional - Error details, possibly null.
```

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

### getPlatformAddition<T extends InAppPurchasePlatformAddition?>()

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/getPlatformAddition.html

Retrieves the platform-specific implementation of the InAppPurchasePlatformAddition class.

```APIDOC
## getPlatformAddition<T extends InAppPurchasePlatformAddition?>()

### Description
Provides a platform-specific implementation of the `InAppPurchasePlatformAddition` class.

### Signature
`T getPlatformAddition<T extends InAppPurchasePlatformAddition?>()`

### Returns
- **T** - The platform-specific instance of `InAppPurchasePlatformAddition`.
```

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

### PurchaseDetails Constructor Implementation

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/PurchaseDetails.html

Initializes a new instance of the PurchaseDetails class with required transaction fields.

```dart
PurchaseDetails({
  this.purchaseID,
  required this.productID,
  required this.verificationData,
  required this.transactionDate,
  required this.status,
});
```

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

### PurchaseDetails constructor

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/PurchaseDetails.html

Creates a new PurchaseDetails object with the provided purchase data.

```APIDOC
## PurchaseDetails constructor

### Description
Creates a new instance of the PurchaseDetails class with the specified purchase information.

### Signature
PurchaseDetails({String? purchaseID, required String productID, required PurchaseVerificationData verificationData, required String? transactionDate, required PurchaseStatus status})

### Parameters
- **purchaseID** (String?) - Optional - The unique identifier for the purchase.
- **productID** (String) - Required - The unique identifier for the product purchased.
- **verificationData** (PurchaseVerificationData) - Required - The verification data associated with the purchase.
- **transactionDate** (String?) - Required - The date the transaction occurred.
- **status** (PurchaseStatus) - Required - The current status of the purchase.
```

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

### ProductDetails title implementation

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/title.html

The title property is defined as a final String.

```dart
final String title;
```

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

### PurchaseParam Class Overview

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/in_app_purchase-library.html

The parameter object for generating a purchase.

```APIDOC
## PurchaseParam

### Description
The parameter object for generating a purchase.

### Class
`PurchaseParam`
```

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

### InAppPurchase.instance

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/instance.html

Retrieves the singleton instance of the InAppPurchase class to be used for in-app purchase operations.

```APIDOC
## InAppPurchase.instance

### Description
Returns the singleton instance of the InAppPurchase class. This instance is used to interact with the in-app purchase functionality.

### Signature
`static InAppPurchase get instance`
```

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

### Define productDetails property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetailsResponse/productDetails.html

Declaration of the productDetails list property.

```dart
final List<ProductDetails> productDetails;
```

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

### InAppPurchase Class Overview

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/in_app_purchase-library.html

Provides a basic API for making in-app purchases across multiple platforms.

```APIDOC
## InAppPurchase

### Description
Basic API for making in app purchases across multiple platforms.

### Class
`InAppPurchase`
```

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

### Listen to purchase updates in Flutter

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Subscribe to the purchase stream in initState to handle incoming purchase events from the store.

```dart
class _MyAppState extends State<MyApp> {
  StreamSubscription<List<PurchaseDetails>> _subscription;

  @override
  void initState() {
    final Stream purchaseUpdated =
        InAppPurchase.instance.purchaseStream;
    _subscription = purchaseUpdated.listen((purchaseDetailsList) {
      _listenToPurchaseUpdated(purchaseDetailsList);
    }, onDone: () {
      _subscription.cancel();
    }, onError: (error) {
      // handle error here.
    });
    super.initState();
  }

  @override
  void dispose() {
    _subscription.cancel();
    super.dispose();
  }
```

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

### String toString()

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchaseException/toString.html

Returns a string representation of the InAppPurchaseException object, including the error code, message, and source.

```APIDOC
## String toString()

### Description
Returns a string representation of the InAppPurchaseException object. This is primarily used for debugging or logging purposes to provide useful information about the exception state.

### Signature
`String toString()`

### Returns
- **String**: A string formatted as 'InAppPurchaseException(code, message, source)'.
```

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

### Initialize IAPError

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError/IAPError.html

Constructor for creating a new IAP error instance with required fields.

```dart
IAPError({
  required this.source,
  required this.code,
  required this.message,
  this.details,
});
```

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

### InAppPurchaseException Constructor Implementation

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchaseException/InAppPurchaseException.html

The constructor requires a source and error code, with an optional message parameter.

```dart
InAppPurchaseException({
  required this.source,
  required this.code,
  this.message,
});
```

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

### Accessing the InAppPurchase instance

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/instance.html

Use this static getter to retrieve or create the singleton instance of InAppPurchase.

```dart
static InAppPurchase get instance => _getOrCreateInstance();
```

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

### ProductDetailsResponse Class

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetailsResponse-class.html

The ProductDetailsResponse class encapsulates the results of a product details query, including successfully retrieved product details, identifiers that were not found, and any potential errors.

```APIDOC
## ProductDetailsResponse Class

The response returned by `InAppPurchasePlatform.queryProductDetails`.
A list of ProductDetails can be obtained from this response.

### Constructors

*   **ProductDetailsResponse**({required List<ProductDetails> productDetails, required List<String> notFoundIDs, IAPError? error})
    Creates a new ProductDetailsResponse with the provided response details.

### Properties

*   **error** → IAPError? 
    A caught platform exception thrown while querying the purchases.
    final

*   **hashCode** → int 
    The hash code for this object.
    no setter
    inherited

*   **notFoundIDs** → List<String> 
    The list of identifiers that are in the `identifiers` of `InAppPurchasePlatform.queryProductDetails` but failed to be fetched.
    final

*   **productDetails** → List<ProductDetails> 
    Each ProductDetails uniquely matches one valid identifier in `identifiers` of `InAppPurchasePlatform.queryProductDetails`.
    final

*   **runtimeType** → Type 
    A representation of the runtime type of the object.
    no setter
    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
```

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

### PurchaseStatus Enum Overview

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/in_app_purchase-library.html

Status for a PurchaseDetails.

```APIDOC
## PurchaseStatus

### Description
Status for a PurchaseDetails.

### Enum
`PurchaseStatus`
```

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

### Implement countryCode method

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/countryCode.html

This snippet shows the implementation of the countryCode method by delegating to the platform instance.

```dart
Future<String> countryCode() => InAppPurchasePlatform.instance.countryCode();
```

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

### queryProductDetails

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase-class.html

Retrieves product details for a specific set of product identifiers.

```APIDOC
## queryProductDetails

### Description
Query product details for the given set of IDs.

### Parameters
- **identifiers** (Set<String>) - Required - The set of product IDs to query.

### Response
- **Future<ProductDetailsResponse>** - The response containing product details.
```

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

### Define productDetails property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseParam/productDetails.html

Declaration of the productDetails property used to specify the item for purchase.

```dart
final ProductDetails productDetails;
```

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

### Implementation of productID

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/productID.html

The product identifier is defined as a final String property.

```dart
final String productID;
```

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

### PurchaseParam Class Definition

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseParam-class.html

Details regarding the constructor and properties of the PurchaseParam class.

```APIDOC
## PurchaseParam Class

### Description
The parameter object for generating a purchase.

### Constructors
- **PurchaseParam({required ProductDetails productDetails, String? applicationUserName})** - Creates a new purchase parameter object with the given data.

### Properties
- **applicationUserName** (String?) - Optional - An opaque id for the user's account that's unique to your app.
- **productDetails** (ProductDetails) - Required - The product to create payment for.
```

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

### buyNonConsumable

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase-class.html

Initiates the purchase process for a non-consumable product or subscription.

```APIDOC
## buyNonConsumable

### Description
Buy a non consumable product or subscription.

### Parameters
- **purchaseParam** (PurchaseParam) - Required - The parameters for the purchase.

### Response
- **Future<bool>** - Returns true if the purchase process was initiated successfully.
```

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

### Check store availability

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Verify if the underlying store is reachable before attempting purchase operations.

```dart
final bool available = await InAppPurchase.instance.isAvailable();
if (!available) {
  // The store cannot be reached or accessed. Update the UI accordingly.
}
```

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

### Accessing the description property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/description.html

The description property is a final String field representing the product's description.

```dart
final String description;
```

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

### Implementation of getPlatformAddition

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/getPlatformAddition.html

Returns the platform-specific instance of InAppPurchasePlatformAddition cast to the requested type.

```dart
@override
T getPlatformAddition<T extends InAppPurchasePlatformAddition?>() {
  return InAppPurchasePlatformAddition.instance as T;
}
```

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

### Access Android Product Details

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Cast ProductDetails to GooglePlayProductDetails to access SkuDetailsWrapper properties.

```dart
//import for GooglePlayProductDetails
import 'package:in_app_purchase_android/in_app_purchase_android.dart';
//import for SkuDetailsWrapper
import 'package:in_app_purchase_android/billing_client_wrappers.dart';

if (productDetails is GooglePlayProductDetails) {
  SkuDetailsWrapper skuDetails = (productDetails as GooglePlayProductDetails).skuDetails;
  print(skuDetails.introductoryPricePeriod);
}
```

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

### applicationUserName

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseParam/applicationUserName.html

An opaque id for the user's account that's unique to your app. It is used to help the store detect irregular activity. Do not pass in clear text, developer IDs, Apple IDs, or Google IDs; a one-way hash is recommended.

```APIDOC
## applicationUserName

### Description
An optional, opaque identifier for the user's account that is unique to your application. This field is used by the store to detect irregular activity.

### Type
String?

### Usage Note
Do not use clear text, developer IDs, Apple IDs, or Google IDs. It is recommended to use a one-way hash of the user's account name.
```

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

### completePurchase

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase-class.html

Marks a purchase as delivered to the user.

```APIDOC
## completePurchase

### Description
Mark that purchased content has been delivered to the user.

### Parameters
- **purchase** (PurchaseDetails) - Required - The purchase details to mark as complete.

### Response
- **Future<void>**
```

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

### Handle purchase update events

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Process purchase details by checking status and completing pending purchases.

```dart
void _listenToPurchaseUpdated(List<PurchaseDetails> purchaseDetailsList) {
  purchaseDetailsList.forEach((PurchaseDetails purchaseDetails) async {
    if (purchaseDetails.status == PurchaseStatus.pending) {
      _showPendingUI();
    } else {
      if (purchaseDetails.status == PurchaseStatus.error) {
        _handleError(purchaseDetails.error!);
      } else if (purchaseDetails.status == PurchaseStatus.purchased ||
                 purchaseDetails.status == PurchaseStatus.restored) {
        bool valid = await _verifyPurchase(purchaseDetails);
        if (valid) {
          _deliverProduct(purchaseDetails);
        } else {
          _handleInvalidPurchase(purchaseDetails);
        }
      }
      if (purchaseDetails.pendingCompletePurchase) {
        await InAppPurchase.instance
            .completePurchase(purchaseDetails);
      }
    }
  });
}
```

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

### String toString()

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError/toString.html

Returns a string representation of the IAPError object, including the code, source, message, and details.

```APIDOC
## String toString()

### Description
Returns a string representation of the IAPError object. This is primarily used for debugging or logging to provide useful information about the error state.

### Signature
`String toString()`

### Returns
- **String**: A formatted string containing the error code, source, message, and details.
```

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

### Access iOS Product Details

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Cast ProductDetails to AppStoreProductDetails or AppStoreProduct2Details to access native StoreKit properties.

```dart
//import for AppStoreProductDetails
import 'package:in_app_purchase_storekit/in_app_purchase_storekit.dart';
//import for SKProductWrapper
import 'package:in_app_purchase_storekit/store_kit_wrappers.dart';

if (productDetails is AppStoreProductDetails) {
  SKProductWrapper skProduct = (productDetails as AppStoreProductDetails).skProduct;
  print(skProduct.subscriptionGroupIdentifier);
}

// With StoreKit 2
import 'package:in_app_purchase_storekit/store_kit_2_wrappers.dart';

if (productDetails is AppStoreProduct2Details) {
   SK2Product product = (productDetails as AppStoreProduct2Details).sk2Product;
   print(product.subscription?.subscriptionGroupID);
}
```

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

### restorePurchases({String? applicationUserName})

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/restorePurchases.html

Restores all previous purchases. The applicationUserName parameter should match the one used during the initial purchase if applicable.

```APIDOC
## restorePurchases

### Description
Restores all previous purchases for the user. Restored purchases are delivered through the `purchaseStream` with a status of `PurchaseStatus.restored`.

### Signature
`Future<void> restorePurchases({String? applicationUserName})`

### Parameters
- **applicationUserName** (String?) - Optional - Should match the value sent in the initial `PurchaseParam`. Use `null` if none was specified.

### Usage Notes
- Listen for restored purchases on the `purchaseStream`.
- Validate receipts and call `completePurchase` for each restored item.
- This method does not return consumed products; consumable tracking must be handled on your own server.
```

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

### Define applicationUserName property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseParam/applicationUserName.html

The property is defined as a nullable String within the PurchaseParam class.

```dart
final String? applicationUserName;
```

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

### Register and remove StoreKit payment queue delegate

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Use InAppPurchaseStoreKitPlatformAddition to set or clear a delegate for handling StoreKit payment queue events on iOS.

```dart
//import for InAppPurchaseStoreKitPlatformAddition
import 'package:in_app_purchase_storekit/in_app_purchase_storekit.dart';

Future<void> initStoreInfo() async {
  if (Platform.isIOS) {
    var iosPlatformAddition = _inAppPurchase
            .getPlatformAddition<InAppPurchaseStoreKitPlatformAddition>();
    await iosPlatformAddition.setDelegate(ExamplePaymentQueueDelegate());
  }
}

@override
Future<void> disposeStore() {
  if (Platform.isIOS) {
    var iosPlatformAddition = _inAppPurchase
            .getPlatformAddition<InAppPurchaseStoreKitPlatformAddition>();
    await iosPlatformAddition.setDelegate(null);
  }
}
```

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

### Define price property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/price.html

Declaration of the price property as a final String.

```dart
final String price;
```

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

### IAPError(String source, String code, String message, dynamic details)

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError/IAPError.html

Creates a new IAP error object with the provided source, error code, message, and optional details.

```APIDOC
## IAPError Constructor

### Description
Creates a new IAP error object with the given error details.

### Signature
IAPError({required String source, required String code, required String message, dynamic details})

### Parameters
- **source** (String) - Required - The source of the error.
- **code** (String) - Required - The error code.
- **message** (String) - Required - The error message.
- **details** (dynamic) - Optional - Additional error details.
```

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

### Initialize pendingCompletePurchase

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/pendingCompletePurchase.html

Sets the initial state of the pendingCompletePurchase property to false.

```dart
bool pendingCompletePurchase = false;
```

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

### IAPError.toString implementation

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError/toString.html

Returns a formatted string containing the error code, source, message, and details for debugging.

```dart
@override
String toString() {
  return 'IAPError(code: $code, source: $source, message: $message, details: $details)';
}
```

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

### IAPError Class Overview

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/in_app_purchase-library.html

Captures an error from the underlying purchase platform.

```APIDOC
## IAPError

### Description
Captures an error from the underlying purchase platform.

### Class
`IAPError`
```

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

### purchaseStream

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/purchaseStream.html

A broadcast stream that provides real-time updates for purchase events. It is recommended to subscribe to this stream as early as possible in the application lifecycle to ensure no events are missed.

```APIDOC
## purchaseStream

### Description
Listen to this broadcast stream to receive real-time updates for purchases. This stream remains active as long as the application is running.

### Signature
`Stream<List<PurchaseDetails>> get purchaseStream`

### Usage Notes
- Subscribe to this stream as soon as the app launches, preferably before the main App Widget is initialized.
- Purchase updates occur for in-app triggers, platform-specific storefront triggers, restorations, and incomplete purchases from previous sessions.
- It is recommended to maintain only one active subscription to this stream at a time.
```

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

### currencySymbol property implementation

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/currencySymbol.html

The property is defined as a final String.

```dart
final String currencySymbol;
```

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

### PurchaseStatus Enum Values

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseStatus/values-constant.html

Provides access to the constant list of all possible PurchaseStatus values.

```APIDOC
## PurchaseStatus Enum

### Description
An enum representing the status of a purchase.

### Values Constant

#### `values` (List<PurchaseStatus>)

A constant List of the values in this enum, in order of their declaration.
```

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

### Accessing notFoundIDs property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetailsResponse/notFoundIDs.html

Declaration of the notFoundIDs list used to track failed product identifier fetches.

```dart
final List<String> notFoundIDs;
```

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

### restorePurchases Implementation

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/restorePurchases.html

The implementation of the restorePurchases method using the InAppPurchasePlatform instance.

```dart
Future<void> restorePurchases({String? applicationUserName}) =>
    InAppPurchasePlatform.instance.restorePurchases(applicationUserName: applicationUserName);
```

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

### completePurchase(PurchaseDetails purchase)

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/completePurchase.html

Marks a purchase as completed. This method must be called for every PurchaseDetails object where the status is PurchaseStatus.purchased or PurchaseStatus.restored.

```APIDOC
## completePurchase(PurchaseDetails purchase)

### Description
Mark that purchased content has been delivered to the user. You are responsible for completing every PurchaseDetails whose status is PurchaseStatus.purchased or PurchaseStatus.restored.

### Signature
`Future<void> completePurchase(PurchaseDetails purchase)`

### Parameters
- **purchase** (PurchaseDetails) - Required - The purchase details object to be completed.

### Exceptions
- Throws a `PurchaseException` if the purchase could not be finished.
- Completing a `PurchaseStatus.pending` purchase will cause an exception.

### Notes
- On iOS/macOS, failing to call this method leaves the transaction in the unfinished queue, causing it to be re-delivered on restart and preventing future purchases of the same product ID.
```

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

### InAppPurchaseException Class

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchaseException-class.html

The InAppPurchaseException class is thrown to indicate that an action failed while interacting with the in_app_purchase plugin.

```APIDOC
## InAppPurchaseException Class

Thrown to indicate that an action failed while interacting with the in_app_purchase plugin.

### Implemented types
* Exception

### Constructors
#### InAppPurchaseException({required String source, required String code, String? message})
Creates a InAppPurchaseException with the specified source and error `code` and optional `message`.

### Properties
* **code** → String - An error code. (final)
* **hashCode** → int - The hash code for this object. (inherited)
* **message** → String? - A human-readable error message, possibly null. (final)
* **runtimeType** → Type - A representation of the runtime type of the object. (inherited)
* **source** → String - Which source is the error on. (final)

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

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

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

### PurchaseVerificationData Class

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseVerificationData-class.html

Represents the data used to verify purchases. The 'source' property helps determine the verification method.

```APIDOC
## PurchaseVerificationData Class

### Description
Represents the data that is used to verify purchases. The property `source` helps you to determine the method to verify purchases. Different sources of purchase have different methods of verifying purchases. Both platforms have 2 ways to verify purchase data. You can either choose to verify the data locally using `localVerificationData` or verify the data using your own server with `serverVerificationData`. It is preferable to verify purchases using a server with `serverVerificationData`. You should never use any purchase data until verified.

### Constructor

#### PurchaseVerificationData

- **localVerificationData** (String) - Required - The data used for local verification.
- **serverVerificationData** (String) - Required - The data used for server verification.
- **source** (String) - Required - Indicates the source of the purchase.

### Properties

- **localVerificationData** (String) - The data used for local verification.
- **serverVerificationData** (String) - The data used for server verification.
- **source** (String) - Indicates the source of the purchase.
- **hashCode** (int) - The hash code for this object.
- **runtimeType** (Type) - A representation of the runtime type of the object.

### 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.
```

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

### Implementation of purchaseID

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/purchaseID.html

Defines the purchaseID property as a nullable String.

```dart
final String? purchaseID;
```

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

### Implementation of toString for InAppPurchaseException

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchaseException/toString.html

Overrides the default toString method to return a formatted string containing the exception code, message, and source.

```dart
@override
String toString() => 'InAppPurchaseException($code, $message, $source)';
```

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

### Accessing purchaseStream

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/purchaseStream.html

Implementation of the purchaseStream getter using the InAppPurchasePlatform instance.

```dart
Stream<List<PurchaseDetails>> get purchaseStream => InAppPurchasePlatform.instance.purchaseStream;
```

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

### Present iOS Code Redemption Sheet

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Use InAppPurchaseStoreKitPlatformAddition to trigger the native iOS offer code redemption UI.

```dart
InAppPurchaseStoreKitPlatformAddition iosPlatformAddition =
  InAppPurchase.getPlatformAddition<InAppPurchaseStoreKitPlatformAddition>();
iosPlatformAddition.presentCodeRedemptionSheet();
```

```dart
import 'package:in_app_purchase_storekit/in_app_purchase_storekit.dart';
```

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

### Access iOS Purchase Details

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Cast PurchaseDetails to AppStorePurchaseDetails or use SK2Transaction to access native transaction data.

```dart
//import for AppStorePurchaseDetails
import 'package:in_app_purchase_storekit/in_app_purchase_storekit.dart';
//import for SKProductWrapper
import 'package:in_app_purchase_storekit/store_kit_wrappers.dart';

if (purchaseDetails is AppStorePurchaseDetails) {
  SKPaymentTransactionWrapper skProduct = (purchaseDetails as AppStorePurchaseDetails).skPaymentTransaction;
  print(skProduct.transactionState);
}
```

```dart
//import for SK2TransactionWrapper
import 'package:in_app_purchase_storekit/store_kit_2_wrappers.dart';

List<SK2Transaction> transactions = await SK2Transaction.transactions();
print(transactions[0].jsonRepresentation);
```

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

### currencySymbol

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/currencySymbol.html

The currencySymbol property returns the currency symbol for the locale (e.g., '$' for US). If the symbol is unavailable, it returns the ISO 4217 currency code.

```APIDOC
## Property: currencySymbol

### Description
The currency symbol for the locale, e.g. $ for US locale. When the currency symbol cannot be determined, the ISO 4217 currency code is returned.

### Type
String

### Access
final
```

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

### Implementation of transactionDate

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/transactionDate.html

The definition of the transactionDate property within the purchase details class.

```dart
final String? transactionDate;
```

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

### Access iOS Purchase Details (StoreKit 1)

Source: https://pub.dev/packages/in_app_purchase

Cast PurchaseDetails to AppStorePurchaseDetails to access the SKPaymentTransactionWrapper and its transaction state.

```dart
//import for AppStorePurchaseDetails
import 'package:in_app_purchase_storekit/in_app_purchase_storekit.dart';
//import for SKProductWrapper
import 'package:in_app_purchase_storekit/store_kit_wrappers.dart';

if (purchaseDetails is AppStorePurchaseDetails) {
  SKPaymentTransactionWrapper skProduct = (purchaseDetails as AppStorePurchaseDetails).skPaymentTransaction;
  print(skProduct.transactionState);
}
```

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

### Manually trigger price consent dialog

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Invoke the price consent dialog manually when the default automatic display has been suppressed.

```dart
if (Platform.isIOS) {
  var iapStoreKitPlatformAddition = _inAppPurchase
      .getPlatformAddition<InAppPurchaseStoreKitPlatformAddition>();
  await iapStoreKitPlatformAddition.showPriceConsentIfNeeded();
}
```

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

### Future<String> countryCode()

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase/countryCode.html

Retrieves the user's country code. On Android, it returns the Play billing country code (ISO-3166-1 alpha2). On iOS, it returns the country code from SKStoreFront.

```APIDOC
## Future<String> countryCode()

### Description
Returns the user's country code. The implementation is platform-specific:
- **Android**: Returns the Play billing country code based on ISO-3166-1 alpha2 format.
- **iOS**: Returns the country code from SKStoreFrontWrapper.

### Signature
`Future<String> countryCode()`

### Returns
- **Future<String>** - A future that completes with the country code string.
```

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

### Upgrade or downgrade Google Play subscription

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Provide ChangeSubscriptionParam with old purchase details and replacement mode when upgrading or downgrading subscriptions on Google Play.

```dart
final PurchaseDetails oldPurchaseDetails = ...;
PurchaseParam purchaseParam = GooglePlayPurchaseParam(
    productDetails: productDetails,
    changeSubscriptionParam: ChangeSubscriptionParam(
        oldPurchaseDetails: oldPurchaseDetails,
        replacementMode: ReplacementMode.withTimeProration));
InAppPurchase.instance
    .buyNonConsumable(purchaseParam: purchaseParam);
```

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

### restorePurchases

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchase-class.html

Restores previous purchases made by the user.

```APIDOC
## restorePurchases

### Description
Restore all previous purchases.

### Parameters
- **applicationUserName** (String) - Optional - An optional identifier for the user.

### Response
- **Future<void>**
```

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

### Define serverVerificationData property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseVerificationData/serverVerificationData.html

Declaration of the final String property used for server verification data.

```dart
final String serverVerificationData;
```

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

### Access Android Purchase Details

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Cast PurchaseDetails to GooglePlayPurchaseDetails to access the original billing client purchase data.

```dart
//import for GooglePlayPurchaseDetails
import 'package:in_app_purchase_android/in_app_purchase_android.dart';
//import for PurchaseWrapper
import 'package:in_app_purchase_android/billing_client_wrappers.dart';

if (purchaseDetails is GooglePlayPurchaseDetails) {
  PurchaseWrapper billingClientPurchase = (purchaseDetails as GooglePlayPurchaseDetails).billingClientPurchase;
  print(billingClientPurchase.originalJson);
}
```

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

### Restore previous purchases

Source: https://pub.dev/documentation/in_app_purchase/latest/index.html

Trigger a restoration of past purchases, which will be emitted on the purchase stream.

```dart
await InAppPurchase.instance.restorePurchases();
```

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

### Define localVerificationData property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseVerificationData/localVerificationData.html

Declaration of the localVerificationData string property.

```dart
final String localVerificationData;
```

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

### PurchaseDetails Class Definition

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails-class.html

Details regarding the structure and properties of the PurchaseDetails class.

```APIDOC
## PurchaseDetails Class

### Description
Represents the transaction details of a purchase within the in-app purchase system.

### Properties
- **error** (IAPError?) - The error details when the status is PurchaseStatus.error.
- **pendingCompletePurchase** (bool) - Indicates if the developer must call InAppPurchasePlatform.completePurchase.
- **productID** (String) - The product identifier of the purchase.
- **purchaseID** (String?) - A unique identifier of the purchase.
- **status** (PurchaseStatus) - The current status of the purchase.
- **transactionDate** (String?) - The timestamp of the transaction.
- **verificationData** (PurchaseVerificationData) - The verification data of the purchase.
```

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

### PurchaseStatus Enum

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseStatus.html

The PurchaseStatus enum defines the possible states of an in-app purchase.

```APIDOC
## PurchaseStatus Enum

### Description
Status for a PurchaseDetails. This is the type for PurchaseDetails.status.

### Values

- **pending** → const PurchaseStatus
  The purchase process is pending. You can update UI to let your users know the purchase is pending.

- **purchased** → const PurchaseStatus
  The purchase is finished and successful. Update your UI to indicate the purchase is finished and deliver the product.

- **error** → const PurchaseStatus
  Some error occurred in the purchase. The purchasing process is aborted.

- **restored** → const PurchaseStatus
  The purchase has been restored to the device. You should validate the purchase and if valid deliver the content. Once the content has been delivered or if the receipt is invalid you should finish the purchase by calling the `completePurchase` method. More information on verifying purchases can be found here.

- **canceled** → const PurchaseStatus
  The purchase has been canceled. Update your UI to indicate the purchase is canceled.

### Properties

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

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

### Constants

- **values** → const List<PurchaseStatus>
  A constant List of the values in this enum, in order of their declaration.
```

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

### Access iOS Transaction Details (StoreKit 2)

Source: https://pub.dev/packages/in_app_purchase

Retrieve transaction details directly using the SK2Transaction class in StoreKit 2.

```dart
//import for SK2TransactionWrapper
import 'package:in_app_purchase_storekit/store_kit_2_wrappers.dart';

List<SK2Transaction> transactions = await SK2Transaction.transactions();
print(transactions[0].jsonRepresentation);
```

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

### Define IAPError source property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError/source.html

The source property is a final String that indicates where the error occurred.

```dart
final String source;
```

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

### IAPError Properties

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError-class.html

Properties available on the IAPError object.

```APIDOC
## Properties

- **code** (String) - The error code.
- **details** (dynamic) - Error details, possibly null.
- **message** (String) - A human-readable error message.
- **source** (String) - Which source is the error on.
```

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

### Accessing the rawPrice property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/rawPrice.html

The rawPrice property is a final double representing the unformatted price of a product.

```dart
final double rawPrice;
```

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

### Accessing the PurchaseStatus property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/status.html

Defines the status property within the PurchaseDetails class.

```dart
PurchaseStatus status;
```

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

### Accessing the currencyCode property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetails/currencyCode.html

The currencyCode property is a final String representing the currency of the product price.

```dart
final String currencyCode;
```

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

### Accessing the message property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/InAppPurchaseException/message.html

The message property is a nullable String that contains a human-readable error description.

```dart
final String? message;
```

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

### Accessing the details property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError/details.html

The details property is a dynamic field that holds error-specific information.

```dart
final dynamic details;
```

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

### Accessing the message property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError/message.html

The message property is a final String that contains the error details.

```dart
final String message;
```

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

### Presenting the iOS Code Redemption Sheet

Source: https://pub.dev/packages/in_app_purchase

Use this code to trigger the offer code redemption sheet on iOS 14 devices.

```dart
InAppPurchaseStoreKitPlatformAddition iosPlatformAddition =
  InAppPurchase.getPlatformAddition<InAppPurchaseStoreKitPlatformAddition>();
iosPlatformAddition.presentCodeRedemptionSheet();
```

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

### IAPError code property implementation

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/IAPError/code.html

Defines the string property used to store the error code.

```dart
final String code;
```

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

### Accessing the verificationData property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/verificationData.html

The verificationData property is a final field of type PurchaseVerificationData used for purchase validation.

```dart
final PurchaseVerificationData verificationData;
```

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

### Accessing the error property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/PurchaseDetails/error.html

The error property is used to retrieve purchase failure details when the status is PurchaseStatus.error.

```dart
IAPError? error;
```

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

### Accessing the error property

Source: https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/ProductDetailsResponse/error.html

The error property is defined as an optional IAPError type, representing any platform exception that occurred during the query.

```dart
final IAPError? error;
```
Tokens:
Raw