IAPService Class Reference

Static Public Member Functions
static Task	ConsumePurchase (string sku)
	Records the order fulfillment result for a consumable. More...
static Task< ProductList >	GetProductsBySKU (string[] skus)
	Gets a list of purchasable add-ons in the current app. More...
static Task< PurchaseList >	GetViewerPurchases ()
	Gets a list of purchased add-ons for a user, including durables and unfilfilled consumables. More...
static Task< Purchase >	LaunchCheckoutFlow (string sku, string price, string currency)
	Launches the checkout flow for a user to make a payment. More...
static Task< Purchase >	LaunchCheckoutFlow2 (Product product)
	Launches the checkout flow for a user to make a payment. More...
static Task< Purchase >	LaunchCheckoutFlow3 (Product product, string orderComment)
	Launches the checkout flow for a user to make a payment. More...
static Task< SubscriptionStatus >	GetSubscriptionStatus (string sku)
	Gets the subscription status of a subscription add-on. More...
static Task< ProductList >	GetNextProductListPage (ProductList list)
	Gets the next page of purchasable add-ons. More...
static Task< PurchaseList >	GetNextPurchaseListPage (PurchaseList list)
	Gets the next page of purchased add-ons. More...

Detailed Description

You can diversify user experience and grow your revenue by selling products such as cosmetics, props, and coins/diamonds within your app. The PICO Unity Integration SDK provides In-App Purchase (IAP) service which enables users to purchase products within your app. The IAP service packages a series of payments systems such as Alipay, bank card, and Paypal, thereby providing you with a one-stop multi-payment-method solution.

Member Function Documentation

ConsumePurchase()

static Task ConsumePurchase ( string  sku )

inlinestatic

Records the order fulfillment result for a consumable.

Note

Users are unable to repurchase the same comsumable until the previous order is fulfilled.

Parameters

sku	The SKU of the add-on to fulfill.

GetProductsBySKU()

static Task< ProductList > GetProductsBySKU ( string[]  skus )

inlinestatic

Gets a list of purchasable add-ons in the current app.

Parameters

skus	The SKUs of the add-ons to retrieve. If this parameter is empty, all purchasable add-ons will be returned.

Returns

A list of purchasable add-ons with their information, including the description, price, SKU, and more.

GetViewerPurchases()

static Task< PurchaseList > GetViewerPurchases ( )

inlinestatic

Gets a list of purchased add-ons for a user, including durables and unfilfilled consumables.

Returns

A list of the user's purchased add-ons.

LaunchCheckoutFlow()

static Task< Purchase > LaunchCheckoutFlow ( string  sku, string  price, string  currency  )

inlinestatic

Launches the checkout flow for a user to make a payment.

Deprecated:

LaunchCheckoutFlow(string sku,string price,string currency) can be replaced by LaunchCheckoutFlow2(Product product)

Note

This method doesn't support subscription add-ons, you need to use LaunchCheckoutFlow2 instead.

Parameters

sku	The SKU of the product the user wants to purchase.
price	The price for the product.
currency	The currency of the payment.

Returns

Returns the purchased product if the user successfully pays the money. Otherwise the purchase will be null. You can get the failure reason from the returned error code and error message.

LaunchCheckoutFlow2()

static Task< Purchase > LaunchCheckoutFlow2 ( Product  product )

inlinestatic

Launches the checkout flow for a user to make a payment.

Parameters

product

The add-on's information which can be acquired by GetProductsBySKU.

Returns

Returns the purchased add-on if the user successfully makes the payment. Otherwise the purchase will be null. You can get the failure reason from the returned error code and error message.

LaunchCheckoutFlow3()

static Task< Purchase > LaunchCheckoutFlow3 ( Product  product, string  orderComment  )

inlinestatic

Launches the checkout flow for a user to make a payment.

Parameters

product	The add-on's information which can be acquired by GetProductsBySKU.
orderComment	The comment for the order. If the user successfully purchases this add-on, The order's comment can be accessed in Purchase. The length of this field cannot exceed 1024 bytes in UTF-8 encoding.

Returns

Returns the purchased add-on if the user successfully makes the payment. Otherwise the purchase will be null. You can get the failure reason from the returned error code and error message.

GetSubscriptionStatus()

static Task< SubscriptionStatus > GetSubscriptionStatus ( string  sku )

inlinestatic

Gets the subscription status of a subscription add-on.

Parameters

sku	The SKU of the add-on.

Returns

The subscription status of the add-on. If the user is not entitled to access the add-on, the result will be an empty struct.

GetNextProductListPage()

static Task< ProductList > GetNextProductListPage ( ProductList  list )

inlinestatic

Gets the next page of purchasable add-ons.

Parameters

list	The current page of purchasable add-ons.

Returns

The next page of purchasable add-ons.

GetNextPurchaseListPage()

static Task< PurchaseList > GetNextPurchaseListPage ( PurchaseList  list )

inlinestatic

Gets the next page of purchased add-ons.

Parameters

list	The current page of purchased add-ons.

Returns

The next page of purchased add-ons.