UXsollaStoreSubsystem

Inherits from UGameInstanceSubsystem

Public Functions

Protected Functions

Protected Attributes

Public Functions Documentation

function UXsollaStoreSubsystem

1UXsollaStoreSubsystem()

function Initialize

1virtual void Initialize(
2    FSubsystemCollectionBase & Collection
3) override

function Deinitialize

1virtual void Deinitialize() override

function Initialize

1void Initialize(
2    const FString & InProjectId
3)

Initializes the controller with the provided Project ID (used to override project settings).

Parameters:

• InProjectId New Project ID value from Publisher Account. It can be found in Publisher Account next to the name of your project.

function GetPaginatedVirtualItems

 1void GetPaginatedVirtualItems(
 2    const FString & Locale,
 3    const FString & Country,
 4    const TArray< FString > & AdditionalFields,
 5    const FOnStoreItemsUpdate & SuccessCallback,
 6    const FOnError & ErrorCallback,
 7    const int Limit =50,
 8    const int Offset =0,
 9    const FString & AuthToken =TEXT("")
10)

Returns a list of virtual items according to pagination settings.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculated based on the user’s IP address if not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order and long_description.
• SuccessCallback Called after virtual items were successfully received.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page. The maximum number of elements on a page is 50.
• Offset Number of the element from which the list is generated (the count starts from 0).
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes items which are set to be available for purchase in the store. For each virtual item, complete data is returned. Attention: The number of items returned in a single response is limited. The default and maximum value is 50 items per response. To get more data page by page, use Limit and Offset fields. More about the use cases .

function GetVirtualItems

1void GetVirtualItems(
2    const FString & Locale,
3    const FString & Country,
4    const TArray< FString > & AdditionalFields,
5    const FOnStoreItemsUpdate & SuccessCallback,
6    const FOnError & ErrorCallback,
7    const FString & AuthToken =TEXT("")
8)

Returns a full list of virtual items.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculated based on the user’s IP address if not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order and long_description.
• SuccessCallback Called after virtual items were successfully received.
• ErrorCallback Called after the request resulted with an error.
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes items which are set to be available for purchase in the store. For each virtual item, complete data is returned. More about the use cases .

function GetItemGroups

1void GetItemGroups(
2    const FString & PromoCode,
3    const FOnItemGroupsUpdate & SuccessCallback,
4    const FOnError & ErrorCallback
5)

Returns a full list of virtual item groups.

Parameters:

• PromoCode Unique case sensitive code. Contains letters and numbers.
• SuccessCallback Called after virtual item groups were successfully received.
• ErrorCallback Called after the request resulted with an error.

The list includes groups which are set to be available for purchase in the store More about the use cases .

function GetPaginatedVirtualCurrencies

1void GetPaginatedVirtualCurrencies(
2    const FString & Locale,
3    const FString & Country,
4    const TArray< FString > & AdditionalFields,
5    const FOnVirtualCurrenciesUpdate & SuccessCallback,
6    const FOnError & ErrorCallback,
7    const int Limit =50,
8    const int Offset =0
9)

Returns a list of virtual currencies according to pagination settings.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order and long_description.
• SuccessCallback Called after virtual currencies were successfully received.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page. The maximum number of elements on a page is 50.
• Offset Number of the element from which the list is generated (the count starts from 0).

Attention: The number of currencies returned in a single response is limited. The default and maximum value is 50 currencies per response. To get more data page by page, use Limit and Offset fields. More about the use cases .

function GetVirtualCurrencies

