ProductResult

idFlakeIdRequired

totalintegerRequired

productProductDtoOptional

allow_one_time_purchasebooleanRequired

Indicates whether one-time purchases are allowed.

allow_subscriptionbooleanRequired

Indicates whether subscription purchases are allowed.

commandsProductCommandDto[]Required

The commands to be executed at different stages.

contentstringRequired

Content of the command.

online_onlybooleanRequired

Value indicating whether the command should only execute when the player is online.

stageenumRequired

Defines the stages at which product commands can be executed.

Possible enum values

invalid
Represents an invalid or unspecified command stage.
on_purchase
Commands that should be executed when a product is purchased.
on_expire
Commands that should be executed when a product expires.
on_refund
Commands that should be executed when a product is refunded.
on_renew
Commands that should be executed when a subscription is renewed.
on_chargeback
Commands that should be executed when an order is charged back.
on_trial_start
Commands that should be executed when a trial is started.
on_trial_expire
Commands that should be executed when a trial expires.

override_execute_on_gameserver_idsFlakeId[]Optional

Value indicating on which game servers should the command be executed. If left empty or null, then the default behavior applies (executing on all game servers or on the selected game server is selection is enabled)

custom_variable_idsFlakeId[]Required

The IDs of associated custom variables.

customer_stock_limitProductStockLimitDtoRequired

enabledbooleanRequired

Indicates whether stock limit is enabled.

include_trialsbooleanRequired

Indicates if trials should be included in the active stock limit calculation.

time_scaleenumRequired

Possible enum values

invalid
day
week
month
year

quantityintegerOptional

The quantity limit.

time_valueintegerOptional

The time value for stock limit period.

descriptionstringRequired

The detailed description of the product.

gameserversProductGameServerDto[]Required

The game servers associated with the product.

enabledbooleanRequired

Indicates whether this game server is enabled.

idFlakeIdRequired

namestringRequired

The name of the game server.

idFlakeIdRequired

namestringRequired

The display name of the product.

payout_splitsProductPayoutSplitDto[]Required

The payout splits for revenue distribution.

platform_feeintegerRequired

The platform fee percentage your platform receives, in basis points (500 = 5%).

user_idFlakeIdRequired

percentageintegerOptional

The percentage of the payment allocated to the user, in basis points (500 = 5%). The last payout split must have this field set to `null` to receive the remaining portion.

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

invalid
day
week
month

remove_after_time_valueintegerRequired

The time value for automatic removal.

required_product_idsFlakeId[]Required

The IDs of products required for purchasing this product.

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.

stock_availableProductStockAvailableDtoRequired

customer_availableintegerRequired

store_availableintegerRequired

Indicates how many stock is left store-wide.

store_idFlakeIdRequired

store_stock_limitProductStockLimitDtoRequired

enabledbooleanRequired

Indicates whether stock limit is enabled.

include_trialsbooleanRequired

Indicates if trials should be included in the active stock limit calculation.

time_scaleenumRequired

Possible enum values

invalid
day
week
month
year

quantityintegerOptional

The quantity limit.

time_valueintegerOptional

The time value for stock limit period.

subscription_interval_scaleenumRequired

Possible enum values

invalid
day
week
month
year

subscription_interval_valueintegerRequired

The subscription interval value.

tagsProductTagDto[]Required

The tags associated with the product.

idFlakeIdRequired

namestringRequired

The display name of the tag.

slugstringRequired

The unique slug for the tag.

trialProductTrialConfigurationDtoRequired

Represents the configuration for trials of a product

allow_repeat_trialsbooleanRequired

Allows customers to trial again after a cooldown period following their previous trial. When disabled, customers can only trial once and never become eligible again.

enabledbooleanRequired

Indicates if trials should be enabled for the product.

new_customer_order_lookback_scaleenumRequired

Possible enum values

invalid
day
week
month
year

new_customer_order_lookback_valueintegerRequired

