Cloud Code Services SDKs

PurchasesApi

Import

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

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(projectId: string, playerId: string, configAssignmentHash?: string, playerPurchaseVirtualRequest?: PlayerPurchaseVirtualRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PlayerPurchaseVirtualResponse>>

Enact a virtual purchase for a player.

summary

Make purchase

throws

{RequiredError}

memberof

PurchasesApi

Parameters
- projectId: string
- playerId: string
- Optional configAssignmentHash: string
- Optional playerPurchaseVirtualRequest: PlayerPurchaseVirtualRequest
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PlayerPurchaseVirtualResponse>>

Redeem Apple App Store Purchase

redeemAppleAppStorePurchase(projectId: string, playerId: string, configAssignmentHash?: string, playerPurchaseAppleappstoreRequest?: PlayerPurchaseAppleappstoreRequest, 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
- projectId: string
  
  ID of the project
- playerId: string
  
  ID of the player
- Optional configAssignmentHash: string
- Optional playerPurchaseAppleappstoreRequest: PlayerPurchaseAppleappstoreRequest
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PlayerPurchaseAppleappstoreResponse>>

Redeem Google Play Purchase

redeemGooglePlayPurchase(projectId: string, playerId: string, configAssignmentHash?: string, playerPurchaseGoogleplaystoreRequest?: PlayerPurchaseGoogleplaystoreRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<PlayerPurchaseGoogleplaystoreResponse>>

Redeem a Google Play store purchase for a player.

summary

Redeem Google Play Purchase

throws

{RequiredError}

memberof

PurchasesApi

Parameters
- projectId: string
  
  ID of the project
- playerId: string
  
  ID of the player
- Optional configAssignmentHash: string
- Optional playerPurchaseGoogleplaystoreRequest: PlayerPurchaseGoogleplaystoreRequest
- Optional options: AxiosRequestConfig
Returns Promise<AxiosResponse<PlayerPurchaseGoogleplaystoreResponse>>

PurchasesApi

Import

Import

Constructors

Constructor

Parameters

Optional configuration: Configuration

basePath: string = ...

axios: AxiosInstance = ...

Returns PurchasesApi

Methods

Make Virtual Purchase

Parameters

projectId: string

playerId: string

Optional configAssignmentHash: string

Optional playerPurchaseVirtualRequest: PlayerPurchaseVirtualRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<PlayerPurchaseVirtualResponse>>

Redeem Apple App Store Purchase

Parameters

projectId: string

playerId: string

Optional configAssignmentHash: string

Optional playerPurchaseAppleappstoreRequest: PlayerPurchaseAppleappstoreRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<PlayerPurchaseAppleappstoreResponse>>

Redeem Google Play Purchase

Parameters

projectId: string

playerId: string

Optional configAssignmentHash: string

Optional playerPurchaseGoogleplaystoreRequest: PlayerPurchaseGoogleplaystoreRequest

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<PlayerPurchaseGoogleplaystoreResponse>>