Interface IEconomyPurchasesApiClientApi
The Purchases methods allow you to make virtual and real world purchases.
Namespace: Unity.Services.Economy
Syntax
public interface IEconomyPurchasesApiClientApiMethods
MakeVirtualPurchaseAsync(String, MakeVirtualPurchaseOptions)
Makes the specified virtual purchase using the items in the players inventory.
Takes a virtualPurchaseId. This is the ID of the purchase to make. Takes an optional list of instanceIds. These are the PlayersInventoryItems IDs of the items in the players inventory that should be used towards the cost(s) of the purchase. If these are not supplied, the items used towards the cost(s) will be chosen automatically.
Throws a EconomyException with a reason code and explanation if the request is badly formed, unauthorized or uses a missing resource.
Declaration
Task<MakeVirtualPurchaseResult> MakeVirtualPurchaseAsync(string virtualPurchaseId, MakeVirtualPurchaseOptions options = null)Parameters
| Type | Name | Description |
|---|---|---|
| String | virtualPurchaseId | Purchase ID of the purchase to be made |
| MakeVirtualPurchaseOptions | options | (Optional) Use to set a list of instance IDs to use towards the cost(s) of the purchase |
Returns
| Type | Description |
|---|---|
| Task<MakeVirtualPurchaseResult> |
Exceptions
| Type | Condition |
|---|---|
| EconomyException | Thrown if request is unsuccessful |
| EconomyValidationException | Thrown if the service returned validation error. |
| EconomyRateLimitedException | Thrown if the service returned rate limited error. |
RedeemAppleAppStorePurchaseAsync(RedeemAppleAppStorePurchaseArgs)
Redeems the specified Apple App Store purchase.
Throws a EconomyException with a reason code and explanation
Declaration
Task<RedeemAppleAppStorePurchaseResult> RedeemAppleAppStorePurchaseAsync(RedeemAppleAppStorePurchaseArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| RedeemAppleAppStorePurchaseArgs | args | The Apple App Store purchase details for the request |
Returns
| Type | Description |
|---|---|
| Task<RedeemAppleAppStorePurchaseResult> |
Exceptions
| Type | Condition |
|---|---|
| EconomyException | Thrown if request is unsuccessful |
| EconomyValidationException | Thrown if the service returned validation error. |
| EconomyRateLimitedException | Thrown if the service returned rate limited error. |
| EconomyAppleAppStorePurchaseFailedException | Thrown if the purchase fails in one of the following ways: invalid receipt, purchase already redeemed, product ID mismatch, product ID not defined, currency max would be exceeded. |
RedeemGooglePlayPurchaseAsync(RedeemGooglePlayStorePurchaseArgs)
Redeems the specified Google Play Store Store purchase.
Throws a EconomyException with a reason code and explanation
Declaration
Task<RedeemGooglePlayPurchaseResult> RedeemGooglePlayPurchaseAsync(RedeemGooglePlayStorePurchaseArgs args)Parameters
| Type | Name | Description |
|---|---|---|
| RedeemGooglePlayStorePurchaseArgs | args | The Google Play Store purchase details for the request. |
Returns
| Type | Description |
|---|---|
| Task<RedeemGooglePlayPurchaseResult> |
Exceptions
| Type | Condition |
|---|---|
| EconomyException | Thrown if request is unsuccessful |
| EconomyValidationException | Thrown if the service returned validation error. |
| EconomyRateLimitedException | Thrown if the service returned rate limited error. |
| EconomyGooglePlayStorePurchaseFailedException | Thrown if the purchase fails in one of the following ways: invalid purchase data, invalid purchase data signature, purchase already redeemed, product ID mismatch, product ID not defined, currency max would be exceeded. |