The lookback period value for determining if a customer is "new". Only used when new_customers_only is enabled.

new_customers_onlybooleanRequired

Restricts trials to customers who have no orders within the lookback period. When enabled, customers with recent orders will be ineligible for trials.

period_scaleenumRequired

Possible enum values

invalid
day
week
month
year

period_valueintegerRequired

The trial period value.

repeat_trial_cooldown_scaleenumRequired

Possible enum values

invalid
day
week
month
year

repeat_trial_cooldown_valueintegerRequired

The cooldown period value before a customer becomes eligible for another trial. Only used when allow_repeat_trial is enabled.

revoke_immediately_when_canceledbooleanRequired

Indicates if the trial should be revoked immediately when canceled or at the end of the trial.

upsellingProductUpsellConfigurationDtoRequired

enabledbooleanRequired

Indicates if upselling should be enabled for the product. If disabled, the product will never be recommended regardless of the global config.

recommendationsProductUpsellRecommendationDto[]Required

Upselling recommendation for the product.

→ ProductUpsellRecommendationDto

version_idFlakeIdRequired

allow_concurrent_active_itemsbooleanOptional

Indicates whether concurrent active items are allowed.

created_atstringOptional

The date and time when the product was created.

created_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

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.

is_affiliate_links_disabledbooleanOptional

Indicates if applying affiliate links should be disabled on the product.

is_coupons_disabledbooleanOptional

Indicates if applying coupons should be disabled on the product.

is_gift_cards_disabledbooleanOptional

Indicates if applying gift cards should be disabled on the product.

is_gifting_disabledbooleanOptional

Indicates whether gifting is disabled.

is_hiddenbooleanOptional

Indicates whether the product is hidden.

labelstringOptional

The display label for the product.

metadataobjectOptional

Additional metadata for the product.

required_product_allbooleanOptional

Indicates whether all required products are needed.

stock_limit_do_not_include_removedbooleanOptional

Indicates whether removed items should be excluded from stock limits.

tax_codeenumOptional

Determines the category of the product for taxation purposes. Contact support for help with setting the correct tax code.

Possible enum values

unknown
Unknown tax code.
digital_goods_subscription
You provide customers access to photographs, audiovisual works, audio works, and books, delivered electronically to a customer for non-permanent access, with right of use conditioned on continued payment to the seller.
digital_goods_permanent
You provide customers access to photographs, audiovisual works, audio works, and books, delivered electronically to a customer.
saas
SaaS: Pre-written software, delivered electronically. You provide customers access to a hosted software application, described as computer programs designed to permit the user to perform a group of coordinated functions, tasks, or activities. You are typically responsible for all aspects of making the software service available.
downloaded_software
Pre-written, non-custom computer software that is delivered electronically for download onto customers' devices/servers. No tangible personal property (e.g. CD-ROM, etc.) is delivered or used in conjunction with the download.
digital_goods_subscription_gaming
Cloud based or downloaded access to digital gaming services (used by default for game servers).
digital_goods_permanent_gaming
Permanent digital goods for gaming (not recommended).
iaas
Infrastructure as a Service: Providing users remote access to data center equipment and computing power.
paas
Platform as a Service: A cloud computing service bundle that includes both the infrastructure (servers, storage, and networking) and the middleware (development tools, business intelligence services, database management systems) that provides the customer a complete development and deployment environment in the cloud.
saas_security
Cloud-based SaaS, designed to secure customer data. Pre-written software, delivered electronically, designed specifically to provide protection of computer systems, software, or data against unauthorized access or intrusion. This includes separately charged maintenance and updates delivered electronically, whether included in the cost of the software or charged as a separate line item.
saas_storage
Cloud-based SaaS, designed to backup customer data. Pre-written software, delivered electronically, designed purely as storage for a customer's data. You provide customers access to a software product solely to facilitate the storage of digital products, digital codes, computer software or master copies of software. This includes separately charged maintenance and updates delivered electronically, whether included in the cost of the software or charged as a separate line item.

