StorefrontOrderDto

Data transfer object representing a store order.

currencystringRequired

Currency code used for this order.

customerStorefrontCustomerDtoRequired

A storefront representation of a customer in the PayNow system with their associated profiles and metadata.

idFlakeIdRequired

store_idFlakeIdRequired

minecraftStorefrontCustomerMinecraftProfileDtoOptional

A storefront representation of a customers Minecraft profile.

avatar_urlstringRequired

The URL to the player's Minecraft skin rendered as an avatar.

idstringRequired

The UUID of the Minecraft player. If the platform is Minecraft Offline, this will be the name itself. If the platform is Minecraft Geyser, and this is a Bedrock account, this ID will be an Xbox XUID.

namestringRequired

The username of the Minecraft player.

minecraft_platformenumOptional

Possible enum values

unknown
java
bedrock

minecraft_uuidstringOptional

The customer's Minecraft UUID, if they have linked their Minecraft account. Not set for offline Minecraft stores. If the platform type is Minecraft - Geyser, and the profile is a bedrock account, this will be a UUID generated from the Xbox XUID.

namestringOptional

The display name for the customer.

profileCustomerGenericProfileDtoOptional

Represents a generic platform profile for a customer.

idstringRequired

The platform-specific identifier for the profile.

namestringRequired

The display name of the user on this platform.

platformstringRequired

The name of the platform this profile belongs to.

avatar_urlstringOptional

The URL to the user's avatar image on this platform.

steamStorefrontCustomerSteamProfileDtoOptional

A storefront representation of a customers Steam profile.

avatar_urlstringRequired

The URL to the user's Steam avatar image.

idSteamIdRequired

A 64-bit Steam account identifier. Accepts string or numeric format.

namestringRequired

The display name of the user on Steam.

steam_idSteamIdOptional

A 64-bit Steam account identifier. Accepts string or numeric format.

xbox_xuidstringOptional

The customer's Xbox XUID, if available.

customer_idFlakeIdRequired

discount_amountintegerRequired

The total discount amount applied to this order in smallest currency unit

discount_amount_strstringRequired

The discount amount formatted as a string

giftcard_usage_amountintegerRequired

The amount of gift card value used for this order in smallest currency unit

giftcard_usage_amount_strstringRequired

The gift card usage amount formatted as a string

idFlakeIdRequired

is_subscriptionbooleanRequired

Indicates whether this order is a subscription order.

linesStorefrontOrderLineDto[]Required

Line items associated with this order.

checkout_line_idFlakeIdRequired

discount_amountintegerRequired

The discount amount (from sales, coupons, and affiliate links) applied to this order line

discount_amount_strstringRequired

The discount amount formatted as a string

giftbooleanRequired

Indicates whether this order line is a gift to another customer.

giftcard_usage_amountintegerRequired

The amount of gift card used for this order line

giftcard_usage_amount_strstringRequired

The gift card usage amount formatted as a string

idFlakeIdRequired

presentment_discount_amountintegerRequired

The presentment discount amount for this order line

presentment_discount_amount_strstringRequired

The presentment discount amount formatted as a string

presentment_giftcard_usage_amountintegerRequired

The presentment gift card usage amount for this order line

presentment_giftcard_usage_amount_strstringRequired

The presentment gift card usage amount formatted as a string

presentment_subtotal_amountintegerRequired

The presentment subtotal amount for this order line

presentment_subtotal_amount_strstringRequired

The presentment subtotal amount formatted as a string

presentment_tax_amountintegerRequired

The presentment tax amount for this order line

presentment_tax_amount_strstringRequired

The presentment tax amount formatted as a string

presentment_total_amountintegerRequired

The presentment total amount for this order line

presentment_total_amount_strstringRequired

The presentment total amount formatted as a string

priceintegerRequired

The unit price of the product in the smallest currency unit (e.g., cents)

price_strstringRequired

The unit price of the product formatted as a string

product_idFlakeIdRequired

product_image_urlstringRequired

URL for the product image.

product_namestringRequired

Name of the product associated with this order line.

product_version_idFlakeIdRequired

quantityintegerRequired

The quantity of the product in this order line

