Skip to content

Clarify documentation gaps, update examples #11601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
LouiseHsu wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −1
Draft

Clarify documentation gaps, update examples #11601

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion packages/in_app_purchase/in_app_purchase/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ can start using the plugin. Two basic options are available:

1. A generic, idiomatic Flutter API: [in_app_purchase](https://pub.dev/documentation/in_app_purchase/latest/in_app_purchase/in_app_purchase-library.html).
This API supports most use cases for loading and making purchases.

> **NOTE**: On iOS and macOS, the generic API uses StoreKit 2 by default. If you need to fall back to StoreKit 1, call `InAppPurchaseStoreKitPlatform.enableStoreKit1()` before registering the platform.

2. Platform-specific Dart APIs: [store_kit_wrappers](https://pub.dev/documentation/in_app_purchase_storekit/latest/store_kit_wrappers/store_kit_wrappers-library.html)
and [billing_client_wrappers](https://pub.dev/documentation/in_app_purchase_android/latest/billing_client_wrappers/billing_client_wrappers-library.html).
Expand Down Expand Up @@ -196,6 +198,24 @@ if (_isConsumable(productDetails)) {
// Updates will be delivered to the `InAppPurchase.instance.purchaseStream`.
```

StoreKit 2 Specific Purchases (iOS/macOS)
When StoreKit 2 is enabled, you can use Sk2PurchaseParam to include StoreKit 2 specific parameters such as win-back offer identifiers or promotional offers with signatures.

```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,
);
```

### Completing a purchase

The `InAppPurchase.purchaseStream` will send purchase updates after initiating
Expand All @@ -209,7 +229,7 @@ purchase and the store can proceed to finalize the transaction and bill
the end user's payment account.

> **Warning:** Failure to call `InAppPurchase.completePurchase` and
> get a successful response within 3 days of the purchase will result a refund.
> get a successful response within 3 days of the purchase will result a refund on Android. On iOS (using StoreKit 2), failing to complete purchases can cause transactions to remain in the queue and be re-delivered on app start.

### Upgrading or downgrading an existing in-app subscription

Expand Down
Loading