tier_group_idFlakeIdOptional

updated_atstringOptional

The date and time when the product was last updated.

updated_byActorDtoOptional

typeenumRequired

Possible enum values

anonymous
user
api_key
customer
game_server
internal
admin
platform
global_customer

idFlakeIdOptional

store_idFlakeIdOptional

Example

{
  "id": "411486491630370816",
  "total": 0,
  "store_id": "411486491630370816",
  "product": {
    "allow_one_time_purchase": true,
    "allow_subscription": true,
    "commands": [
      {
        "content": "string",
        "online_only": true,
        "stage": "invalid",
        "override_execute_on_gameserver_ids": [
          "411486491630370816"
        ]
      }
    ],
    "custom_variable_ids": [
      "411486491630370816"
    ],
    "customer_stock_limit": {
      "enabled": true,
      "include_trials": true,
      "time_scale": "invalid",
      "quantity": 0,
      "time_value": 0
    },
    "description": "string",
    "gameservers": [
      {
        "enabled": true,
        "id": "411486491630370816",
        "name": "US 2x TRIO"
      }
    ],
    "id": "411486491630370816",
    "name": "string",
    "payout_splits": [
      {
        "platform_fee": 0,
        "user_id": "411486491630370816",
        "percentage": 0
      }
    ],
    "price": 0,
    "remove_after_enabled": true,
    "remove_after_time_scale": "invalid",
    "remove_after_time_value": 0,
    "required_product_ids": [
      "411486491630370816"
    ],
    "single_game_server_only": true,
    "slug": "string",
    "sort_order": 0,
    "stock_available": {
      "customer_available": 0,
      "store_available": 0
    },
    "store_id": "411486491630370816",
    "store_stock_limit": {
      "enabled": true,
      "include_trials": true,
      "time_scale": "invalid",
      "quantity": 0,
      "time_value": 0
    },
    "subscription_interval_scale": "invalid",
    "subscription_interval_value": 0,
    "tags": [
      {
        "id": "411486491630370816",
        "name": "Packages",
        "slug": "packages"
      }
    ],
    "trial": {
      "allow_repeat_trials": true,
      "enabled": true,
      "new_customer_order_lookback_scale": "invalid",
      "new_customer_order_lookback_value": 0,
      "new_customers_only": true,
      "period_scale": "invalid",
      "period_value": 0,
      "repeat_trial_cooldown_scale": "invalid",
      "repeat_trial_cooldown_value": 0,
      "revoke_immediately_when_canceled": true
    },
    "upselling": {
      "enabled": true,
      "recommendations": [
        {
          "discount_amount": 0,
          "discount_type": "unknown",
          "prefer_as_subscription": true,
          "recommended_product_id": "411486491630370816",
          "type": "unknown",
          "minimum_base_product_quantity": 0,
          "minimum_recommended_product_quantity": 0,
          "quantity_to_add": 0
        }
      ]
    },
    "version_id": "411486491630370816",
    "image_url": "string",
    "label": "string",
    "stock_limit_do_not_include_removed": true,
    "created_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "created_at": "2024-01-01T00:00:00Z",
    "updated_by": {
      "type": "anonymous",
      "id": "411486491630370816"
    },
    "updated_at": "2024-01-01T00:00:00Z",
    "deliverable_actions": {
      "grant_giftcard": true
    },
    "metadata": {},
    "tax_code": "unknown",
    "allow_concurrent_active_items": true,
    "is_hidden": true,
    "is_gifting_disabled": true,
    "enabled_at": "2024-01-01T00:00:00Z",
    "enabled_until": "2024-01-01T00:00:00Z",
    "required_product_all": true,
    "is_gift_cards_disabled": true,
    "is_coupons_disabled": true,
    "is_affiliate_links_disabled": true,
    "tier_group_id": "411486491630370816"
  }
}