Orders
Get orders
Retrieves all orders for the specified customer token.
Authorization: Customer TOKEN.Show fieldsHide fields
customerStorefrontCustomerDtoRequiredA storefront representation of a customer in the PayNow system with their associated profiles and metadata.
minecraftStorefrontCustomerMinecraftProfileDtoOptionalA storefront representation of a customers Minecraft profile.
unknownjavabedrock
profileCustomerGenericProfileDtoOptionalRepresents a generic platform profile for a customer.
steamStorefrontCustomerSteamProfileDtoOptionalA storefront representation of a customers Steam profile.
linesStorefrontOrderLineDto[]RequiredLine items associated with this order.
gift_to_customerStorefrontCustomerDtoOptionalA storefront representation of a customer in the PayNow system with their associated profiles and metadata.
unknownjavabedrock
createdcompletedcanceledrefundedchargeback
one_timeOrder contains only one-time purchase items
subscription_initialOrder is the initial charge for a subscription
subscription_renewalOrder is a recurring renewal charge for a subscription
subscription_prorationOrder is a proration charge for a subscription
mixedOrder contains both one-time purchase and subscription items
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/store/customer/orders" \
-H "Authorization: Customer TOKEN"import { createStorefrontClient } from "@paynow-gg/typescript-sdk";
const paynow = createStorefrontClient({
storeId: "STORE_ID",
customerToken: "CUSTOMER_TOKEN",
});
const result = await paynow.orders.getOrders();import requests
headers = {"Authorization": "Customer TOKEN"}
response = requests.get("https://api.paynow.gg/v1/store/customer/orders", headers=headers)[
{
"currency": "string",
"customer": {
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"minecraft_platform": "unknown",
"xbox_xuid": "string",
"name": "m0uka"
},
"customer_id": "411486491630370816",
"discount_amount": 500,
"discount_amount_str": "$5.00",
"giftcard_usage_amount": 0,
"giftcard_usage_amount_str": "$0.00",
"id": "411486491630370816",
"is_subscription": true,
"lines": [
{
"checkout_line_id": "411486491630370816",
"discount_amount": 0,
"discount_amount_str": "$0.00",
"gift": true,
"giftcard_usage_amount": 0,
"giftcard_usage_amount_str": "$0.00",
"id": "411486491630370816",
"presentment_discount_amount": 0,
"presentment_discount_amount_str": "€0.00",
"presentment_giftcard_usage_amount": 0,
"presentment_giftcard_usage_amount_str": "€0.00",
"presentment_subtotal_amount": 1999,
"presentment_subtotal_amount_str": "€19.99",
"presentment_tax_amount": 200,
"presentment_tax_amount_str": "€2.00",
"presentment_total_amount": 2199,
"presentment_total_amount_str": "€21.99",
"price": 1999,
"price_str": "$19.99",
"product_id": "411486491630370816",
"product_image_url": "string",
"product_name": "string",
"product_version_id": "411486491630370816",
"quantity": 1,
"subtotal_amount": 1999,
"subtotal_amount_str": "$19.99",
"tax_amount": 200,
"tax_amount_str": "$2.00",
"tax_inclusive": false,
"total_amount": 2199,
"total_amount_str": "$21.99",
"subscription_line_id": "411486491630370816",
"trial_id": "411486491630370816",
"subscription_interval_value": 0,
"subscription_interval_scale": "string",
"gift_to_customer_id": "411486491630370816",
"gift_to_customer": {
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"minecraft_platform": "unknown",
"xbox_xuid": "string",
"name": "m0uka"
},
"selected_gameserver_id": "411486491630370816",
"pricing_region_id": "eu",
"custom_variables": {}
}
],
"presentment_currency": "eur",
"presentment_discount_amount": 500,
"presentment_discount_amount_str": "€5.00",
"presentment_giftcard_usage_amount": 0,
"presentment_giftcard_usage_amount_str": "€0.00",
"presentment_subtotal_amount": 9995,
"presentment_subtotal_amount_str": "€99.95",
"presentment_tax_amount": 999,
"presentment_tax_amount_str": "€9.99",
"presentment_total_amount": 10494,
"presentment_total_amount_str": "€104.94",
"pretty_id": "string",
"status": "created",
"store_id": "411486491630370816",
"subtotal_amount": 9995,
"subtotal_amount_str": "$99.95",
"tax_amount": 999,
"tax_amount_str": "$9.99",
"total_amount": 10494,
"total_amount_str": "$104.94",
"type": "one_time",
"checkout_id": "411486491630370816",
"subscription_id": "411486491630370816",
"billing_cycle_sequence": 0,
"created_at": "2024-01-01T00:00:00Z",
"completed_at": "2024-01-01T00:00:00Z",
"canceled_at": "2024-01-01T00:00:00Z"
}
]Get order by ID
Retrieves an order by its ID for the specified customer token.
Authorization: Customer TOKEN.Show fieldsHide fields
customerStorefrontCustomerDtoRequiredA storefront representation of a customer in the PayNow system with their associated profiles and metadata.
minecraftStorefrontCustomerMinecraftProfileDtoOptionalA storefront representation of a customers Minecraft profile.
unknownjavabedrock
profileCustomerGenericProfileDtoOptionalRepresents a generic platform profile for a customer.
steamStorefrontCustomerSteamProfileDtoOptionalA storefront representation of a customers Steam profile.
linesStorefrontOrderLineDto[]RequiredLine items associated with this order.
gift_to_customerStorefrontCustomerDtoOptionalA storefront representation of a customer in the PayNow system with their associated profiles and metadata.
unknownjavabedrock
createdcompletedcanceledrefundedchargeback
one_timeOrder contains only one-time purchase items
subscription_initialOrder is the initial charge for a subscription
subscription_renewalOrder is a recurring renewal charge for a subscription
subscription_prorationOrder is a proration charge for a subscription
mixedOrder contains both one-time purchase and subscription items
Failed requests return a PayNowError body. See the error response guide.
curl -X GET "https://api.paynow.gg/v1/store/customer/orders/{orderId}" \
-H "Authorization: Customer TOKEN"import { createStorefrontClient } from "@paynow-gg/typescript-sdk";
const paynow = createStorefrontClient({
storeId: "STORE_ID",
customerToken: "CUSTOMER_TOKEN",
});
const result = await paynow.orders.getOrderById("411486491630370816");import requests
headers = {"Authorization": "Customer TOKEN"}
response = requests.get("https://api.paynow.gg/v1/store/customer/orders/{orderId}", headers=headers){
"currency": "string",
"customer": {
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"minecraft_platform": "unknown",
"xbox_xuid": "string",
"name": "m0uka"
},
"customer_id": "411486491630370816",
"discount_amount": 500,
"discount_amount_str": "$5.00",
"giftcard_usage_amount": 0,
"giftcard_usage_amount_str": "$0.00",
"id": "411486491630370816",
"is_subscription": true,
"lines": [
{
"checkout_line_id": "411486491630370816",
"discount_amount": 0,
"discount_amount_str": "$0.00",
"gift": true,
"giftcard_usage_amount": 0,
"giftcard_usage_amount_str": "$0.00",
"id": "411486491630370816",
"presentment_discount_amount": 0,
"presentment_discount_amount_str": "€0.00",
"presentment_giftcard_usage_amount": 0,
"presentment_giftcard_usage_amount_str": "€0.00",
"presentment_subtotal_amount": 1999,
"presentment_subtotal_amount_str": "€19.99",
"presentment_tax_amount": 200,
"presentment_tax_amount_str": "€2.00",
"presentment_total_amount": 2199,
"presentment_total_amount_str": "€21.99",
"price": 1999,
"price_str": "$19.99",
"product_id": "411486491630370816",
"product_image_url": "string",
"product_name": "string",
"product_version_id": "411486491630370816",
"quantity": 1,
"subtotal_amount": 1999,
"subtotal_amount_str": "$19.99",
"tax_amount": 200,
"tax_amount_str": "$2.00",
"tax_inclusive": false,
"total_amount": 2199,
"total_amount_str": "$21.99",
"subscription_line_id": "411486491630370816",
"trial_id": "411486491630370816",
"subscription_interval_value": 0,
"subscription_interval_scale": "string",
"gift_to_customer_id": "411486491630370816",
"gift_to_customer": {
"id": "411486491630370816",
"store_id": "411486491630370816",
"profile": {
"id": "string",
"name": "string",
"platform": "steam",
"avatar_url": "string"
},
"steam_id": "76561197960287930",
"steam": {
"avatar_url": "string",
"id": "76561197960287930",
"name": "string"
},
"minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"minecraft": {
"avatar_url": "string",
"id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
"name": "notch"
},
"minecraft_platform": "unknown",
"xbox_xuid": "string",
"name": "m0uka"
},
"selected_gameserver_id": "411486491630370816",
"pricing_region_id": "eu",
"custom_variables": {}
}
],
"presentment_currency": "eur",
"presentment_discount_amount": 500,
"presentment_discount_amount_str": "€5.00",
"presentment_giftcard_usage_amount": 0,
"presentment_giftcard_usage_amount_str": "€0.00",
"presentment_subtotal_amount": 9995,
"presentment_subtotal_amount_str": "€99.95",
"presentment_tax_amount": 999,
"presentment_tax_amount_str": "€9.99",
"presentment_total_amount": 10494,
"presentment_total_amount_str": "€104.94",
"pretty_id": "string",
"status": "created",
"store_id": "411486491630370816",
"subtotal_amount": 9995,
"subtotal_amount_str": "$99.95",
"tax_amount": 999,
"tax_amount_str": "$9.99",
"total_amount": 10494,
"total_amount_str": "$104.94",
"type": "one_time",
"checkout_id": "411486491630370816",
"subscription_id": "411486491630370816",
"billing_cycle_sequence": 0,
"created_at": "2024-01-01T00:00:00Z",
"completed_at": "2024-01-01T00:00:00Z",
"canceled_at": "2024-01-01T00:00:00Z"
}