OrderLineDTO
discount_amountintegerRequired
The discount amount of the order line, represented in cents
idstringRequired
The Flake ID of the Order Line
priceintegerRequired
The price of the Order Line
productProductDTORequired
allow_one_time_purchasebooleanRequired
Indicates if one-time purchases are supported on the product
allow_subscriptionbooleanRequired
Indicates if subscriptions are supported on the product
commandsProductCommandDTO[]RequiredThe commands associated with the product
contentstringRequired
The command to execute
online_onlybooleanRequired
Indicated if the command should be executed only when the customer is online
stagestringRequired
The stage of which the Product Command should be executed. Possible options: on_purchase, on_expire, on_refund, on_renew, on_chargeback, on_trial_start, on_trial_expire
descriptionstringRequired
The description of the product
enabledbooleanRequired
Indicates if the product is enabled.
gameserver_namesstringRequired
A comma-seperated string of all the game servers associated with the product
gameserversProductGameServerDTO[]RequiredThe game servers associated with the product
enabledbooleanRequired
Indicates if the Game Server is enabled
idstringRequired
The ID of the Game Server
namestringRequired
The name of the Game Server
idstringRequired
The Flake ID of the Product
metadataobjectRequired
The metadata of the product
namestringRequired
The name of the Product
priceintegerRequired
The price of the product, represented in cents.
remove_after_enabledbooleanRequired
Indicates whether automatic removal is enabled
single_game_server_onlybooleanRequired
Indicates if the customer must select a single game server when purchasing the product
slugstringRequired
The URL-Friendly Slug of the Product
sort_orderintegerRequired
The sort order of the product
store_idstringRequired
The Flake ID of the Store
tag_namesstringRequired
A comma-seperated string of all the tags associated with the product
tagsProductTagDTO[]RequiredThe tags associated with the product
idstringRequired
The Flake ID of the Product Tag
namestringRequired
The name of the Product Tag
slugstringRequired
The URL-Friendly slug of the Product Tag
version_idstringRequired
The Flake ID of the Version of the Product
created_atstringOptional
When the product was created
image_urlstringOptional
The Image URL of the product
labelstringOptional
The label of the product
remove_after_time_scalestringOptional
The scale of the time in which this product should be removed
remove_after_time_valueintegerOptional
The value of the time in which this product should be removed
subscription_interval_scalestringOptional
The value of the interval in which the product subscription renews at
subscription_interval_valueintegerOptional
The value of the interval in which the product subscription renews at
updated_atstringOptional
When the product was last updated
product_idstringRequired
The Flake ID of the Product ID associated with this Order Line
product_namestringRequired
The name of the product associated with this Order Line
product_version_idstringRequired
The Flake ID of the Product Version ID associated with this Order Line
quantityintegerRequired
The quantity of the Order Line
subtotal_amountintegerRequired
The subtotal amount of the order line, represented in cents
tax_amountintegerRequired
The tax amount of the order line, represented in cents
total_amountintegerRequired
The total amount of the order line, represented in cents
checkout_line_idstringOptional
The Flake ID of the Checkout Line associated with this Order Line
gift_to_customerCustomerDTOOptional
idstringRequired
The Flake ID of the Customer
minecraftMinecraftCustomerDTORequired
avatar_urlstringRequired
idstringRequired
namestringRequired
profileGenericProfileDTORequired
avatar_urlstringRequired
idstringRequired
namestringRequired
platformstringRequired
steamSteamCustomerDTORequired
avatar_urlstringRequired
The Steam Avatar URL
idstringRequired
SteamID64
namestringRequired
The name on the Steam Profile
namestringOptional
product_image_urlstringOptional
The Image URL of the Product associated with this Order Line
selected_gameserver_idstringOptional
The Flake ID of which was the selected Game Server ID for the Order Line
subscription_idstringOptional
The Flake ID of the Subscription associated with this Order Line
subscription_interval_scalestringOptional
The value of the scale in which the subscription associated with this Order Line renews at
subscription_interval_valueintegerOptional
The value of the interval in which the subscription associated with this Order Line renews at
subscription_line_idstringOptional
The Flake ID of the Subscription Line associated with this Order Line
trial_idstringOptional
The Flake ID of the Trial associated with this Order Line
Example
{
"id": "411486491630370816",
"product_id": "411486491630370816",
"product_version_id": "411486491630370816",
"product": {
"id": "411486491630370816",
"store_id": "411486491630370816",
"version_id": "411486491630370816",
"slug": "string",
"name": "string",
"description": "string",
"enabled": true,
"sort_order": 0,
"price": 0,
"single_game_server_only": true,
"allow_one_time_purchase": true,
"allow_subscription": true,
"remove_after_enabled": true,
"tags": [
{
"id": "411486491630370816",
"slug": "string",
"name": "string"
}
],
"tag_names": "string",
"gameservers": [
{
"id": "411486491630370816",
"name": "string",
"enabled": true
}
],
"gameserver_names": "string",
"commands": [
{
"stage": "on_purchase",
"content": "string",
"online_only": true
}
],
"metadata": {},
"image_url": "string",
"label": "string",
"subscription_interval_value": 1,
"subscription_interval_scale": "month",
"remove_after_time_value": 1,
"remove_after_time_scale": "month",
"created_at": "2024-01-01T00:00:00Z",
"updated_at": "2024-01-01T00:00:00Z"
},
"product_name": "string",
"price": 1000,
"quantity": 1,
"discount_amount": 0,
"subtotal_amount": 1000,
"tax_amount": 100,
"total_amount": 1100,
"checkout_line_id": "411486491630370816",
"product_image_url": "string",
"subscription_id": "411486491630370816",
"subscription_line_id": "411486491630370816",
"subscription_interval_value": 1,
"subscription_interval_scale": "month",
"trial_id": "411486491630370816",
"gift_to_customer": {
"id": "411486491630370816",
"steam": {
"id": "76561197960287930",
"name": "John",
"avatar_url": "string"
},
"minecraft": {
"id": "string",
"name": "Notch",
"avatar_url": "string"
},
"profile": {
"id": "string",
"platform": "string",
"name": "John",
"avatar_url": "string"
},
"name": "John"
},
"selected_gameserver_id": "411486491630370816"
}