Manage products from your services
Although a title can implement and manage an in-game commerce experience from the client app, there are scenarios and benefits to calling the Microsoft Store APIs directly from the game's web services. For example, the direct service-to-service communication is more trustworthy and reliable than traffic controlled through the user's network and client. These APIs consist of REST HTTPS endpoints that are designed to be used by developers with add-on catalogs that are supported by cross-platform services. These APIs include the following services and features:
Microsoft Store Collections Service:
- Verify direct ownership of a product outside of game-sharing.
- View products the user owns across the entire publisher catalog, not just the running title.
- Reliable and redundant safeguards around consumable product fulfillment.
- View a user's Xbox Game Pass subscription status (requires authorization from Microsoft)..
Microsoft Store Purchase Service:
- Grant free products to a user's account directly.
Microsoft Clawback Service:
- Detect refunds issued to a user for consumable products after they have been fulfilled.
Microsoft Recurrence Service:
- View, manage, or cancel a user's subscription (useful for Customer Support teams and in-game for users).
The following articles explain how to use these features and integrate them into your own services.
In this section
Authenticating your service with the Microsoft Store APIs
Describes how to get and use either delegated authentication XSTS tokens or User Store IDs to authenticate with Microsoft Store Services.
Query user entitlements from your services
Describes how to query for digital content the user is entitled to from your own services.
Detecting Xbox Game Pass subscription access from your service
Describes how to detect a user's Xbox Game Pass subscription status.
Managing subscription products from your service
Describes how to use the Recurrence service to query and manage your subscription products and handle the different subscription states of a user.
Managing consumable products from your service
Describes how to build a robust system that manages consumables on your game service including managing user refunds of consumed items.
Managing refunds and chargebacks from your service
Describes how to configure and use a Clawback event queue to detect refunds, returns, and chargebacks of your Consumable and Store-managed Subscription product types.
Requesting a User Store ID for service-to-service authentication
Describes the required configuration and steps to get a User Store ID for service-to-service authentication with the Microsoft Store service APIs.
Requesting a User Store ID from your service with XSTS tokens or OAuth 2.0
Describes how to generate a User Store ID on your service by using OAuth 2.0 and X-tokens without having to exchange Access Tokens to the client and calling the APIs on the client app.
Renewing a User Store ID key
Describes how to renew a User Store ID key.