CurrentApp.GetCustomerPurchaseIdAsync(String, String) Method


Retrieves a Microsoft Store ID key that can be used to grant entitlements for free products on behalf of the current user.

 static IAsyncOperation<Platform::String ^> ^ GetCustomerPurchaseIdAsync(Platform::String ^ serviceTicket, Platform::String ^ publisherUserId);
 static IAsyncOperation<winrt::hstring> GetCustomerPurchaseIdAsync(winrt::hstring const & serviceTicket, winrt::hstring const & publisherUserId);
public static IAsyncOperation<string> GetCustomerPurchaseIdAsync(string serviceTicket, string publisherUserId);
function getCustomerPurchaseIdAsync(serviceTicket, publisherUserId)
Public Shared Function GetCustomerPurchaseIdAsync (serviceTicket As String, publisherUserId As String) As IAsyncOperation(Of String)



An Azure Active Directory access token that identifies the publisher of the current app. For more information about generating this token, see Manage product entitlements from a service.


An anonymous ID that identifies the current user in the context of services that you manage as the publisher of the current app. If you maintain user IDs in the context of your services, you can use this parameter to associate your ID for the current user with the new Microsoft Store ID key (the user ID will be embedded in the key). Otherwise, if you don't need to associate a user ID with the Microsoft Store ID key, you can pass any string value.



The purchase ID key for the current user. This key is valid for 90 days.


Windows 10 requirements

Device family
Windows 10 (introduced in 10.0.10586.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v2.0)


Publishers with catalogs of in-app purchases can use the Microsoft Store ID key in service-to-service calls to the Microsoft Store purchase API to grant entitlements for free products on behalf of the current user. An entitlement represents the customer's right to use an app or in-app product (IAP) that is published through the Microsoft Store. For more information, see Manage product entitlements from a service.

Applies to

See also