IAP Overview - Amazon Vega Docs

The In-App Purchasing (IAP) API allows your app to present, process, and fulfill purchases of digital content and subscriptions within your app. Amazon supports an IAP API for Vega apps. This page gives a high-level introduction to the IAP API and the features available in the preview release. For more details about how to upgrade, see the following instructions.

What is In-App Purchasing (IAP)?

With In-App Purchasing (IAP), your app’s users can purchase various types of digital items within your app. This could include items such as extra lives for a game, or a subscription to premium content. The following are some potential use cases for IAP:

Create a “freemium” model for your app where the app itself is free, but you charge for advanced services or functionality.
Allow your customers to purchase items to enhance their gaming experience, such as currency, extra moves, or lives.
Unlock bonus levels or mini-games by allowing users to purchase access to this content.
Enable customers to subscribe to content available within your app.

The IAP API handles details about purchase flow, payment processing, app receipts, and managing rights to purchasable content. You do not have to code these things yourself.

Include the necessary package dependencies in your app

In the package.json file, add the @amazon-devices/keplerscript-appstore-iap-lib package as a dependency.

{
  "dependencies": {
    "@amazon-devices/keplerscript-appstore-iap-lib": "~2.13.0",
  }
},

IAP methods for Fire OS vs Vega

API	Description	Fire OS objects (Java)	Vega objects (JS)	Is Vega different from Fire OS	What’s different
`getUserData`	Initiates a request to retrieve the user ID of the currently logged-in user.	`UserDataRequest` `UserDataResponse`	`UserDataRequest` `UserDataResponse`	No	N/A
`getProductData`	Initiates a request to retrieve item data of up to 100 SKUs.	Sends a list of SKUs as part of the `getProductData` API call. `ProductDataResponse` provides the response.	`ProductDataRequest` `ProductDataResponse`	Yes	1. Price is a string in Fire OS, but in Vega it’s an object containing `currencyFormattedPrice`, `currencyCode`, `promotionPrice`, and `priceValue` in micros.2. The `promotionPlans` field inside the `Promotion` object changed to `plans` in Vega.3. `promotionPrice`, `promotionPriceCycles`, `promotionPricePeriod` changed to `price`, `priceCycles` and `period`.
`purchase`	Initiates a purchase-flow for a product.	Send Single SKU as part of purchase API call. `PurchaseResponse` provides the response.	`PurchaseRequest` `PurchaseResponse`	No	N/A
`getPurchaseUpdates`	Initiates a request to retrieve updates about items the customer has purchased or canceled. See “Note about device cache” at the end of this table.	Send reset flag as part of getPurchaseUpdates API call. `PurchaseUpdatesResponse` provides the response.	`PurchaseUpdatesRequest` `PurchaseUpdatesResponse`	No	N/A
`modifySubscription`	Initiates a `modifySubscription` request for a subscription.	send SKU and proration mode to modifySubscription API call. `ModifySubscriptionResponse` provides the response.	`ModifySubscriptionRequest` `ModifySubscriptionResponse`	No	N/A
`notifyFulfillment`	Notifies Amazon about the purchase fulfillment.	Send `receiptId` and `FulfillmentResult` in the request. It doesn’t send a response. It is a void call.	`NotifyFulfillmentRequest`	Yes	`NotifyFulfillmentResponseCode` is sent

IAP for Fire OS vs IAP for Vega

On Fire OS, the IAP SDK works with Android apps written in Java. On Vega, the IAP API integrates with the Vega SDK, written in JavaScript. Submit in-app items to the Amazon Appstore to implement the API for production features, like for Live App Testing. The following table lists the current IAP components supported by Vega.

IAP Component	Description	Documentation
IAP API	API used to run and fulfill in-app purchases	IAP API Overview
App Tester	Tool to test your apps locally	Configure the App Tester
Receipt Verification Service (RVS) Cloud Sandbox	Verify the validity of transaction receipts in sandbox mode	RVS for IAP Apps

​What is In-App Purchasing (IAP)?

​Include the necessary package dependencies in your app

​IAP methods for Fire OS vs Vega

​IAP for Fire OS vs IAP for Vega

What is In-App Purchasing (IAP)?

Include the necessary package dependencies in your app

IAP methods for Fire OS vs Vega

IAP for Fire OS vs IAP for Vega