Skip to main content
POST
Purchase Item

Authorizations

X-Authorization
string
header
required

This API requires a client session ticket, available from any Client Login function.

Body

application/json

Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation (with each item in a bundle being a distinct add).

Please note that the processing time for inventory grants and purchases increases fractionally the more items are in the inventory, and the more items are in the grant/purchase operation (with each item in a bundle being a distinct add).

ItemId
string
required

Unique identifier of the item to purchase.

Price
number
required

Price the client expects to pay for the item (in case a new catalog or store was uploaded, with new prices).

VirtualCurrency
string
required

Virtual currency to use to purchase the item.

CatalogVersion
string

Catalog version for the items to be purchased (defaults to most recent version.

CharacterId
string

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

CustomTags
object

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

StoreId
string

Store to buy this item through. If not set, prices default to those in the catalog.

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