> For the complete documentation index, see [llms.txt](https://docs.paynow.gg/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.paynow.gg/storefront-headless/storefront-api/orders.md).

# Orders

## Get orders

> Retrieves all orders for the specified customer token.\
> {% hint style="warning" %}\
> This endpoint is only available for stores that use Steam based authentication.\
> {% endhint %}

```json
{"openapi":"3.1.1","info":{"title":"PayNow Storefront (Headless) API","version":"v1"},"tags":[{"name":"orders"}],"security":[{"Customer":[]}],"components":{"securitySchemes":{"Customer":{"type":"apiKey","description":"A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id"},"StorefrontOrderDto":{"required":["currency","customer","customer_id","discount_amount","discount_amount_str","giftcard_usage_amount","giftcard_usage_amount_str","id","is_subscription","lines","presentment_currency","presentment_discount_amount","presentment_discount_amount_str","presentment_giftcard_usage_amount","presentment_giftcard_usage_amount_str","presentment_subtotal_amount","presentment_subtotal_amount_str","presentment_tax_amount","presentment_tax_amount_str","presentment_total_amount","presentment_total_amount_str","pretty_id","status","store_id","subtotal_amount","subtotal_amount_str","tax_amount","tax_amount_str","total_amount","total_amount_str","type"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"pretty_id":{"type":"string","description":"Human-readable identifier for the order.","readOnly":true},"store_id":{"$ref":"#/components/schemas/FlakeId"},"customer_id":{"$ref":"#/components/schemas/FlakeId"},"customer":{"$ref":"#/components/schemas/StorefrontCustomerDto"},"status":{"$ref":"#/components/schemas/OrderStatus"},"type":{"$ref":"#/components/schemas/OrderType"},"checkout_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_id":{"$ref":"#/components/schemas/FlakeId"},"is_subscription":{"type":"boolean","description":"Indicates whether this order is a subscription order."},"currency":{"type":"string","description":"Currency code used for this order."},"discount_amount":{"type":"integer","description":"The total discount amount applied to this order in smallest currency unit","format":"int32"},"discount_amount_str":{"type":"string","description":"The discount amount formatted as a string"},"subtotal_amount":{"type":"integer","description":"The subtotal amount for this order in smallest currency unit","format":"int32"},"subtotal_amount_str":{"type":"string","description":"The subtotal amount formatted as a string"},"tax_amount":{"type":"integer","description":"The tax amount for this order in smallest currency unit","format":"int32"},"tax_amount_str":{"type":"string","description":"The tax amount formatted as a string"},"total_amount":{"type":"integer","description":"The total amount for this order in smallest currency unit","format":"int32"},"total_amount_str":{"type":"string","description":"The total amount formatted as a string"},"giftcard_usage_amount":{"type":"integer","description":"The amount of gift card value used for this order in smallest currency unit","format":"int32"},"giftcard_usage_amount_str":{"type":"string","description":"The gift card usage amount formatted as a string"},"presentment_currency":{"type":"string","description":"The presentment currency code used for this order (currency shown to customer)"},"presentment_subtotal_amount":{"type":"integer","description":"The presentment subtotal amount in smallest currency unit","format":"int32"},"presentment_subtotal_amount_str":{"type":"string","description":"The presentment subtotal amount formatted as a string","readOnly":true},"presentment_discount_amount":{"type":"integer","description":"The presentment discount amount in smallest currency unit","format":"int32"},"presentment_discount_amount_str":{"type":"string","description":"The presentment discount amount formatted as a string","readOnly":true},"presentment_giftcard_usage_amount":{"type":"integer","description":"The presentment gift card usage amount in the smallest currency unit","format":"int32"},"presentment_giftcard_usage_amount_str":{"type":"string","description":"The presentment gift card usage amount formatted as a string","readOnly":true},"presentment_tax_amount":{"type":"integer","description":"The presentment tax amount in smallest currency unit","format":"int32"},"presentment_tax_amount_str":{"type":"string","description":"The presentment tax amount formatted as a string","readOnly":true},"presentment_total_amount":{"type":"integer","description":"The presentment total amount in the smallest currency unit","format":"int32"},"presentment_total_amount_str":{"type":"string","description":"The presentment total amount formatted as a string","readOnly":true},"billing_cycle_sequence":{"type":["null","integer"],"description":"Sequence number of the billing cycle, if this order is associated with a subscription.","format":"int32"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontOrderLineDto"},"description":"Line items associated with this order."},"created_at":{"type":["null","string"],"description":"Date and time when the order was created.","format":"date-time"},"completed_at":{"type":["null","string"],"description":"Date and time when the order was completed.","format":"date-time"},"canceled_at":{"type":["null","string"],"description":"Date and time when the order was canceled.","format":"date-time"}},"additionalProperties":false,"description":"Data transfer object representing a store order."},"StorefrontCustomerDto":{"required":["id","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"profile":{"$ref":"#/components/schemas/CustomerGenericProfileDto"},"steam_id":{"$ref":"#/components/schemas/SteamId"},"steam":{"$ref":"#/components/schemas/StorefrontCustomerSteamProfileDto"},"minecraft_uuid":{"type":["null","string"],"description":"The customer's Minecraft UUID, if they have linked their Minecraft account.\nNot set for offline Minecraft stores. If the platform type is Minecraft - Geyser,\nand the profile is a bedrock account, this will be a UUID generated from the Xbox XUID."},"minecraft":{"$ref":"#/components/schemas/StorefrontCustomerMinecraftProfileDto"},"minecraft_platform":{"$ref":"#/components/schemas/CustomerMinecraftPlatform"},"xbox_xuid":{"type":["null","string"],"description":"The customer's Xbox XUID, if available."},"name":{"type":["null","string"],"description":"The display name for the customer."}},"additionalProperties":false,"description":"A storefront representation of a customer in the PayNow system with their associated profiles and metadata."},"CustomerGenericProfileDto":{"required":["id","name","platform"],"type":"object","properties":{"id":{"type":"string","description":"The platform-specific identifier for the profile."},"platform":{"type":"string","description":"The name of the platform this profile belongs to."},"name":{"type":"string","description":"The display name of the user on this platform."},"avatar_url":{"type":["null","string"],"description":"The URL to the user's avatar image on this platform."}},"additionalProperties":false,"description":"Represents a generic platform profile for a customer."},"SteamId":{"type":"string","additionalProperties":false,"description":"A 64-bit Steam account identifier. Accepts string or numeric format.","format":"steam-id"},"StorefrontCustomerSteamProfileDto":{"required":["avatar_url","id","name"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/SteamId"},"name":{"type":"string","description":"The display name of the user on Steam."},"avatar_url":{"type":"string","description":"The URL to the user's Steam avatar image."}},"additionalProperties":false,"description":"A storefront representation of a customers Steam profile."},"StorefrontCustomerMinecraftProfileDto":{"required":["avatar_url","id","name"],"type":"object","properties":{"id":{"type":"string","description":"The UUID of the Minecraft player.\nIf the platform is Minecraft Offline, this will be the name itself.\nIf the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID."},"name":{"type":"string","description":"The username of the Minecraft player."},"avatar_url":{"type":"string","description":"The URL to the player's Minecraft skin rendered as an avatar."}},"additionalProperties":false,"description":"A storefront representation of a customers Minecraft profile."},"CustomerMinecraftPlatform":{"enum":["unknown","java","bedrock"],"type":"string"},"OrderStatus":{"enum":["created","completed","canceled","refunded","chargeback"],"type":"string"},"OrderType":{"enum":["one_time","subscription_initial","subscription_renewal","subscription_proration","mixed"],"type":"string","description":"Defines the type of items contained in an order"},"StorefrontOrderLineDto":{"required":["checkout_line_id","discount_amount","discount_amount_str","gift","giftcard_usage_amount","giftcard_usage_amount_str","id","presentment_discount_amount","presentment_discount_amount_str","presentment_giftcard_usage_amount","presentment_giftcard_usage_amount_str","presentment_subtotal_amount","presentment_subtotal_amount_str","presentment_tax_amount","presentment_tax_amount_str","presentment_total_amount","presentment_total_amount_str","price","price_str","product_id","product_image_url","product_name","product_version_id","quantity","subtotal_amount","subtotal_amount_str","tax_amount","tax_amount_str","tax_inclusive","total_amount","total_amount_str"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"checkout_line_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_line_id":{"$ref":"#/components/schemas/FlakeId"},"trial_id":{"$ref":"#/components/schemas/FlakeId"},"product_id":{"$ref":"#/components/schemas/FlakeId"},"product_version_id":{"$ref":"#/components/schemas/FlakeId"},"product_name":{"type":"string","description":"Name of the product associated with this order line."},"product_image_url":{"type":"string","description":"URL for the product image."},"subscription_interval_value":{"type":["null","integer"],"description":"Numeric value of the subscription billing interval, if this line is a subscription.","format":"int32"},"subscription_interval_scale":{"type":["null","string"],"description":"Scale of the subscription billing interval (e.g., \"day\", \"month\", \"year\"), if applicable."},"gift":{"type":"boolean","description":"Indicates whether this order line is a gift to another customer."},"gift_to_customer_id":{"$ref":"#/components/schemas/FlakeId"},"gift_to_customer":{"$ref":"#/components/schemas/StorefrontCustomerDto"},"price":{"type":"integer","description":"The unit price of the product in the smallest currency unit (e.g., cents)","format":"int32"},"price_str":{"type":"string","description":"The unit price of the product formatted as a string"},"quantity":{"type":"integer","description":"The quantity of the product in this order line","format":"int32"},"discount_amount":{"type":"integer","description":"The discount amount (from sales, coupons, and affiliate links) applied to this order line","format":"int32"},"discount_amount_str":{"type":"string","description":"The discount amount formatted as a string"},"giftcard_usage_amount":{"type":"integer","description":"The amount of gift card used for this order line","format":"int32"},"giftcard_usage_amount_str":{"type":"string","description":"The gift card usage amount formatted as a string"},"subtotal_amount":{"type":"integer","description":"The subtotal amount for this order line","format":"int32"},"subtotal_amount_str":{"type":"string","description":"The subtotal amount formatted as a string"},"tax_amount":{"type":"integer","description":"The tax amount for this order line","format":"int32"},"tax_amount_str":{"type":"string","description":"The tax amount formatted as a string"},"total_amount":{"type":"integer","description":"The total amount for this order line","format":"int32"},"total_amount_str":{"type":"string","description":"The total amount formatted as a string"},"presentment_subtotal_amount":{"type":"integer","description":"The presentment subtotal amount for this order line","format":"int32"},"presentment_subtotal_amount_str":{"type":"string","description":"The presentment subtotal amount formatted as a string","readOnly":true},"presentment_discount_amount":{"type":"integer","description":"The presentment discount amount for this order line","format":"int32"},"presentment_discount_amount_str":{"type":"string","description":"The presentment discount amount formatted as a string","readOnly":true},"presentment_tax_amount":{"type":"integer","description":"The presentment tax amount for this order line","format":"int32"},"presentment_tax_amount_str":{"type":"string","description":"The presentment tax amount formatted as a string","readOnly":true},"presentment_giftcard_usage_amount":{"type":"integer","description":"The presentment gift card usage amount for this order line","format":"int32"},"presentment_giftcard_usage_amount_str":{"type":"string","description":"The presentment gift card usage amount formatted as a string","readOnly":true},"presentment_total_amount":{"type":"integer","description":"The presentment total amount for this order line","format":"int32"},"presentment_total_amount_str":{"type":"string","description":"The presentment total amount formatted as a string","readOnly":true},"selected_gameserver_id":{"$ref":"#/components/schemas/FlakeId"},"tax_inclusive":{"type":"boolean","description":"Indicates whether tax is included in the base price, or added on top"},"pricing_region_id":{"type":["null","string"],"description":"The regional pricing region ID for this order line, null if no regional pricing set"},"custom_variables":{"type":["null","object"],"additionalProperties":{"$ref":"#/components/schemas/CustomVariableLineItemDto"},"description":"Key-value pair of selected custom variables for this order."}},"additionalProperties":false,"description":"Represents a line item within an order."},"CustomVariableLineItemDto":{"required":["description","id","identifier","name","price","value"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"identifier":{"type":"string","description":"The identifier used to reference this custom variable (e.g., \"color\", \"size\")."},"name":{"type":"string","description":"The display name of the custom variable shown to users."},"description":{"type":"string","description":"A detailed description of what this custom variable represents."},"price":{"type":"integer","description":"The price associated with this custom variable in the smallest currency unit (e.g., cents).","format":"int64"},"value":{"type":"string","description":"The selected value for this custom variable."}},"additionalProperties":false},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32"},"code":{"type":"string","description":"The PayNow parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging."},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/store/customer/orders":{"get":{"tags":["orders"],"summary":"Get orders","description":"Retrieves all orders for the specified customer token.\n{% hint style=\"warning\" %}\nThis endpoint is only available for stores that use Steam based authentication.\n{% endhint %}","operationId":"StorefrontOrders_GetOrders","parameters":[{"name":"limit","in":"query","description":"The maximum number of items to return in a single request.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}},{"name":"after","in":"query","description":"Returns items after the specified ID.\nUsed for forward pagination through results.","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"before","in":"query","description":"Returns items before the specified ID.\nUsed for backward pagination through results.","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"asc","in":"query","description":"Determines the sort order of returned items.\nWhen true, items are returned in ascending order.\nWhen false, items are returned in descending order.","schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontOrderDto"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}}
```

## Get order by ID

> Retrieves an order by its ID for the specified customer token.\
> {% hint style="warning" %}\
> This endpoint is only available for stores that use Steam based authentication.\
> {% endhint %}

```json
{"openapi":"3.1.1","info":{"title":"PayNow Storefront (Headless) API","version":"v1"},"tags":[{"name":"orders"}],"security":[{"Customer":[]}],"components":{"securitySchemes":{"Customer":{"type":"apiKey","description":"A Customer token generated using an API Key in the format 'Customer TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id"},"StorefrontOrderDto":{"required":["currency","customer","customer_id","discount_amount","discount_amount_str","giftcard_usage_amount","giftcard_usage_amount_str","id","is_subscription","lines","presentment_currency","presentment_discount_amount","presentment_discount_amount_str","presentment_giftcard_usage_amount","presentment_giftcard_usage_amount_str","presentment_subtotal_amount","presentment_subtotal_amount_str","presentment_tax_amount","presentment_tax_amount_str","presentment_total_amount","presentment_total_amount_str","pretty_id","status","store_id","subtotal_amount","subtotal_amount_str","tax_amount","tax_amount_str","total_amount","total_amount_str","type"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"pretty_id":{"type":"string","description":"Human-readable identifier for the order.","readOnly":true},"store_id":{"$ref":"#/components/schemas/FlakeId"},"customer_id":{"$ref":"#/components/schemas/FlakeId"},"customer":{"$ref":"#/components/schemas/StorefrontCustomerDto"},"status":{"$ref":"#/components/schemas/OrderStatus"},"type":{"$ref":"#/components/schemas/OrderType"},"checkout_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_id":{"$ref":"#/components/schemas/FlakeId"},"is_subscription":{"type":"boolean","description":"Indicates whether this order is a subscription order."},"currency":{"type":"string","description":"Currency code used for this order."},"discount_amount":{"type":"integer","description":"The total discount amount applied to this order in smallest currency unit","format":"int32"},"discount_amount_str":{"type":"string","description":"The discount amount formatted as a string"},"subtotal_amount":{"type":"integer","description":"The subtotal amount for this order in smallest currency unit","format":"int32"},"subtotal_amount_str":{"type":"string","description":"The subtotal amount formatted as a string"},"tax_amount":{"type":"integer","description":"The tax amount for this order in smallest currency unit","format":"int32"},"tax_amount_str":{"type":"string","description":"The tax amount formatted as a string"},"total_amount":{"type":"integer","description":"The total amount for this order in smallest currency unit","format":"int32"},"total_amount_str":{"type":"string","description":"The total amount formatted as a string"},"giftcard_usage_amount":{"type":"integer","description":"The amount of gift card value used for this order in smallest currency unit","format":"int32"},"giftcard_usage_amount_str":{"type":"string","description":"The gift card usage amount formatted as a string"},"presentment_currency":{"type":"string","description":"The presentment currency code used for this order (currency shown to customer)"},"presentment_subtotal_amount":{"type":"integer","description":"The presentment subtotal amount in smallest currency unit","format":"int32"},"presentment_subtotal_amount_str":{"type":"string","description":"The presentment subtotal amount formatted as a string","readOnly":true},"presentment_discount_amount":{"type":"integer","description":"The presentment discount amount in smallest currency unit","format":"int32"},"presentment_discount_amount_str":{"type":"string","description":"The presentment discount amount formatted as a string","readOnly":true},"presentment_giftcard_usage_amount":{"type":"integer","description":"The presentment gift card usage amount in the smallest currency unit","format":"int32"},"presentment_giftcard_usage_amount_str":{"type":"string","description":"The presentment gift card usage amount formatted as a string","readOnly":true},"presentment_tax_amount":{"type":"integer","description":"The presentment tax amount in smallest currency unit","format":"int32"},"presentment_tax_amount_str":{"type":"string","description":"The presentment tax amount formatted as a string","readOnly":true},"presentment_total_amount":{"type":"integer","description":"The presentment total amount in the smallest currency unit","format":"int32"},"presentment_total_amount_str":{"type":"string","description":"The presentment total amount formatted as a string","readOnly":true},"billing_cycle_sequence":{"type":["null","integer"],"description":"Sequence number of the billing cycle, if this order is associated with a subscription.","format":"int32"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/StorefrontOrderLineDto"},"description":"Line items associated with this order."},"created_at":{"type":["null","string"],"description":"Date and time when the order was created.","format":"date-time"},"completed_at":{"type":["null","string"],"description":"Date and time when the order was completed.","format":"date-time"},"canceled_at":{"type":["null","string"],"description":"Date and time when the order was canceled.","format":"date-time"}},"additionalProperties":false,"description":"Data transfer object representing a store order."},"StorefrontCustomerDto":{"required":["id","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"profile":{"$ref":"#/components/schemas/CustomerGenericProfileDto"},"steam_id":{"$ref":"#/components/schemas/SteamId"},"steam":{"$ref":"#/components/schemas/StorefrontCustomerSteamProfileDto"},"minecraft_uuid":{"type":["null","string"],"description":"The customer's Minecraft UUID, if they have linked their Minecraft account.\nNot set for offline Minecraft stores. If the platform type is Minecraft - Geyser,\nand the profile is a bedrock account, this will be a UUID generated from the Xbox XUID."},"minecraft":{"$ref":"#/components/schemas/StorefrontCustomerMinecraftProfileDto"},"minecraft_platform":{"$ref":"#/components/schemas/CustomerMinecraftPlatform"},"xbox_xuid":{"type":["null","string"],"description":"The customer's Xbox XUID, if available."},"name":{"type":["null","string"],"description":"The display name for the customer."}},"additionalProperties":false,"description":"A storefront representation of a customer in the PayNow system with their associated profiles and metadata."},"CustomerGenericProfileDto":{"required":["id","name","platform"],"type":"object","properties":{"id":{"type":"string","description":"The platform-specific identifier for the profile."},"platform":{"type":"string","description":"The name of the platform this profile belongs to."},"name":{"type":"string","description":"The display name of the user on this platform."},"avatar_url":{"type":["null","string"],"description":"The URL to the user's avatar image on this platform."}},"additionalProperties":false,"description":"Represents a generic platform profile for a customer."},"SteamId":{"type":"string","additionalProperties":false,"description":"A 64-bit Steam account identifier. Accepts string or numeric format.","format":"steam-id"},"StorefrontCustomerSteamProfileDto":{"required":["avatar_url","id","name"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/SteamId"},"name":{"type":"string","description":"The display name of the user on Steam."},"avatar_url":{"type":"string","description":"The URL to the user's Steam avatar image."}},"additionalProperties":false,"description":"A storefront representation of a customers Steam profile."},"StorefrontCustomerMinecraftProfileDto":{"required":["avatar_url","id","name"],"type":"object","properties":{"id":{"type":"string","description":"The UUID of the Minecraft player.\nIf the platform is Minecraft Offline, this will be the name itself.\nIf the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID."},"name":{"type":"string","description":"The username of the Minecraft player."},"avatar_url":{"type":"string","description":"The URL to the player's Minecraft skin rendered as an avatar."}},"additionalProperties":false,"description":"A storefront representation of a customers Minecraft profile."},"CustomerMinecraftPlatform":{"enum":["unknown","java","bedrock"],"type":"string"},"OrderStatus":{"enum":["created","completed","canceled","refunded","chargeback"],"type":"string"},"OrderType":{"enum":["one_time","subscription_initial","subscription_renewal","subscription_proration","mixed"],"type":"string","description":"Defines the type of items contained in an order"},"StorefrontOrderLineDto":{"required":["checkout_line_id","discount_amount","discount_amount_str","gift","giftcard_usage_amount","giftcard_usage_amount_str","id","presentment_discount_amount","presentment_discount_amount_str","presentment_giftcard_usage_amount","presentment_giftcard_usage_amount_str","presentment_subtotal_amount","presentment_subtotal_amount_str","presentment_tax_amount","presentment_tax_amount_str","presentment_total_amount","presentment_total_amount_str","price","price_str","product_id","product_image_url","product_name","product_version_id","quantity","subtotal_amount","subtotal_amount_str","tax_amount","tax_amount_str","tax_inclusive","total_amount","total_amount_str"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"checkout_line_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_line_id":{"$ref":"#/components/schemas/FlakeId"},"trial_id":{"$ref":"#/components/schemas/FlakeId"},"product_id":{"$ref":"#/components/schemas/FlakeId"},"product_version_id":{"$ref":"#/components/schemas/FlakeId"},"product_name":{"type":"string","description":"Name of the product associated with this order line."},"product_image_url":{"type":"string","description":"URL for the product image."},"subscription_interval_value":{"type":["null","integer"],"description":"Numeric value of the subscription billing interval, if this line is a subscription.","format":"int32"},"subscription_interval_scale":{"type":["null","string"],"description":"Scale of the subscription billing interval (e.g., \"day\", \"month\", \"year\"), if applicable."},"gift":{"type":"boolean","description":"Indicates whether this order line is a gift to another customer."},"gift_to_customer_id":{"$ref":"#/components/schemas/FlakeId"},"gift_to_customer":{"$ref":"#/components/schemas/StorefrontCustomerDto"},"price":{"type":"integer","description":"The unit price of the product in the smallest currency unit (e.g., cents)","format":"int32"},"price_str":{"type":"string","description":"The unit price of the product formatted as a string"},"quantity":{"type":"integer","description":"The quantity of the product in this order line","format":"int32"},"discount_amount":{"type":"integer","description":"The discount amount (from sales, coupons, and affiliate links) applied to this order line","format":"int32"},"discount_amount_str":{"type":"string","description":"The discount amount formatted as a string"},"giftcard_usage_amount":{"type":"integer","description":"The amount of gift card used for this order line","format":"int32"},"giftcard_usage_amount_str":{"type":"string","description":"The gift card usage amount formatted as a string"},"subtotal_amount":{"type":"integer","description":"The subtotal amount for this order line","format":"int32"},"subtotal_amount_str":{"type":"string","description":"The subtotal amount formatted as a string"},"tax_amount":{"type":"integer","description":"The tax amount for this order line","format":"int32"},"tax_amount_str":{"type":"string","description":"The tax amount formatted as a string"},"total_amount":{"type":"integer","description":"The total amount for this order line","format":"int32"},"total_amount_str":{"type":"string","description":"The total amount formatted as a string"},"presentment_subtotal_amount":{"type":"integer","description":"The presentment subtotal amount for this order line","format":"int32"},"presentment_subtotal_amount_str":{"type":"string","description":"The presentment subtotal amount formatted as a string","readOnly":true},"presentment_discount_amount":{"type":"integer","description":"The presentment discount amount for this order line","format":"int32"},"presentment_discount_amount_str":{"type":"string","description":"The presentment discount amount formatted as a string","readOnly":true},"presentment_tax_amount":{"type":"integer","description":"The presentment tax amount for this order line","format":"int32"},"presentment_tax_amount_str":{"type":"string","description":"The presentment tax amount formatted as a string","readOnly":true},"presentment_giftcard_usage_amount":{"type":"integer","description":"The presentment gift card usage amount for this order line","format":"int32"},"presentment_giftcard_usage_amount_str":{"type":"string","description":"The presentment gift card usage amount formatted as a string","readOnly":true},"presentment_total_amount":{"type":"integer","description":"The presentment total amount for this order line","format":"int32"},"presentment_total_amount_str":{"type":"string","description":"The presentment total amount formatted as a string","readOnly":true},"selected_gameserver_id":{"$ref":"#/components/schemas/FlakeId"},"tax_inclusive":{"type":"boolean","description":"Indicates whether tax is included in the base price, or added on top"},"pricing_region_id":{"type":["null","string"],"description":"The regional pricing region ID for this order line, null if no regional pricing set"},"custom_variables":{"type":["null","object"],"additionalProperties":{"$ref":"#/components/schemas/CustomVariableLineItemDto"},"description":"Key-value pair of selected custom variables for this order."}},"additionalProperties":false,"description":"Represents a line item within an order."},"CustomVariableLineItemDto":{"required":["description","id","identifier","name","price","value"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"identifier":{"type":"string","description":"The identifier used to reference this custom variable (e.g., \"color\", \"size\")."},"name":{"type":"string","description":"The display name of the custom variable shown to users."},"description":{"type":"string","description":"A detailed description of what this custom variable represents."},"price":{"type":"integer","description":"The price associated with this custom variable in the smallest currency unit (e.g., cents).","format":"int64"},"value":{"type":"string","description":"The selected value for this custom variable."}},"additionalProperties":false},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32"},"code":{"type":"string","description":"The PayNow parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging."},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/store/customer/orders/{orderId}":{"get":{"tags":["orders"],"summary":"Get order by ID","description":"Retrieves an order by its ID for the specified customer token.\n{% hint style=\"warning\" %}\nThis endpoint is only available for stores that use Steam based authentication.\n{% endhint %}","operationId":"StorefrontOrders_GetOrderById","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StorefrontOrderDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.paynow.gg/storefront-headless/storefront-api/orders.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.