subtotal_amountintegerRequired

The subtotal amount for this order line

subtotal_amount_strstringRequired

The subtotal amount formatted as a string

tax_amountintegerRequired

The tax amount for this order line

tax_amount_strstringRequired

The tax amount formatted as a string

tax_inclusivebooleanRequired

Indicates whether tax is included in the base price, or added on top

total_amountintegerRequired

The total amount for this order line

total_amount_strstringRequired

The total amount formatted as a string

custom_variablesobjectOptional

Key-value pair of selected custom variables for this order.

gift_to_customerStorefrontCustomerDtoOptional

A storefront representation of a customer in the PayNow system with their associated profiles and metadata.

idFlakeIdRequired

store_idFlakeIdRequired

minecraftStorefrontCustomerMinecraftProfileDtoOptional

→ StorefrontCustomerMinecraftProfileDto

minecraft_platformenumOptional

Possible enum values

unknown
java
bedrock

minecraft_uuidstringOptional

namestringOptional

The display name for the customer.

profileCustomerGenericProfileDtoOptional

→ CustomerGenericProfileDto

steamStorefrontCustomerSteamProfileDtoOptional

→ StorefrontCustomerSteamProfileDto

steam_idSteamIdOptional

A 64-bit Steam account identifier. Accepts string or numeric format.

xbox_xuidstringOptional

The customer's Xbox XUID, if available.

gift_to_customer_idFlakeIdOptional

pricing_region_idstringOptional

The regional pricing region ID for this order line, null if no regional pricing set

selected_gameserver_idFlakeIdOptional

subscription_interval_scalestringOptional

Scale of the subscription billing interval (e.g., "day", "month", "year"), if applicable.

subscription_interval_valueintegerOptional

Numeric value of the subscription billing interval, if this line is a subscription.

subscription_line_idFlakeIdOptional

trial_idFlakeIdOptional

presentment_currencystringRequired

The presentment currency code used for this order (currency shown to customer)

presentment_discount_amountintegerRequired

The presentment discount amount in smallest currency unit

presentment_discount_amount_strstringRequired

The presentment discount amount formatted as a string

presentment_giftcard_usage_amountintegerRequired

The presentment gift card usage amount in the smallest currency unit

presentment_giftcard_usage_amount_strstringRequired

The presentment gift card usage amount formatted as a string

presentment_subtotal_amountintegerRequired

The presentment subtotal amount in smallest currency unit

presentment_subtotal_amount_strstringRequired

The presentment subtotal amount formatted as a string

presentment_tax_amountintegerRequired

The presentment tax amount in smallest currency unit

presentment_tax_amount_strstringRequired

The presentment tax amount formatted as a string

presentment_total_amountintegerRequired

The presentment total amount in the smallest currency unit

presentment_total_amount_strstringRequired

The presentment total amount formatted as a string

pretty_idstringRequired

Human-readable identifier for the order.

statusenumRequired

Possible enum values

created
completed
canceled
refunded
chargeback

store_idFlakeIdRequired

subtotal_amountintegerRequired

The subtotal amount for this order in smallest currency unit

subtotal_amount_strstringRequired

The subtotal amount formatted as a string

tax_amountintegerRequired

The tax amount for this order in smallest currency unit

tax_amount_strstringRequired

The tax amount formatted as a string

total_amountintegerRequired

The total amount for this order in smallest currency unit

total_amount_strstringRequired

The total amount formatted as a string

typeenumRequired

Defines the type of items contained in an order

Possible enum values

one_time
Order contains only one-time purchase items
subscription_initial
Order is the initial charge for a subscription
subscription_renewal
Order is a recurring renewal charge for a subscription
subscription_proration
Order is a proration charge for a subscription
mixed
Order contains both one-time purchase and subscription items

billing_cycle_sequenceintegerOptional

Sequence number of the billing cycle, if this order is associated with a subscription.

canceled_atstringOptional

Date and time when the order was canceled.

checkout_idFlakeIdOptional

completed_atstringOptional

Date and time when the order was completed.

created_atstringOptional

Date and time when the order was created.

subscription_idFlakeIdOptional

Example

{
  "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"
}