CartLineDto
Represents a line item in a cart
custom_variablesCartLineCustomVariableDto[]RequiredSelected custom variables for this cart line.
descriptionstringRequired
The description of the custom variable
idFlakeIdRequired
identifierstringRequired
The unique identifier string for the custom variable
namestringRequired
The display name of the custom variable
optionsStorefrontCustomVariableOptionDto[]RequiredThe collection of available options for this custom variable. Only present for dropdown type
is_defaultbooleanRequired
Whether this option is selected by default when the custom variable is presented.
Only one option per custom variable should be marked as default.
namestringRequired
Display name shown to customers for this option.
priceintegerRequired
Additional price in the lowest denominator (e.g. cents) when this option is selected.
sort_orderintegerRequired
Sort order for displaying options to customers.
Lower numbers appear first.
valuestringRequired
Internal value used for product command variable replacement, without brackets.
typeenumRequired
Defines the type of input method for a custom variable.
Possible enum values
dropdownDropdown selection with predefined options. Customers choose from a list of available options. Allows for additional pricing based on the selected entry.
textFree-form text input. Customers can enter any text value (subject to validation).
numberNumeric input. Customers can enter numeric values (subject to validation).
valuestringRequired
The selected value of the custom variable
selected_optionStorefrontCustomVariableOptionDtoOptional
is_defaultbooleanRequired
Whether this option is selected by default when the custom variable is presented.
Only one option per custom variable should be marked as default.
namestringRequired
Display name shown to customers for this option.
priceintegerRequired
Additional price in the lowest denominator (e.g. cents) when this option is selected.
sort_orderintegerRequired
Sort order for displaying options to customers.
Lower numbers appear first.
valuestringRequired
Internal value used for product command variable replacement, without brackets.
line_keystringRequired
The unique key for this line item
namestringRequired
The name of the product
priceintegerRequired
The price of the product in the smallest currency unit (e.g., cents)
pricingStorefrontProductPricingDtoRequiredThe pricing details for the product in the storefront.
price_finalintegerRequired
The final price of the product after all discounts, in the lowest denominator (e.g. cents).
price_originalintegerRequired
The original price of the product before any discounts, in the lowest denominator (e.g. cents).
active_saleStorefrontSaleDtoOptional
begins_atstringRequired
The date and time when the sale begins.
discount_amountintegerRequired
The amount of the discount, either as a percentage in permille or as an absolute value in cents.
discount_typeenumRequired
Possible enum values
percentamount
idFlakeIdRequired
minimum_order_valueintegerRequired
The minimum order value required to apply the discount, in the lowest denominator (e.g. cents).
namestringRequired
The name of the sale.
version_idFlakeIdRequired
ends_atstringOptional
The date and time when the sale ends, if applicable.
regional_pricingStorefrontProductRegionalPricingDtoOptionalRegional pricing information for this product.
Only present if there is a regional pricing configured.
base_priceintegerRequired
The base price in the regional currency, in the lowest denominator (e.g. cents).
currencystringRequired
The currency code used in the region.
region_idstringRequired
The identifier for the region.
tax_inclusivebooleanRequired
Indicates whether the base price includes tax.
sale_valueintegerOptional
The amount of the sale discount in the lowest denominator (e.g. cents).
vat_rateSalesTaxEstimateDtoOptionalThe Sales Tax estimation for the passed in customer country / IP.
Include the tax percentage + abbreviation in your product view to inform your customers about the tax.
country_codestringRequired
The ISO country code.
country_namestringRequired
The full name of the country.
currencystringRequired
The local currency used in the country.
eservice_ratenumberRequired
The tax rate applicable for electronic services, as a percentage.
eu_member_statebooleanRequired
Indicates whether the country is a member of the European Union.
percentagenumberRequired
The VAT rate (synonym for EServiceRate).
vat_abbreviationstringRequired
The abbreviation of the tax term in the local language.
vat_local_namestringRequired
The full name of the tax term in the local language.
tax_number_abbreviationstringOptional
The abbreviation of the local tax identification number.
tax_number_local_namestringOptional
The name of the local tax identification number.
product_idFlakeIdRequired
quantityintegerRequired
The quantity of this product in the cart
slugstringRequired
The slug of the product
subscriptionbooleanRequired
Indicates whether this line item should be a subscription
trialbooleanRequired
Indicates whether this line will be trialied by the customer.
gift_to_customerStorefrontCustomerDtoOptionalA storefront representation of a customer in the PayNow system with their associated profiles and metadata.
idFlakeIdRequired
store_idFlakeIdRequired
minecraftStorefrontCustomerMinecraftProfileDtoOptionalA storefront representation of a customers Minecraft profile.
avatar_urlstringRequired
The URL to the player's Minecraft skin rendered as an avatar.
idstringRequired
The UUID of the Minecraft player.
If the platform is Minecraft Offline, this will be the name itself.
If the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID.
namestringRequired
The username of the Minecraft player.
minecraft_platformenumOptional
Possible enum values
unknownjavabedrock
minecraft_uuidstringOptional
The customer's Minecraft UUID, if they have linked their Minecraft account.
Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser,
and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.
namestringOptional
The display name for the customer.
profileCustomerGenericProfileDtoOptionalRepresents a generic platform profile for a customer.
idstringRequired
The platform-specific identifier for the profile.
namestringRequired
The display name of the user on this platform.
platformstringRequired
The name of the platform this profile belongs to.
avatar_urlstringOptional
The URL to the user's avatar image on this platform.
steamStorefrontCustomerSteamProfileDtoOptionalA storefront representation of a customers Steam profile.
avatar_urlstringRequired
The URL to the user's Steam avatar image.
idSteamIdRequired
A 64-bit Steam account identifier. Accepts string or numeric format.
namestringRequired
The display name of the user on Steam.
steam_idSteamIdOptional
A 64-bit Steam account identifier. Accepts string or numeric format.
xbox_xuidstringOptional
The customer's Xbox XUID, if available.
gift_to_customer_idFlakeIdOptional
image_urlstringOptional
The URL to the product image
selected_gameserverStorefrontGameServerDtoOptionalRepresents a simplified view of a game server for storefront display purposes.
enabledbooleanRequired
Indicates whether the game server is currently enabled.
idFlakeIdRequired
namestringRequired
The display name of the game server.
selected_gameserver_idFlakeIdOptional
Example
{
"custom_variables": [
{
"description": "string",
"id": "411486491630370816",
"identifier": "string",
"name": "string",
"options": [
{
"is_default": true,
"name": "string",
"price": 0,
"sort_order": 0,
"value": "string"
}
],
"type": "dropdown",
"value": "string",
"selected_option": {
"is_default": true,
"name": "string",
"price": 0,
"sort_order": 0,
"value": "string"
}
}
],
"line_key": "string",
"name": "string",
"price": 0,
"pricing": {
"price_final": 1499,
"price_original": 1999,
"active_sale": {
"begins_at": "2025-06-01T00:00:00Z",
"discount_amount": 2000,
"discount_type": "percent",
"id": "411486491630370816",
"minimum_order_value": 0,
"name": "Summer Sale",
"version_id": "411486491630370816",
"ends_at": "2025-06-30T23:59:59Z"
},
"sale_value": 500,
"vat_rate": {
"country_code": "CZ",
"country_name": "Czech Republic",
"currency": "CZK",
"eservice_rate": 21,
"eu_member_state": true,
"percentage": 21,
"vat_abbreviation": "DPH",
"vat_local_name": "Daň z přidané hodnoty",
"tax_number_abbreviation": "string",
"tax_number_local_name": "string"
},
"regional_pricing": {
"base_price": 1799,
"currency": "eur",
"region_id": "eu",
"tax_inclusive": true
}
},
"product_id": "411486491630370816",
"quantity": 0,
"slug": "string",
"subscription": true,
"trial": true,
"image_url": "string",
"selected_gameserver_id": "411486491630370816",
"selected_gameserver": {
"enabled": true,
"id": "411486491630370816",
"name": "string"
},
"gift_to_customer": {
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"minecraft_platform": "unknown",
"xbox_xuid": "string",
"name": "m0uka"
},
"gift_to_customer_id": "411486491630370816"
}