# Orders

## Get orders

> Retrieves all orders for the specified store.

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"orders"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id"},"OrderStatus":{"enum":["created","completed","canceled","refunded","chargeback"],"type":"string"},"OrderDto":{"required":["applied_coupons","applied_giftcards","billing_country","billing_cycle_sequence","billing_email","billing_name","currency","customer","customer_id","customer_ip","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":"The PayNow order ID identifier starting with pn-."},"store_id":{"$ref":"#/components/schemas/FlakeId"},"customer_id":{"$ref":"#/components/schemas/FlakeId"},"customer":{"$ref":"#/components/schemas/CustomerDto"},"type":{"$ref":"#/components/schemas/OrderType"},"status":{"$ref":"#/components/schemas/OrderStatus"},"checkout_id":{"$ref":"#/components/schemas/FlakeId"},"checkout_token":{"type":["null","string"],"description":"The checkout token for this order"},"subscription_id":{"$ref":"#/components/schemas/FlakeId"},"is_subscription":{"type":"boolean","description":"Signifies if the order is a subscription order","readOnly":true},"coupon_id":{"$ref":"#/components/schemas/FlakeId"},"applied_coupons":{"type":"array","items":{"$ref":"#/components/schemas/OrderCouponUsageDto"},"description":"Applied coupons to this order"},"giftcard_id":{"$ref":"#/components/schemas/FlakeId"},"applied_giftcards":{"type":"array","items":{"$ref":"#/components/schemas/OrderGiftCardUsageDto"},"description":"Applied gift cards to this order"},"affiliate_id":{"$ref":"#/components/schemas/FlakeId"},"billing_name":{"type":"string","description":"The billing name for this order"},"billing_email":{"type":"string","description":"The billing email for this order"},"billing_country":{"type":"string","description":"The billing country for this order"},"billing_cycle_sequence":{"type":"integer","description":"The billing cycle sequence (current renewal count) if this is a subscription order","format":"int32"},"customer_ip":{"type":"string","description":"The IP address (IPv4 or IPv6) of the customer at time of order"},"currency":{"type":"string","description":"The 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 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 smallest currency unit","format":"int32"},"presentment_total_amount_str":{"type":"string","description":"The presentment total amount formatted as a string","readOnly":true},"created_at":{"type":["null","string"],"description":"The date and time when this order was created","format":"date-time"},"completed_at":{"type":["null","string"],"description":"The date and time when this order was completed, if applicable","format":"date-time"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineDto"},"description":"The line items in this order"},"tax_jurisdictions":{"type":["null","array"],"items":{"$ref":"#/components/schemas/SalesTaxJurisdictionDto"},"description":"A list of all tax jurisdictions that were involved in the taxation of this order."},"last_payment_error":{"$ref":"#/components/schemas/LastPaymentErrorDto"}},"additionalProperties":false,"description":"Represents a customer order"},"CustomerDto":{"required":["created_at","id","metadata","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"profile":{"$ref":"#/components/schemas/GenericProfileDto"},"steam_id":{"$ref":"#/components/schemas/SteamId"},"steam":{"$ref":"#/components/schemas/SteamProfileDto"},"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/MinecraftProfileDto"},"xbox_xuid":{"type":["null","string"],"description":"The customer's Xbox XUID, if available."},"minecraft_platform":{"$ref":"#/components/schemas/CustomerMinecraftPlatform"},"name":{"type":["null","string"],"description":"The display name for the customer."},"created_at":{"type":"string","description":"The date and time when the customer was created in the system.","format":"date-time"},"updated_at":{"type":["null","string"],"description":"The date and time when the customer was last updated, if applicable.","format":"date-time"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional custom data associated with the customer."}},"additionalProperties":false,"description":"Represents a customer in the PayNow system with their associated profiles and metadata."},"GenericProfileDto":{"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"},"SteamProfileDto":{"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":"Represents a Steam profile for a customer."},"MinecraftProfileDto":{"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":"Represents a Minecraft profile for a customer."},"CustomerMinecraftPlatform":{"enum":["unknown","java","bedrock"],"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"},"OrderCouponUsageDto":{"required":["coupon_id","usage_amount"],"type":"object","properties":{"coupon_id":{"$ref":"#/components/schemas/FlakeId"},"usage_amount":{"type":"integer","format":"int64"}},"additionalProperties":false},"OrderGiftCardUsageDto":{"required":["giftcard_id","usage_amount"],"type":"object","properties":{"giftcard_id":{"$ref":"#/components/schemas/FlakeId"},"usage_amount":{"type":"integer","format":"int64"}},"additionalProperties":false},"OrderLineDto":{"required":["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_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"},"product_id":{"$ref":"#/components/schemas/FlakeId"},"product_version_id":{"$ref":"#/components/schemas/FlakeId"},"product_name":{"type":"string","description":"The name of the product in this order line"},"product_image_url":{"type":["null","string"],"description":"The URL of the product image"},"description":{"type":["null","string"],"description":"Customer-presentable description of the order line."},"created_giftcard_id":{"type":["null","string"],"description":"The Gift Card ID of that product in this order line"},"subscription_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_line_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_change_line_id":{"$ref":"#/components/schemas/FlakeId"},"trial_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_interval_value":{"type":["null","integer"],"description":"The interval value for subscription products","format":"int32"},"subscription_interval_scale":{"$ref":"#/components/schemas/ProductSubscriptionIntervalScale"},"gift":{"type":"boolean","description":"Indicates whether this order line is a gift"},"gift_to_customer_id":{"$ref":"#/components/schemas/FlakeId"},"gift_to_customer":{"$ref":"#/components/schemas/CustomerDto"},"sale_id":{"$ref":"#/components/schemas/FlakeId"},"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"},"payout_splits":{"type":["null","array"],"items":{"$ref":"#/components/schemas/OrderLinePayoutSplitDto"},"description":"The payout splits for this order line"},"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 an order line item in a customer's order"},"ProductSubscriptionIntervalScale":{"enum":["invalid","day","week","month","year"],"type":"string"},"OrderLinePayoutSplitDto":{"required":["platform_fee","user_id"],"type":"object","properties":{"user_id":{"$ref":"#/components/schemas/FlakeId"},"percentage":{"type":["null","integer"],"description":"The percentage in basis points.","format":"int64"},"platform_fee":{"type":"integer","description":"The platform fee percentage in basis points.\nOnly used by platforms.","format":"int64"}},"additionalProperties":false,"description":"Represents an order line-level payout split."},"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},"SalesTaxJurisdictionDto":{"required":["name","taxes"],"type":"object","properties":{"name":{"type":"string","description":"The name of the tax jurisdiction."},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/SalesTaxJurisdictionTaxDto"},"description":"List of taxes applied within this jurisdiction."},"not_taxed_reason":{"type":["null","string"],"description":"Explanation for why taxes are not applied, if applicable.\nThis property is null when taxes are applied."}},"additionalProperties":false,"description":"Object representing a sales tax jurisdiction and its associated taxes."},"SalesTaxJurisdictionTaxDto":{"required":["tax_amount","tax_name","tax_rate","taxable_amount"],"type":"object","properties":{"tax_name":{"type":"string","description":"The name of the tax."},"taxable_amount":{"type":"string","description":"The amount subject to taxation, formatted as a string."},"tax_amount":{"type":"string","description":"The calculated tax amount, formatted as a string."},"tax_rate":{"type":"string","description":"The rate at which the tax is applied, formatted as a string."}},"additionalProperties":false,"description":"Object representing a specific tax within a sales tax jurisdiction."},"LastPaymentErrorDto":{"required":["decline_code","message"],"type":"object","properties":{"decline_code":{"$ref":"#/components/schemas/PaymentDeclineCode"},"message":{"type":"string","description":"Human-readable decline reason message."}},"additionalProperties":false,"description":"The last payment decline object."},"PaymentDeclineCode":{"enum":["unknown","generic_decline","call_issuer","authentication_required","currency_not_supported","duplicate_transaction","expired_card","fraudulent","incorrect_number","incorrect_cvc","incorrect_pin","incorrect_zip","insufficient_funds","invalid_account","invalid_amount","invalid_expiry_month","invalid_expiry_year","issuer_not_available","lost_card","merchant_blacklist","new_account_information_available","no_action_taken","pickup_card","pin_try_exceeded","restricted_card","stolen_card","testmode_decline","try_again_later","security_violation","card_velocity_exceeded","do_not_honor","processing_error","card_not_supported","transaction_not_allowed","authorization_revoked","store_blocked"],"type":"string","description":"A payment decline reason code."},"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/stores/{storeId}/orders":{"get":{"tags":["orders"],"summary":"Get orders","description":"Retrieves all orders for the specified store.","operationId":"Orders_GetOrders","parameters":[{"name":"storeId","in":"path","description":"The ID of the store to retrieve orders for.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"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"}},{"name":"status","in":"query","description":"List of order statuses to filter by","schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderStatus"}}},{"name":"order_id","in":"query","description":"Order ID","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"customer_id","in":"query","description":"Customer ID","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"billing_email","in":"query","description":"Billing Email","schema":{"type":"string"}},{"name":"customer_ip","in":"query","description":"Customer IP","schema":{"type":"string"}},{"name":"subscription_id","in":"query","description":"Subscription ID","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"checkout_id","in":"query","description":"Checkout ID","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"is_subscription","in":"query","description":"Flag indicating if the order is a subscription","schema":{"type":"boolean"}},{"name":"affiliate_id","in":"query","description":"Affiliate ID","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"coupon_id","in":"query","description":"Coupon ID","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"giftcard_id","in":"query","description":"Gift card ID","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"product_id","in":"query","description":"Product ID","schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"sale_id","in":"query","description":"Sale ID","schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrderDto"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}}
```

## Get order by ID

> Retrieves an order by the ID for the specified store.

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"orders"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id"},"OrderDto":{"required":["applied_coupons","applied_giftcards","billing_country","billing_cycle_sequence","billing_email","billing_name","currency","customer","customer_id","customer_ip","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":"The PayNow order ID identifier starting with pn-."},"store_id":{"$ref":"#/components/schemas/FlakeId"},"customer_id":{"$ref":"#/components/schemas/FlakeId"},"customer":{"$ref":"#/components/schemas/CustomerDto"},"type":{"$ref":"#/components/schemas/OrderType"},"status":{"$ref":"#/components/schemas/OrderStatus"},"checkout_id":{"$ref":"#/components/schemas/FlakeId"},"checkout_token":{"type":["null","string"],"description":"The checkout token for this order"},"subscription_id":{"$ref":"#/components/schemas/FlakeId"},"is_subscription":{"type":"boolean","description":"Signifies if the order is a subscription order","readOnly":true},"coupon_id":{"$ref":"#/components/schemas/FlakeId"},"applied_coupons":{"type":"array","items":{"$ref":"#/components/schemas/OrderCouponUsageDto"},"description":"Applied coupons to this order"},"giftcard_id":{"$ref":"#/components/schemas/FlakeId"},"applied_giftcards":{"type":"array","items":{"$ref":"#/components/schemas/OrderGiftCardUsageDto"},"description":"Applied gift cards to this order"},"affiliate_id":{"$ref":"#/components/schemas/FlakeId"},"billing_name":{"type":"string","description":"The billing name for this order"},"billing_email":{"type":"string","description":"The billing email for this order"},"billing_country":{"type":"string","description":"The billing country for this order"},"billing_cycle_sequence":{"type":"integer","description":"The billing cycle sequence (current renewal count) if this is a subscription order","format":"int32"},"customer_ip":{"type":"string","description":"The IP address (IPv4 or IPv6) of the customer at time of order"},"currency":{"type":"string","description":"The 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 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 smallest currency unit","format":"int32"},"presentment_total_amount_str":{"type":"string","description":"The presentment total amount formatted as a string","readOnly":true},"created_at":{"type":["null","string"],"description":"The date and time when this order was created","format":"date-time"},"completed_at":{"type":["null","string"],"description":"The date and time when this order was completed, if applicable","format":"date-time"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/OrderLineDto"},"description":"The line items in this order"},"tax_jurisdictions":{"type":["null","array"],"items":{"$ref":"#/components/schemas/SalesTaxJurisdictionDto"},"description":"A list of all tax jurisdictions that were involved in the taxation of this order."},"last_payment_error":{"$ref":"#/components/schemas/LastPaymentErrorDto"}},"additionalProperties":false,"description":"Represents a customer order"},"CustomerDto":{"required":["created_at","id","metadata","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"profile":{"$ref":"#/components/schemas/GenericProfileDto"},"steam_id":{"$ref":"#/components/schemas/SteamId"},"steam":{"$ref":"#/components/schemas/SteamProfileDto"},"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/MinecraftProfileDto"},"xbox_xuid":{"type":["null","string"],"description":"The customer's Xbox XUID, if available."},"minecraft_platform":{"$ref":"#/components/schemas/CustomerMinecraftPlatform"},"name":{"type":["null","string"],"description":"The display name for the customer."},"created_at":{"type":"string","description":"The date and time when the customer was created in the system.","format":"date-time"},"updated_at":{"type":["null","string"],"description":"The date and time when the customer was last updated, if applicable.","format":"date-time"},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Additional custom data associated with the customer."}},"additionalProperties":false,"description":"Represents a customer in the PayNow system with their associated profiles and metadata."},"GenericProfileDto":{"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"},"SteamProfileDto":{"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":"Represents a Steam profile for a customer."},"MinecraftProfileDto":{"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":"Represents a Minecraft profile for a customer."},"CustomerMinecraftPlatform":{"enum":["unknown","java","bedrock"],"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"},"OrderStatus":{"enum":["created","completed","canceled","refunded","chargeback"],"type":"string"},"OrderCouponUsageDto":{"required":["coupon_id","usage_amount"],"type":"object","properties":{"coupon_id":{"$ref":"#/components/schemas/FlakeId"},"usage_amount":{"type":"integer","format":"int64"}},"additionalProperties":false},"OrderGiftCardUsageDto":{"required":["giftcard_id","usage_amount"],"type":"object","properties":{"giftcard_id":{"$ref":"#/components/schemas/FlakeId"},"usage_amount":{"type":"integer","format":"int64"}},"additionalProperties":false},"OrderLineDto":{"required":["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_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"},"product_id":{"$ref":"#/components/schemas/FlakeId"},"product_version_id":{"$ref":"#/components/schemas/FlakeId"},"product_name":{"type":"string","description":"The name of the product in this order line"},"product_image_url":{"type":["null","string"],"description":"The URL of the product image"},"description":{"type":["null","string"],"description":"Customer-presentable description of the order line."},"created_giftcard_id":{"type":["null","string"],"description":"The Gift Card ID of that product in this order line"},"subscription_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_line_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_change_line_id":{"$ref":"#/components/schemas/FlakeId"},"trial_id":{"$ref":"#/components/schemas/FlakeId"},"subscription_interval_value":{"type":["null","integer"],"description":"The interval value for subscription products","format":"int32"},"subscription_interval_scale":{"$ref":"#/components/schemas/ProductSubscriptionIntervalScale"},"gift":{"type":"boolean","description":"Indicates whether this order line is a gift"},"gift_to_customer_id":{"$ref":"#/components/schemas/FlakeId"},"gift_to_customer":{"$ref":"#/components/schemas/CustomerDto"},"sale_id":{"$ref":"#/components/schemas/FlakeId"},"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"},"payout_splits":{"type":["null","array"],"items":{"$ref":"#/components/schemas/OrderLinePayoutSplitDto"},"description":"The payout splits for this order line"},"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 an order line item in a customer's order"},"ProductSubscriptionIntervalScale":{"enum":["invalid","day","week","month","year"],"type":"string"},"OrderLinePayoutSplitDto":{"required":["platform_fee","user_id"],"type":"object","properties":{"user_id":{"$ref":"#/components/schemas/FlakeId"},"percentage":{"type":["null","integer"],"description":"The percentage in basis points.","format":"int64"},"platform_fee":{"type":"integer","description":"The platform fee percentage in basis points.\nOnly used by platforms.","format":"int64"}},"additionalProperties":false,"description":"Represents an order line-level payout split."},"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},"SalesTaxJurisdictionDto":{"required":["name","taxes"],"type":"object","properties":{"name":{"type":"string","description":"The name of the tax jurisdiction."},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/SalesTaxJurisdictionTaxDto"},"description":"List of taxes applied within this jurisdiction."},"not_taxed_reason":{"type":["null","string"],"description":"Explanation for why taxes are not applied, if applicable.\nThis property is null when taxes are applied."}},"additionalProperties":false,"description":"Object representing a sales tax jurisdiction and its associated taxes."},"SalesTaxJurisdictionTaxDto":{"required":["tax_amount","tax_name","tax_rate","taxable_amount"],"type":"object","properties":{"tax_name":{"type":"string","description":"The name of the tax."},"taxable_amount":{"type":"string","description":"The amount subject to taxation, formatted as a string."},"tax_amount":{"type":"string","description":"The calculated tax amount, formatted as a string."},"tax_rate":{"type":"string","description":"The rate at which the tax is applied, formatted as a string."}},"additionalProperties":false,"description":"Object representing a specific tax within a sales tax jurisdiction."},"LastPaymentErrorDto":{"required":["decline_code","message"],"type":"object","properties":{"decline_code":{"$ref":"#/components/schemas/PaymentDeclineCode"},"message":{"type":"string","description":"Human-readable decline reason message."}},"additionalProperties":false,"description":"The last payment decline object."},"PaymentDeclineCode":{"enum":["unknown","generic_decline","call_issuer","authentication_required","currency_not_supported","duplicate_transaction","expired_card","fraudulent","incorrect_number","incorrect_cvc","incorrect_pin","incorrect_zip","insufficient_funds","invalid_account","invalid_amount","invalid_expiry_month","invalid_expiry_year","issuer_not_available","lost_card","merchant_blacklist","new_account_information_available","no_action_taken","pickup_card","pin_try_exceeded","restricted_card","stolen_card","testmode_decline","try_again_later","security_violation","card_velocity_exceeded","do_not_honor","processing_error","card_not_supported","transaction_not_allowed","authorization_revoked","store_blocked"],"type":"string","description":"A payment decline reason code."},"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/stores/{storeId}/orders/{orderId}":{"get":{"tags":["orders"],"summary":"Get order by ID","description":"Retrieves an order by the ID for the specified store.","operationId":"Orders_GetOrderById","parameters":[{"name":"storeId","in":"path","description":"The ID of the store to retrieve the order for.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"orderId","in":"path","description":"The ID of the order.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}}
```

