Subtract User Virtual Currency
NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for version 2. Decrements the user’s balance of the specified virtual currency by the stated amount. It is possible to make a VC balance negative with this API.
Error codes
This operation may return the following PlayFab errors:
| Error | Code |
|---|---|
| APINotEnabledForGameClientAccess | 1082 |
| InvalidVirtualCurrency | 1051 |
| ProductDisabledForTitle | 1609 |
| VirtualCurrencyCurrentlyUnavailable | 1512 |
Authorizations
This API requires a client session ticket, available from any Client Login function.
Body
This API must be enabled for use as an option in the game manager website. It is disabled by default.
This API must be enabled for use as an option in the game manager website. It is disabled by default.
Amount to be subtracted from the user balance of the specified virtual currency.
Name of the virtual currency which is to be decremented.
The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
