StorefrontProductDto
allow_one_time_purchasebooleanRequired
Indicates whether one-time purchases are allowed.
allow_subscriptionbooleanRequired
Indicates whether subscription purchases are allowed.
currencystringRequired
The ISO three-letter lowercase currency code (e.g., usd, eur, gbp) the product is denominated in.
custom_variablesStorefrontCustomVariableDto[]RequiredCustom Variables associated with the product.
descriptionstringRequired
Description explaining what this custom variable is for. Can be shown to customers.
identifierstringRequired
Unique identifier string used to reference this custom variable programmatically.
Must contain only letters, numbers, underscores, and hyphens.
namestringRequired
Display name for the custom variable shown to customers.
optionsStorefrontCustomVariableOptionDto[]RequiredAvailable options for dropdown type custom variables.
Empty for text and number types.
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).
value_regexstringOptional
Optional regex pattern to validate text/number input values.
Only applies to text and number types.
Uses RE2 syntax - does not support negative lookarounds, backreferences, or other advanced regex features.
descriptionstringRequired
The detailed description of the product.
gameserversStorefrontGameServerDto[]RequiredThe game servers associated with the product.
enabledbooleanRequired
Indicates whether the game server is currently enabled.
idFlakeIdRequired
namestringRequired
The display name of the game server.
idFlakeIdRequired
is_affiliate_links_disabledbooleanRequired
Indicates whether affiliate links are disabled entirely for the product.
is_coupons_disabledbooleanRequired
Indicates whether coupons are disabled entirely for the product.
is_gift_cards_disabledbooleanRequired
Indicates whether gift cards are disabled entirely for the product.
is_gifting_disabledbooleanRequired
Indicates whether gifting is disabled for this product.
namestringRequired
The display name of the product.
priceintegerRequired
The price of the product, in the lowest denominator (e.g. cents).
remove_after_enabledbooleanRequired
Indicates whether automatic removal is enabled.
remove_after_time_scaleenumRequired
Possible enum values
invaliddayweekmonth
remove_after_time_valueintegerRequired
The time value for automatic removal.
single_game_server_onlybooleanRequired
Indicates whether the product is limited to a single game server.
slugstringRequired
The unique slug for the product.
sort_orderintegerRequired
The sort order for displaying the product.
store_idFlakeIdRequired
subscription_interval_scaleenumRequired
Possible enum values
invaliddayweekmonthyear
subscription_interval_valueintegerRequired
The subscription interval value.
trialStorefrontProductTrialDtoRequired
eligiblebooleanRequired
Indicates whether the customer is eligible for the trial period.
enabledbooleanRequired
Indicates whether the trial period is enabled for this product.
period_scaleenumRequired
Possible enum values
invaliddayweekmonthyear
period_valueintegerRequired
The duration value of the trial period.
version_idFlakeIdRequired
active_tier_groupCustomerTierGroupDtoOptional
active_product_idFlakeIdRequired
currencystringRequired
The settlement currency code (e.g., "usd").
next_billing_amountintegerRequired
The next billing amount in the smallest currency unit (e.g., cents) in the settlement currency.
next_billing_presentment_amountintegerRequired
The next billing amount in the smallest currency unit (e.g., cents) in the customer-facing presentment currency.
next_renewal_atstringRequired
The date and time of the next subscription renewal for this tier group.
presentment_currencystringRequired
The customer-facing presentment currency code (e.g., "eur").
tier_group_idFlakeIdRequired
pending_change_product_idFlakeIdOptional
created_atstringOptional
The date and time when the product was created.
deliverable_actionsProductDeliverableActionsDtoOptional
grant_giftcardbooleanRequired
Value indicating whether to grant a giftcard with the product with the subtotal amount.
enabled_atstringOptional
The date and time when the product becomes enabled.
enabled_untilstringOptional
The date and time until which the product remains enabled.
image_urlstringOptional
The URL to the product image.
labelstringOptional
The display label for the product.
metadataobjectOptional
Additional metadata for the product.
pricingStorefrontProductPricingDtoOptionalThe 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.
stockStorefrontProductStockDtoOptionalThe stock status information for the product in the storefront.
available_to_purchasebooleanRequired
Indicates whether the product is currently available for purchase (there is available stock).
customer_availableintegerRequired
The number of items available for the customer to purchase (customer stock limit remaining).
tier_group_idFlakeIdOptional
updated_atstringOptional
The date and time when the product was last updated.
Example
{
"allow_one_time_purchase": true,
"allow_subscription": true,
"currency": "string",
"custom_variables": [
{
"description": "string",
"identifier": "string",
"name": "string",
"options": [
{
"is_default": true,
"name": "string",
"price": 0,
"sort_order": 0,
"value": "string"
}
],
"type": "dropdown",
"value_regex": "string"
}
],
"description": "This premium package includes exclusive in-game items, bonus currency, and early access to new content.",
"gameservers": [
{
"enabled": true,
"id": "411486491630370816",
"name": "string"
}
],
"hidden": true,
"id": "411486491630370816",
"is_affiliate_links_disabled": true,
"is_coupons_disabled": true,
"is_gift_cards_disabled": true,
"is_gifting_disabled": true,
"name": "Premium Game Package",
"price": 1999,
"remove_after_enabled": true,
"remove_after_time_scale": "invalid",
"remove_after_time_value": 1,
"single_game_server_only": true,
"slug": "premium-game-package",
"sort_order": 0,
"store_id": "411486491630370816",
"subscription_interval_scale": "invalid",
"subscription_interval_value": 1,
"tags": [
{
"id": "411486491630370816",
"name": "Packages",
"slug": "packages"
}
],
"trial": {
"eligible": true,
"enabled": true,
"period_scale": "invalid",
"period_value": 0
},
"version_id": "411486491630370816",
"image_url": "https://cdn.paynow.gg/logo/full/logotype-color.svg",
"enabled_at": "2024-01-01T00:00:00Z",
"enabled_until": "2024-01-01T00:00:00Z",
"label": "Premium Items",
"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
}
},
"stock": {
"available_to_purchase": true,
"customer_available": 5
},
"deliverable_actions": {
"grant_giftcard": true
},
"metadata": {},
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z",
"tier_group_id": "411486491630370816",
"active_tier_group": {
"active_product_id": "411486491630370816",
"currency": "string",
"next_billing_amount": 0,
"next_billing_presentment_amount": 0,
"next_renewal_at": "2024-01-01T00:00:00Z",
"presentment_currency": "string",
"tier_group_id": "411486491630370816",
"pending_change_product_id": "411486491630370816"
}
}