## Refund order by ID

> Creates a refund for an order by the ID for the specified store.

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"orders"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id"},"CreateRefundRequestDto":{"type":"object","properties":{"order_line_id":{"$ref":"#/components/schemas/FlakeId"},"refund_from_connected_user_balance":{"type":["null","boolean"],"description":"Determines if the refund should be taken from the connected user's balance.\nOnly relevant for connected platforms."}},"additionalProperties":false},"RefundDto":{"required":["amount","amount_str","created_at","currency","customer_id","gateway_fee_amount","gateway_fee_amount_str","id","payment_id","platform_fee_amount","platform_fee_amount_str","refund_from_connected_user_balance","status","store_id","store_net_amount","store_net_amount_str","store_refund_amount","store_refund_amount_str","tax_amount","tax_amount_str"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"payment_id":{"$ref":"#/components/schemas/FlakeId"},"customer_id":{"$ref":"#/components/schemas/FlakeId"},"order_line_id":{"$ref":"#/components/schemas/FlakeId"},"status":{"$ref":"#/components/schemas/RefundStatus"},"failure_reason":{"type":["null","string"],"description":"Reason for failure if the refund has failed"},"currency":{"type":"string","description":"Three-letter currency code of the refund"},"amount":{"type":"integer","description":"Amount of the refund in smallest currency unit (e.g., cents)","format":"int64"},"amount_str":{"type":"string","description":"String representation of the refund amount, formatted for display"},"gateway_fee_amount":{"type":"integer","description":"Amount of payment processor fees in smallest currency unit","format":"int64"},"gateway_fee_amount_str":{"type":"string","description":"String representation of gateway fee amount, formatted for display"},"tax_amount":{"type":"integer","description":"Amount of tax being refunded in smallest currency unit","format":"int64"},"tax_amount_str":{"type":"string","description":"String representation of tax amount, formatted for display"},"platform_fee_amount":{"type":"integer","description":"Amount of platform fees in smallest currency unit","format":"int64"},"platform_fee_amount_str":{"type":"string","description":"String representation of platform fee amount, formatted for display"},"store_net_amount":{"type":"integer","description":"Net amount for the store after fees in smallest currency unit","format":"int64"},"store_net_amount_str":{"type":"string","description":"String representation of store net amount, formatted for display"},"store_refund_amount":{"type":"integer","description":"Amount of the refund to be paid by the store in smallest currency unit","format":"int64"},"store_refund_amount_str":{"type":"string","description":"String representation of store refund amount, formatted for display"},"presentment_currency":{"type":["null","string"],"description":"Optional currency code used for presentment to the customer if different from the base currency"},"presentment_amount":{"type":["null","integer"],"description":"Optional amount in presentment currency in smallest currency unit","format":"int64"},"fx_rate":{"type":["null","string"],"description":"Exchange rate used while refunding. Only present for payments made in non-settlement currency."},"refund_from_connected_user_balance":{"type":"boolean","description":"Indicates whether the refund should be taken from the connected user's balance.\nOnly relevant for platforms."},"created_at":{"type":"string","description":"Date and time when the refund was created","format":"date-time"},"approved_at":{"type":["null","string"],"description":"Optional date and time when the refund was approved","format":"date-time"},"pending_at":{"type":["null","string"],"description":"Optional date and time when the refund entered pending status","format":"date-time"},"completed_at":{"type":["null","string"],"description":"Optional date and time when the refund was completed","format":"date-time"},"canceled_at":{"type":["null","string"],"description":"Optional date and time when the refund was canceled","format":"date-time"},"failed_at":{"type":["null","string"],"description":"Optional date and time when the refund failed","format":"date-time"}},"additionalProperties":false},"RefundStatus":{"enum":["created","approved","processing","completed","canceled","failed"],"type":"string","description":"Represents the current status of a refund in the system"},"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/stores/{storeId}/orders/{orderId}/refund":{"post":{"tags":["orders"],"summary":"Refund order by ID","description":"Creates a refund for an order by the ID for the specified store.","operationId":"Orders_RefundOrder","parameters":[{"name":"storeId","in":"path","description":"The ID of the store to refund the order for.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"orderId","in":"path","description":"The ID of the order.","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRefundRequestDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateRefundRequestDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateRefundRequestDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefundDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}}}}}}
```


---

# Agent Instructions: 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:

```
GET https://docs.paynow.gg/management/management-api/orders.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.