character_vc_item_purchased - XBOX Game Development Documentation

This event is triggered when the character makes a purchase using virtual currency.

Properties

Name	Type	Description
CatalogVersion	String	Version of the catalog from which the item was purchased.
CurrencyCode	String	Currency that was used to purchase the item.
ItemId	String	Identifier of the catalog item that was purchased.
PlayerId	String
PurchaseId	String	Unique identifier of the purchase transaction.
Quantity	int32	Quantity of items that were purchased.
StoreId	String	The StoreId where the item was purchased.
TitleId	String
UnitPrice	uint32	Price paid per item, expressed in the virtual currency.

Common Properties

All V1 PlayStream events are formatted as JSON objects and share the following common properties:

Name	Type	Description
EntityId	String	The identifier for the entity (title, player, etc) to which this event applies.
EntityType	String	The type of entity (player, title, etc.) to which this event applies. If PlayFab is meant to take action on this entity, then the EntityType must be either ‘player’, ‘character’, or ‘title’. It is required that any entity type that PlayFab does not currently parse should be prepended with a namespace (like ‘com.mygame.guild’) as PlayFab may begin to parse root entities at any time.
EventId	String	PlayFab-assigned unique identifier for this event.
EventName	String	The name of this event.
EventNamespace	String	The assigned namespacing for this event. For example: ‘com.myprogram.ads’
Source	String	The name of the source of this PlayStream event; will be PlayFab if the event originated from us.
SourceType	SourceType	The type of source of this event (PlayFab partner, other backend, or from the PlayFab API).
Timestamp	DateTime	The time (in UTC) associated with this event.

Last modified on August 3, 2026

Related topics

PlayStream event model reference for PlayFab player_vc_item_purchased item_purchased items_purchased XR-007 Cross-Network Play — Multiplayer implementation

⌘I