Skip to main content
POST
Subtract Character Virtual Currency

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json
Amount
number
required

Amount to be subtracted from the user balance of the specified virtual currency.

CharacterId
string
required

Unique PlayFab assigned ID for a specific character owned by a user

PlayFabId
string
required

Unique PlayFab assigned ID of the user on whom the operation will be performed.

VirtualCurrency
string
required

Name of the virtual currency which is to be decremented.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Example:
Last modified on October 1, 2026