Cloud Code Services SDKs

PurchasesApi

Import

Import

const { PurchasesApi } = require("@unity-services/economy-2.4");

Constructors

Constructor

new PurchasesApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): PurchasesApi

Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns PurchasesApi

Methods

Make Virtual Purchase

makeVirtualPurchase(requestParameters: PurchasesApiMakeVirtualPurchaseRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PlayerPurchaseVirtualResponse>>

Make a virtual purchase for a player.

summary

Make virtual purchase

throws

{RequiredError}

memberof

PurchasesApi

Parameters
- requestParameters: PurchasesApiMakeVirtualPurchaseRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PlayerPurchaseVirtualResponse>>

Redeem Apple App Store Purchase

redeemAppleAppStorePurchase(requestParameters: PurchasesApiRedeemAppleAppStorePurchaseRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PlayerPurchaseAppleappstoreResponse>>

Redeem an Apple App Store purchase for a player.

summary

Redeem Apple App Store purchase

throws

{RequiredError}

memberof

PurchasesApi

Parameters
- requestParameters: PurchasesApiRedeemAppleAppStorePurchaseRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PlayerPurchaseAppleappstoreResponse>>

Redeem Google Play Purchase

redeemGooglePlayPurchase(requestParameters: PurchasesApiRedeemGooglePlayPurchaseRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PlayerPurchaseGoogleplaystoreResponse>>

Redeem a Google Play store purchase for a player.

summary

Redeem Google Play purchase

throws

{RequiredError}

memberof

PurchasesApi

Parameters
- requestParameters: PurchasesApiRedeemGooglePlayPurchaseRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PlayerPurchaseGoogleplaystoreResponse>>