1void GetVirtualCurrencies(
2    const FString & Locale,
3    const FString & Country,
4    const TArray< FString > & AdditionalFields,
5    const FOnVirtualCurrenciesUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Returns a full list of virtual currencies.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order and long_description.
• SuccessCallback Called after virtual currencies were successfully received.
• ErrorCallback Called after the request resulted with an error.

The list includes currencies which are set to be available for purchase in the store. More about the use cases .

function GetPaginatedVirtualCurrencyPackages

 1void GetPaginatedVirtualCurrencyPackages(
 2    const FString & Locale,
 3    const FString & Country,
 4    const TArray< FString > & AdditionalFields,
 5    const FOnVirtualCurrencyPackagesUpdate & SuccessCallback,
 6    const FOnError & ErrorCallback,
 7    const int Limit =50,
 8    const int Offset =0,
 9    const FString & AuthToken =TEXT("")
10)

Returns a list of virtual currency packages according to pagination settings.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after virtual currency packages were successfully received.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page. The maximum number of elements on a page is 50.
• Offset Number of the element from which the list is generated (the count starts from 0).
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes packages which are set to be available for purchase in the store. Attention: The number of packages returned in a single response is limited. The default and maximum value is 50 packages per response. To get more data page by page, use Limit and Offset fields. More about the use cases .

function GetVirtualCurrencyPackages

1void GetVirtualCurrencyPackages(
2    const FString & Locale,
3    const FString & Country,
4    const TArray< FString > & AdditionalFields,
5    const FOnVirtualCurrencyPackagesUpdate & SuccessCallback,
6    const FOnError & ErrorCallback,
7    const FString & AuthToken =TEXT("")
8)

Returns a full list of virtual currency packages.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after virtual currency packages were successfully received.
• ErrorCallback Called after the request resulted with an error.
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes packages which are set to be available for purchase in the store. More about the use cases .

function GetPaginatedItemsListBySpecifiedGroup

 1void GetPaginatedItemsListBySpecifiedGroup(
 2    const FString & ExternalId,
 3    const FString & Locale,
 4    const FString & Country,
 5    const TArray< FString > & AdditionalFields,
 6    const FOnGetItemsListBySpecifiedGroup & SuccessCallback,
 7    const FOnError & ErrorCallback,
 8    const int Limit =50,
 9    const int Offset =0,
10    const FString & AuthToken =TEXT("")
11)

Returns a list of items for the specified group according to pagination settings.

Parameters:

• ExternalId Group external ID.
• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after server response.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page. The maximum number of elements on a page is 50.
• Offset Number of the element from which the list is generated (the count start from 0).
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes items which are set to be available for purchase in the store. In the settings of the group, the display in the store must be enabled. Attention: The number of items returned in a single response is limited. The default and maximum value is 50 items per response. To get more data page by page, use Limit and Offset fields. More about the use cases .

function GetItemsListBySpecifiedGroup

1void GetItemsListBySpecifiedGroup(
2    const FString & ExternalId,
3    const FString & Locale,
4    const FString & Country,
5    const TArray< FString > & AdditionalFields,
6    const FOnGetItemsListBySpecifiedGroup & SuccessCallback,
7    const FOnError & ErrorCallback,
8    const FString & AuthToken =TEXT("")
9)

Returns a full list of items for the specified group.

Parameters:

• ExternalId Group external ID.
• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after server response.
• ErrorCallback Called after the request resulted with an error.
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes items which are set to be available for purchase in the store. In the settings of the group, the display in the store must be enabled. More about the use cases .

function GetAllItemsList

1void GetAllItemsList(
2    const FString & Locale,
3    const FOnGetItemsList & SuccessCallback,
4    const FOnError & ErrorCallback,
5    const FString & AuthToken =TEXT("")
6)

Returns a full list of virtual items.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• SuccessCallback Called after server response.
• ErrorCallback Called after the request resulted with an error.
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes items which are set to be available for purchase in the store. For each virtual item, the SKU, name, description, and data about the groups it belongs to are returned. More about the use cases .

function FetchPaymentToken

1void FetchPaymentToken(
2    const FString & AuthToken,
3    const FString & ItemSKU,
4    const FOnFetchTokenSuccess & SuccessCallback,
5    const FOnError & ErrorCallback,
6    const FXsollaPaymentTokenRequestPayload & PurchaseParams
7)

Creates an order for the specified item and returns the payment token and order ID.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• ItemSKU Desired item SKU.
• SuccessCallback Called after the payment token was successfully fetched. Returns both the payment token and order ID.
• ErrorCallback Called after the request resulted with an error.
• PurchaseParams (optional) Purchase and payment UI parameters, such as locale, currency, and bUseSteamOverlayForDesktop.

More about the use cases .

function FetchCartPaymentToken

1void FetchCartPaymentToken(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FOnFetchTokenSuccess & SuccessCallback,
5    const FOnError & ErrorCallback,
6    const FXsollaPaymentTokenRequestPayload & PurchaseParams
7)

Creates an order with items from the cart with the specified ID or from the cart of the current user.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of the cart for the purchase. The current user cart will be purchased if empty.
• SuccessCallback Called after the payment token was successfully fetched.
• ErrorCallback Called after the request resulted with an error.
• PurchaseParams (optional) Purchase and payment UI parameters, such as locale, currency, and bUseSteamOverlayForDesktop.

Returns the payment token and order ID. More about the use cases .

function LaunchPaymentConsole

1void LaunchPaymentConsole(
2    UObject * WorldContextObject,
3    const int32 OrderId,
4    const FString & AccessToken,
5    const FOnStoreSuccessPayment & SuccessCallback,
6    const FOnError & ErrorCallback,
7    const FOnStoreBrowserClosed & BrowserClosedCallback,
8    const EXsollaPayStationVersion PayStationVersion =EXsollaPayStationVersion::v4
9)

Opens payment UI for the provided payment token.

Parameters:

• WorldContextObject The world context.
• OrderId Order identifier.
• AccessToken Payment token used during purchase processing.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.
• BrowserClosedCallback Called after the browser is closed. The event is tracked only when the payment UI is opened in the built-in browser. External browser events can’t be tracked.
• PayStationVersion Pay Station version. V4 by default.

More about the use cases:

• Cart purchase
• Purchase in one click
• Ordering free items

function PurchaseItemBySku

1void PurchaseItemBySku(
2    const FString & AuthToken,
3    const FString & ItemSKU,
4    const FXsollaPaymentTokenRequestPayload & PurchaseParams,
5    const FOnPurchaseUpdate & SuccessCallback,
6    const FOnError & ErrorCallback,
7    const FOnStoreBrowserClosed & BrowserClosedCallback
8)

Initiates purchase for specified item SKU.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• ItemSKU Desired item SKU.
• PurchaseParams (optional) Purchase and payment UI parameters, such as locale, currency, and bUseSteamOverlayForDesktop.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.
• BrowserClosedCallback Called after the browser is closed. The event is tracked only when the payment UI is opened in the built-in browser. External browser events can’t be tracked.

function PurchaseCart

1void PurchaseCart(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FXsollaPaymentTokenRequestPayload & PurchaseParams,
5    const FOnPurchaseUpdate & SuccessCallback,
6    const FOnError & ErrorCallback,
7    const FOnStoreBrowserClosed & BrowserClosedCallback
8)

Initiates the purchase process for the cart with the specified ID or for the cart of the current user.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of the cart to purchase. If not specified, the current user’s cart will be used.
• PurchaseParams (optional) Purchase and payment UI parameters, such as locale, currency, and bUseSteamOverlayForDesktop.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.
• BrowserClosedCallback Called after the browser is closed. The event is tracked only when the payment UI is opened in the built-in browser. External browser events can’t be tracked.

function PurchaseFreeCart

1void PurchaseFreeCart(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FOnPurchaseUpdate & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Initiates the purchase process for the free cart with the specified ID or for the free cart of the current user.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of the cart to purchase. If not specified, the current user’s cart will be used.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.

function CheckOrder

1void CheckOrder(
2    const FString & AuthToken,
3    const int32 OrderId,
4    const FOnCheckOrder & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Checks pending order status by its ID.

Parameters:

• AuthToken User authorization token.
• OrderId Identifier of order to be checked.
• SuccessCallback Callback function called after successful order check. Order status will be received.
• ErrorCallback Callback function called after the request resulted with an error.

function CheckPendingOrder

1void CheckPendingOrder(
2    const FString & AccessToken,
3    const int32 OrderId,
4    const FOnStoreSuccessPayment & SuccessCallback,
5    const FOnError & ErrorCallback,
6    bool bIsUserInvolvedToPayment =false
7)

Checks pending order.

Parameters:

• AccessToken Payment token used during purchase processing.
• OrderId Identifier of order.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.
• bIsUserInvolvedToPayment Whether payment UI involved in purchase. true for purchase for real currency. false for free item purchase and purchase for virtual currency

function CreateOrderWithSpecifiedFreeItem

1void CreateOrderWithSpecifiedFreeItem(
2    const FString & AuthToken,
3    const FString & ItemSKU,
4    const FOnPurchaseUpdate & SuccessCallback,
5    const FOnError & ErrorCallback,
6    const int32 Quantity =1
7)

Create order with specified free item.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• ItemSKU Desired free item SKU.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.
• Quantity Item quantity.

The created order will get a done order status. More about the use cases .

function CreateOrderWithFreeCart

1void CreateOrderWithFreeCart(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FOnPurchaseUpdate & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Create order with free cart.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of the cart for the purchase. The current user cart will be purchased if empty.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.

The created order will get a done order status. More about the use cases .

function PurchaseStoreItem

1void PurchaseStoreItem(
2    const FString & AuthToken,
3    const FStoreItem & StoreItem,
4    const FXsollaPaymentTokenRequestPayload & PurchaseParams,
5    const FOnPurchaseUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Initiates purchase process for specified store item.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• StoreItem Desired store item.
• PurchaseParams (optional) Purchase and payment UI parameters, such as locale, currency, and bUseSteamOverlayForDesktop.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.

function PurchaseCurrencyPackage

1void PurchaseCurrencyPackage(
2    const FString & AuthToken,
3    const FVirtualCurrencyPackage & CurrencyPackage,
4    const FXsollaPaymentTokenRequestPayload & PurchaseParams,
5    const FOnPurchaseUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Initiate purchase process for specified currency package.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CurrencyPackage Desired currency package.
• PurchaseParams (optional) Purchase and payment UI parameters, such as locale, currency, and bUseSteamOverlayForDesktop.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.

function PurchaseBundle

1void PurchaseBundle(
2    const FString & AuthToken,
3    const FStoreBundle & Bundle,
4    const FXsollaPaymentTokenRequestPayload & PurchaseParams,
5    const FOnPurchaseUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Initiate purchase process for specified bundle.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• Bundle Desired bundle.
• PurchaseParams (optional) Purchase and payment UI parameters, such as locale, currency, and bUseSteamOverlayForDesktop.
• SuccessCallback Called after the payment was successfully completed.
• ErrorCallback Called after the request resulted with an error.

function ClearCart

1void ClearCart(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FOnStoreCartUpdate & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Removes all items from the cart with the specified ID or from the cart of the current user.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of a cart to be cleared.
• SuccessCallback Called after successful cart clearing.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function GetCart

1void GetCart(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FString & Currency,
5    const FString & Locale,
6    const FOnCartUpdate & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Returns a list of items from the cart with the specified ID or from the cart of the current user.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of the cart to be updated. The current user cart will be returned if empty.
• Currency Сurrency in which prices are displayed (USD by default). Three-letter currency code per ISO 4217 . Check the documentation for detailed information about currencies supported by Xsolla .
• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• SuccessCallback Called after cart is successfully received.
• ErrorCallback Called after the request resulted with an error.

For each item, complete data is returned. More about the use cases .

function UpdateItemInCart

1void UpdateItemInCart(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FString & ItemSKU,
5    const int32 Quantity,
6    const FOnStoreCartUpdate & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Updates the quantity of a previously added item in the cart with the specified ID or in the current user cart.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of a cart to which item will be added. The current user cart will be modified if empty.
• ItemSKU Desired item SKU.
• Quantity Number of items to be added to the cart.
• SuccessCallback Called after successfully updating item in the cart.
• ErrorCallback Called after the request resulted with an error.

If there is no item with the specified SKU in the cart, it will be added. More about the use cases .

function RemoveFromCart

1void RemoveFromCart(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FString & ItemSKU,
5    const FOnStoreCartUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Removes the item from the cart with the specified ID or from the cart of the current user.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of a cart from which the item will be removed.
• ItemSKU Desired item SKU.
• SuccessCallback Called after successfully removing an item from the cart.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function FillCartById

1void FillCartById(
2    const FString & AuthToken,
3    const FString & CartId,
4    const TArray< FStoreCartItem > & Items,
5    const FOnCartUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Fills the cart with the specified ID or the cart of the current user with items.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId (optional) Identifier of cart which will be filled.
• Items Array of items for filling the cart. If there is already an item with the same SKU in the cart, the existing item position will be replaced by the passed value.
• SuccessCallback Called after cart is successfully filled. Returns updated cart.
• ErrorCallback Called after the request resulted with an error.

If there is already an item with the same SKU in the cart, the existing item position will be replaced by the passed value. More about the use cases .

function GetSpecifiedBundle

1void GetSpecifiedBundle(
2    const FString & Sku,
3    const FOnGetSpecifiedBundleUpdate & SuccessCallback,
4    const FOnError & ErrorCallback,
5    const FString & AuthToken =TEXT("")
6)

Returns information about the contents of the specified bundle.

Parameters:

• Sku Bundle SKU.
• SuccessCallback Called after the cart is successfully filled.
• ErrorCallback Called after the request resulted with an error.
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

In the bundle settings, display in the store must be enabled. More about the use cases .

function GetPaginatedBundles

 1void GetPaginatedBundles(
 2    const FString & Locale,
 3    const FString & Country,
 4    const TArray< FString > & AdditionalFields,
 5    const FOnGetListOfBundlesUpdate & SuccessCallback,
 6    const FOnError & ErrorCallback,
 7    const int Limit =50,
 8    const int Offset =0,
 9    const FString & AuthToken =TEXT("")
10)

Returns a list of bundles according to pagination settings.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculated based on the user’s IP address if not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after bundles are successfully received.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page. The maximum number of elements on a page is 50.
• Offset Number of the element from which the list is generated (the count starts from 0).
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes bundles which are set to be available for purchase in the store. Attention: The number of bundles returned in a single response is limited. The default and maximum value is 50 bundles per response. To get more data page by page, use Limit and Offset fields. More about the use cases .

function GetBundles

1void GetBundles(
2    const FString & Locale,
3    const FString & Country,
4    const TArray< FString > & AdditionalFields,
5    const FOnGetListOfBundlesUpdate & SuccessCallback,
6    const FOnError & ErrorCallback,
7    const FString & AuthToken =TEXT("")
8)

Returns a full list of bundles.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculated based on the user’s IP address if not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after bundles are successfully received.
• ErrorCallback Called after the request resulted with an error.
• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ). Can be empty. If specified, the method returns items that match the personalization rules for the current user.

The list includes bundles which are set to be available for purchase in the store. More about the use cases .

function GetVirtualCurrency

1void GetVirtualCurrency(
2    const FString & CurrencySKU,
3    const FString & Locale,
4    const FString & Country,
5    const TArray< FString > & AdditionalFields,
6    const FOnCurrencyUpdate & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Returns a full list of virtual currencies.

Parameters:

• CurrencySKU Desired currency SKU.
• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculated based on the user’s IP address if not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after successful request of specified virtual currency data.
• ErrorCallback Called after the request resulted with an error.

The list includes currencies which are set to be available for purchase in the store. More about the use cases .

function GetVirtualCurrencyPackage

1void GetVirtualCurrencyPackage(
2    const FString & PackageSKU,
3    const FString & Locale,
4    const FString & Country,
5    const TArray< FString > & AdditionalFields,
6    const FOnCurrencyPackageUpdate & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Returns a virtual currency package with the specified SKU.

Parameters:

• PackageSKU Desired currency package SKU.
• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country to calculate regional prices and restrictions to catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculated based on the user’s IP address if not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order and long_description.
• SuccessCallback Called after successful request of specified virtual currency package data.
• ErrorCallback Called after the request resulted with an error.

The package must be set to be available for purchase in the store. More about the use cases .

function BuyItemWithVirtualCurrency

1void BuyItemWithVirtualCurrency(
2    const FString & AuthToken,
3    const FString & ItemSKU,
4    const FString & CurrencySKU,
5    const EXsollaPublishingPlatform Platform,
6    const FOnPurchaseUpdate & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Creates an order with a specified item.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• ItemSKU Desired item SKU.
• CurrencySKU SKU of virtual currency to buy virtual items with.
• Platform Publishing platform the user plays on.

Can be xsolla (default), playstation_network, xbox_live, pc_standalone, nintendo_shop, google_play, app_store_ios, android_standalone, ios_standalone, android_other, ios_other, or pc_other.

• SuccessCallback Called after the successful item purchase.
• ErrorCallback Called after the request resulted with an error.

The created order will get a new order status. More about the use cases .

function GetPromocodeRewards

1void GetPromocodeRewards(
2    const FString & AuthToken,
3    const FString & PromocodeCode,
4    const FOnGetPromocodeRewardsUpdate & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Returns a list of items that can be credited to the user when the promo code is redeemed.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• PromocodeCode Unique case sensitive code. Contains letters and numbers.
• SuccessCallback Called after successfully receiving promocode rewards.
• ErrorCallback Called after the request resulted with an error.

Allows users to choose from several available items. More about the use cases .

function RedeemPromocode

1void RedeemPromocode(
2    const FString & AuthToken,
3    const FString & PromocodeCode,
4    const FString & CartId,
5    const FOnPromocodeUpdate & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Redeems a promo code.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• PromocodeCode Unique case sensitive code. Contains letters and numbers.
• CartId Identifier of the cart.
• SuccessCallback Called after successful promocode redemption.
• ErrorCallback Called after the request resulted with an error.

After redeeming the promo code, the user gets free items and/or the price of the cart is reduced. More about the use cases .

function RemovePromocodeFromCart

1void RemovePromocodeFromCart(
2    const FString & AuthToken,
3    const FString & CartId,
4    const FOnPromocodeUpdate & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Removes a promo code from a cart.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• CartId Identifier of the cart.
• SuccessCallback Called after successful promocode redemption.
• ErrorCallback Called after the request resulted with an error.

After the promo code is removed, the total price of all items in the cart will be recalculated without bonuses and discounts provided by a promo code More about the use cases .

function GetGamesList

1void GetGamesList(
2    const FString & Locale,
3    const FString & Country,
4    const TArray< FString > & AdditionalFields,
5    const FOnStoreGamesUpdate & SuccessCallback,
6    const FOnError & ErrorCallback,
7    const int Limit =50,
8    const int Offset =0
9)

Returns list of games for building a catalog.

Parameters:

• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calcualtions are based on the user’s IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after successful request of specified games list data.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page.
• Offset Number of the element from which the list is generated (the count starts from 0).

function GetGamesListBySpecifiedGroup

 1void GetGamesListBySpecifiedGroup(
 2    const FString & ExternalId,
 3    const FString & Locale,
 4    const FString & Country,
 5    const TArray< FString > & AdditionalFields,
 6    const FOnGetGamesListBySpecifiedGroup & SuccessCallback,
 7    const FOnError & ErrorCallback,
 8    const int Limit =50,
 9    const int Offset =0
10)

Returns the list of games from the specified group for building a catalog.

Parameters:

• ExternalId Group external ID.
• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculations are based on the user’s IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after successful request of specified game list data.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page.
• Offset Number of the element from which the list is generated (the count starts from 0).

function GetGameItem

1void GetGameItem(
2    const FString & GameSKU,
3    const FString & Locale,
4    const FString & Country,
5    const TArray< FString > & AdditionalFields,
6    const FOnGameUpdate & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Returns a game key package from the catalog with the specified SKU.

Parameters:

• GameSKU SKU of a game key package.
• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculations are based on the user’s IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after successful request of specified game data.
• ErrorCallback Called after the request resulted with an error.

This method retrieves a catalog item that represents a game as a whole.

function GetGameKeyItem

1void GetGameKeyItem(
2    const FString & ItemSKU,
3    const FString & Locale,
4    const FString & Country,
5    const TArray< FString > & AdditionalFields,
6    const FOnGameKeyUpdate & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Returns a platform-specific game key package from the catalog with the specified SKU.

Parameters:

• ItemSKU SKU of a game key package for a specific platform. Format: _ (e.g., “my_game_steam”).

This method retrieves a catalog item that represents a purchasable package of game keys for a specific platform or DRM (for example, Steam or Epic Games Store).

Supported platform suffixes:

• Steam: steam
• PlayStation: playstation
• Xbox: xbox
• Uplay: uplay
• Origin: origin
• DRM Free: drmfree
• GOG: gog
• Epic Games Store: epicgames
• Nintendo Switch eShop: nintendo_eshop
• Discord Game Store: discord_game_store
• Oculus: oculus
• Viveport: viveport
• Google Stadia: stadia
• MY.GAMES Store: my_gameLocaleResponse language. Two-letter lowercase language code . Leave empty to use the default value.

CountryCountry for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculations are based on the user’s IP address if the country is not specified. Check the documentation for detailed information about countries supported by Xsolla .

AdditionalFieldsThe list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.

SuccessCallbackCalled after successful request of specified game data.

ErrorCallbackCalled after the request resulted with an error.

function GetGameKeysListBySpecifiedGroup

 1void GetGameKeysListBySpecifiedGroup(
 2    const FString & ExternalId,
 3    const FString & Locale,
 4    const FString & Country,
 5    const TArray< FString > & AdditionalFields,
 6    const FOnGetGameKeysListBySpecifiedGroup & SuccessCallback,
 7    const FOnError & ErrorCallback,
 8    const int Limit =50,
 9    const int Offset =0
10)

Returns a game key package list from the specified group for building a catalog.

Parameters:

• ExternalId Group external ID.
• Locale Response language. Two-letter lowercase language code . Leave empty to use the default value.
• Country Country for which to calculate regional prices and restrictions in a catalog. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Calculations are based on the user’s IP address in not specified. Check the documentation for detailed information about countries supported by Xsolla .
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields media_list, order, and long_description.
• SuccessCallback Called after successful request of specified game key data.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page.
• Offset Number of the element from which the list is generated (the count starts from 0).

function GetDRMList

1void GetDRMList(
2    const FOnDRMListUpdate & SuccessCallback,
3    const FOnError & ErrorCallback
4)

Returns the list of available DRMs.

Parameters:

• SuccessCallback Called after successful request of specified DRM data.
• ErrorCallback Called after the request resulted with an error.

function GetOwnedGames

1void GetOwnedGames(
2    const FString & AuthToken,
3    const TArray< FString > & AdditionalFields,
4    const FOnOwnedGamesListUpdate & SuccessCallback,
5    const FOnError & ErrorCallback,
6    const int Limit =50,
7    const int Offset =0,
8    const bool bIsSandbox =false
9)

Returns the list of games owned by the user.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• AdditionalFields The list of additional fields. These fields will be in a response if you send it in a request. Available fields attributes.
• SuccessCallback Called after successful request of specified owned games data.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page.
• Offset Number of the element from which the list is generated (the count starts from 0).
• bIsSandbox What type of entitlements should be returned. If the parameter is set to true, the entitlements received by the user in the sandbox mode only are returned. If the parameter is set to false, the entitlements received by the user in the live mode only are returned.

The response will contain an array of games owned by a particular user.

function RedeemGameCodeByClient

1void RedeemGameCodeByClient(
2    const FString & AuthToken,
3    const FString & Code,
4    const FOnRedeemGameCodeSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Grants an entitlement by a provided game key.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• Code Game key.
• SuccessCallback Called after successful redemption.
• ErrorCallback Called after the request resulted with an error.

function GetSubscriptionPublicPlans

 1void GetSubscriptionPublicPlans(
 2    const TArray< int > PlanId,
 3    const TArray< FString > & PlanExternalId,
 4    const FString & Country,
 5    const FString & Locale,
 6    const FOnSubscriptionPublicPlansListUpdate & SuccessCallback,
 7    const FOnError & ErrorCallback,
 8    const int Limit =50,
 9    const int Offset =0
10)

Returns a list of all plans, including plans purchased by the user while promotions are active.

Parameters:

• PlanId Array of subscription plan IDs. Plan ID can be found in the URL of the subscription details page in Publisher Account (https://publisher.xsolla.com/{merchant_id}/projects/{project_id}/subscriptions/plans/{merplan_id} ).
• PlanExternalId Array of subscription plan external IDs (32 characters per ID). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
• User’s country. Affects the choice of locale and currency. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• Locale Language of the UI. By default, it is determined by the user’s IP address.

Can be enforced by using two-letter lowercase language code .

• SuccessCallback Called after public plans have been successfully recieved.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page (15 elements are displayed by default).
• Offset Number of elements from which the list is generated (the count starts from 0).

More about the use cases .

function GetSubscriptionPlans

 1void GetSubscriptionPlans(
 2    const FString & AuthToken,
 3    const TArray< int > PlanId,
 4    const TArray< FString > & PlanExternalId,
 5    const FString & Country,
 6    const FString & Locale,
 7    const FOnSubscriptionPlansListUpdate & SuccessCallback,
 8    const FOnError & ErrorCallback,
 9    const int Limit =50,
10    const int Offset =0
11)

Returns a list of plans available to authorized users, including plans purchased by the user while promotions are active.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• PlanId Array of subscription plan IDs. Plan ID can be found in the URL of the subscription details page in Publisher Account (https://publisher.xsolla.com/{merchant_id}/projects/{project_id}/subscriptions/plans/{merplan_id} ).
• PlanExternalId Array of subscription plan external IDs (32 characters per ID). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
• Country User’s country. Affects the choice of locale and currency. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• Locale Language of the UI. By default, it is determined by the user’s IP address.

Can be enforced by using two-letter lowercase language code .

• SuccessCallback Called after a list of plans has been successfully recieved.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page (15 elements are displayed by default).
• Offset Number of elements from which the list is generated (the count starts from 0).

More about the use cases .

function GetSubscriptions

1void GetSubscriptions(
2    const FString & AuthToken,
3    const FString & Locale,
4    const FOnSubscriptionsListUpdate & SuccessCallback,
5    const FOnError & ErrorCallback,
6    const int Limit =50,
7    const int Offset =0
8)

Returns a list of active recurrent subscriptions that have the status active, non renewing, and pause.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• Locale Language of the UI. By default, it is determined by the user’s IP address.

Can be enforced by using two-letter lowercase language code .

• SuccessCallback Called after the list pf subscriptions has been successfully recieved.
• ErrorCallback Called after the request resulted with an error.
• Limit Limit for the number of elements on the page (15 elements are displayed by default).
• Offset Number of elements from which the list is generated (the count starts from 0).

More about the use cases .

function GetSubscriptionDetails

1void GetSubscriptionDetails(
2    const FString & AuthToken,
3    const int32 SubscriptionId,
4    const FString & Locale,
5    const FOnGetSubscriptionDetailsSuccess & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Returns information about a subscription by its ID.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• SubscriptionId Subscription ID.
• Locale Language of the UI. By default, it is determined by the user’s IP address.

Can be enforced by using two-letter lowercase language code .

• SuccessCallback Called after subscription data have been successfully recieved.
• ErrorCallback Called after the request resulted with an error.

Subscription can be have any status. More about the use cases .

function GetSubscriptionPurchaseUrl

 1void GetSubscriptionPurchaseUrl(
 2    const FString & AuthToken,
 3    const FString & PlanExternalId,
 4    const FString & Country,
 5    const FOnGetSubscriptionPayStationLinkSuccess & SuccessCallback,
 6    const FOnError & ErrorCallback,
 7    const int32 ProductId,
 8    const TArray< FString > & AvailablePlans,
 9    const FXsollaParameters & CustomParameters
10)

Returns Pay Station URL for the subscription purchase.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• PlanExternalId Subscription plan external ID (32 characters). Plan external ID can be found in Publisher Account in the Subscriptions > Subscription plans section next to the plan name.
• Country User’s country. Affects the choice of locale and currency. Two-letter uppercase country code per ISO 3166-1 alpha-2 . By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• SuccessCallback Called after the URL has been successfully recieved.
• ErrorCallback Called after the request resulted with an error.
• ProductId (optional) ID of the product associated with the subscription plan.
• AvailablePlans (optional) Subscription plan external IDs to show in payment UI.
• CustomParameters (optional) Map of custom parameters.

More about the use cases .

function GetSubscriptionPurchaseUrl

1inline void GetSubscriptionPurchaseUrl(
2    const FString & AuthToken,
3    const FString & PlanExternalId,
4    const FString & Country,
5    const FOnGetSubscriptionPayStationLinkSuccess & SuccessCallback,
6    const FOnError & ErrorCallback
7)

Backward-compatible C++ overload without optional payload fields.

function GetSubscriptionManagementUrl

 1void GetSubscriptionManagementUrl(
 2    const FString & AuthToken,
 3    const FString & Country,
 4    const FOnGetSubscriptionPayStationLinkSuccess & SuccessCallback,
 5    const FOnError & ErrorCallback,
 6    const int32 ProductId,
 7    const TArray< FString > & AvailablePlans,
 8    const FXsollaParameters & CustomParameters,
 9    const FString & SteamUserId
10)

Returns the URL of the management interface for the selected subscription.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• Country User’s country. Two-letter uppercase country code per ISO 3166-1 alpha-2 . Affects the choice of locale and currency. By default, it is determined by the user’s IP address. Check the documentation for detailed information about countries supported by Xsolla .
• SuccessCallback Called after the URL has been successfully recieved.
• ErrorCallback Called after the request resulted with an error.
• ProductId (optional) ID of the product associated with the subscription plan.
• AvailablePlans (optional) Subscription plan external IDs to show in payment UI.
• CustomParameters (optional) Map of custom parameters.
• SteamUserId (optional) Steam user ID.

More about the use cases .

function GetSubscriptionManagementUrl

1inline void GetSubscriptionManagementUrl(
2    const FString & AuthToken,
3    const FString & Country,
4    const FOnGetSubscriptionPayStationLinkSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Backward-compatible C++ overload without optional payload fields.

function GetSubscriptionRenewalUrl

1void GetSubscriptionRenewalUrl(
2    const FString & AuthToken,
3    const int32 SubscriptionId,
4    const FXsollaParameters & CustomParameters,
5    const FString & SteamUserId,
6    const FOnGetSubscriptionPayStationLinkSuccess & SuccessCallback,
7    const FOnError & ErrorCallback
8)

Returns the URL of the renewal interface for the selected subscription.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• SubscriptionId Subscription ID.
• CustomParameters (optional) Map of custom parameters.
• SteamUserId (optional) Steam user ID.
• SuccessCallback Called after the URL has been successfully recieved.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function GetSubscriptionUserAccountUrl

1void GetSubscriptionUserAccountUrl(
2    const FString & AuthToken,
3    const FString & Locale,
4    const FOnGetSubscriptionUserAccountUrlSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Returns URL of the user account interface for subscription management.

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• Locale Language of the UI. By default, it is determined by the user’s IP address.

Can be enforced by using two-letter lowercase language code .

• SuccessCallback Called after the URL has been successfully recieved.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function CancelSubscription

1void CancelSubscription(
2    const FString & AuthToken,
3    const int32 SubscriptionId,
4    const FOnCancelSubscriptionSuccess & SuccessCallback,
5    const FOnError & ErrorCallback
6)

Changes a regular subscription status to non_renewing (subscription is automatically canceled after expiration).

Parameters:

• AuthToken User authorization token obtained during authorization using Xsolla Login (more about authorization options ).
• SubscriptionId Subscription ID.
• SuccessCallback Called after successful subscription cancelling.
• ErrorCallback Called after the request resulted with an error.

More about the use cases .

function GetPendingPaystationUrl

1const FString & GetPendingPaystationUrl() const

Returns the Pay Station URL for the current pending payment.

The URL should be opened in a web browser to continue the payment process. If there is no pending payment, the returned string is empty.

function IsCustomTabsBrowserAvailable

1static bool IsCustomTabsBrowserAvailable(
2    UObject * WorldContextObject
3)

Checks whether Custom Tabs can be used on the current Android device to open payment UI.

Parameters:

• WorldContextObject The world context.

If the method returns false for Android build, WebView is used. For desktop builds, the method always returns false and doesn’t affect the way the payment UI is opened.

function GetVirtualItemsWithoutGroup

1static TArray< FStoreItem > GetVirtualItemsWithoutGroup(
2    const FStoreItemsData & StoreItemsData
3)

Returns a list of virtual items that are not assigned to any group.

function GetItemName

1static FString GetItemName(
2    const FStoreItemsData & StoreItemsData,
3    const FString & ItemSKU
4)

Returns name of the item with the given SKU.

function FindItemBySku