OrderDto

Represents a customer order

idFlakeIdRequired

applied_couponsOrderCouponUsageDto[]Required

Applied coupons to this order

coupon_idFlakeIdRequired

coupon_version_idFlakeIdRequired

usage_amountintegerRequired

applied_giftcardsOrderGiftCardUsageDto[]Required

Applied gift cards to this order

giftcard_idFlakeIdRequired

usage_amountintegerRequired

billing_countrystringRequired

The billing country for this order

billing_cycle_sequenceintegerRequired

The billing cycle sequence (current renewal count) if this is a subscription order

billing_emailstringRequired

The billing email for this order

billing_namestringRequired

The billing name for this order

currencystringRequired

The currency code used for this order

customerCustomerDtoRequired

Represents a customer in the PayNow system with their associated profiles and metadata.

idFlakeIdRequired

created_atstringRequired

The date and time when the customer was created in the system.

metadataobjectRequired

Additional custom data associated with the customer.

store_idFlakeIdRequired

minecraftCustomerMinecraftProfileDtoOptional

Represents a Minecraft profile for a customer.

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.

avatar_urlstringRequired

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

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.

steamCustomerSteamProfileDtoOptional

Represents a Steam profile for a customer.

idSteamIdRequired

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

avatar_urlstringRequired

The URL to the user's Steam avatar image.

namestringRequired

The display name of the user on Steam.

steam_idSteamIdOptional

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

updated_atstringOptional

The date and time when the customer was last updated, if applicable.

xbox_xuidstringOptional

The customer's Xbox XUID, if available.

customer_idFlakeIdRequired

customer_ipstringRequired

The IP address (IPv4 or IPv6) of the customer at time of order

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

is_subscriptionbooleanRequired

Signifies if the order is a subscription order

linesOrderLineDto[]Required

The line items in this order

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

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

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_namestringRequired

The name of the product in 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

checkout_line_idFlakeIdOptional

created_giftcard_idstringOptional

The Gift Card ID of that product in this order line

custom_variablesobjectOptional

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

descriptionstringOptional

Customer-presentable description of the order line.

gift_to_customerCustomerDtoOptional

Represents a customer in the PayNow system with their associated profiles and metadata.

idFlakeIdRequired

created_atstringRequired

The date and time when the customer was created in the system.

metadataobjectRequired

Additional custom data associated with the customer.

store_idFlakeIdRequired

minecraftCustomerMinecraftProfileDtoOptional

→ CustomerMinecraftProfileDto

minecraft_platformenumOptional

Possible enum values

unknown
java
bedrock

minecraft_uuidstringOptional

namestringOptional

The display name for the customer.

profileCustomerGenericProfileDtoOptional

→ CustomerGenericProfileDto

steamCustomerSteamProfileDtoOptional

→ CustomerSteamProfileDto

steam_idSteamIdOptional

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

updated_atstringOptional

The date and time when the customer was last updated, if applicable.

xbox_xuidstringOptional

The customer's Xbox XUID, if available.

gift_to_customer_idFlakeIdOptional

payout_splitsOrderLinePayoutSplitDto[]Optional

The payout splits for this order line

platform_feeintegerRequired

The platform fee percentage in basis points. Only used by platforms.

user_idFlakeIdRequired

percentageintegerOptional

The percentage in basis points.

pricing_region_idstringOptional

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

product_image_urlstringOptional

The URL of the product image

sale_idFlakeIdOptional

sale_version_idFlakeIdOptional

selected_gameserver_idFlakeIdOptional

subscription_change_line_idFlakeIdOptional

subscription_idFlakeIdOptional

subscription_interval_scaleenumOptional

Possible enum values

invalid
day
week
month
year

subscription_interval_valueintegerOptional

The interval value for subscription products

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 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 smallest currency unit

presentment_total_amount_strstringRequired

The presentment total amount formatted as a string

pretty_idstringRequired

The PayNow order ID identifier starting with pn-.

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

tax_jurisdictionsSalesTaxJurisdictionDto[]Required

A list of all tax jurisdictions that were involved in the taxation of this order.

namestringRequired

The name of the tax jurisdiction.

taxesSalesTaxJurisdictionTaxDto[]Required

List of taxes applied within this jurisdiction.

tax_amountstringRequired

The calculated tax amount, formatted as a string.

tax_namestringRequired

The name of the tax.

tax_ratestringRequired

The rate at which the tax is applied, formatted as a string.

taxable_amountstringRequired

The amount subject to taxation, formatted as a string.

not_taxed_reasonstringOptional

Explanation for why taxes are not applied, if applicable. This property is null when taxes are applied.

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

affiliate_idFlakeIdOptional

billing_tax_idstringOptional

The tax identification number used for this order (for B2B transactions)

checkout_idFlakeIdOptional

checkout_tokenstringOptional

The checkout token for this order

completed_atstringOptional

The date and time when this order was completed, if applicable

coupon_idFlakeIdOptional

created_atstringOptional

The date and time when this order was created

giftcard_idFlakeIdOptional

last_payment_errorLastPaymentErrorDtoOptional

The last payment decline object.

decline_codeenumRequired

A payment decline reason code.

Possible enum values

unknown
An unknown error occurred during payment processing.
generic_decline
The payment was declined for an unspecified reason.
call_issuer
The payment provider requires the customer to contact them.
authentication_required
Additional authentication is needed to complete the transaction.
currency_not_supported
The chosen currency is not supported by this payment method.
duplicate_transaction
An identical transaction was recently processed.
expired_card
The payment method has passed its expiration date.
fraudulent
The payment was flagged as potentially fraudulent.
incorrect_number
The provided payment number is invalid.
incorrect_cvc
The security code for the payment method is incorrect.
incorrect_pin
The entered PIN is not valid.
incorrect_zip
The provided billing postal code is incorrect.
insufficient_funds
The payment method lacks sufficient funds for the transaction.
invalid_account
The payment method or associated account is not valid.
invalid_amount
The transaction amount is not allowed or is invalid.
invalid_expiry_month
The expiration month for the payment method is invalid.
invalid_expiry_year
The expiration year for the payment method is invalid.
issuer_not_available
The payment provider's systems are currently unavailable.
lost_card
The payment method has been reported as lost.
merchant_blacklist
The transaction was blocked by PayNow's security measures.
new_account_information_available
Updated information is available for the payment method.
no_action_taken
The payment provider took no action on this transaction.
pickup_card
The payment method has been flagged and cannot be used.
pin_try_exceeded
Too many incorrect PIN attempts have been made.
restricted_card
The payment method has restrictions preventing its use.
stolen_card
The payment method has been reported as stolen.
testmode_decline
A test payment method was used in a live environment.
try_again_later
A temporary issue prevented the transaction from completing.
security_violation
A security issue occurred during the transaction.
card_velocity_exceeded
The payment method has exceeded its usage limits.
do_not_honor
The payment provider has chosen not to process this transaction.
processing_error
An error occurred while processing the payment.
card_not_supported
This payment method doesn't support this type of transaction.
transaction_not_allowed
This specific transaction is not permitted for this payment method.
authorization_revoked
The payment authorization has been revoked.
store_blocked
The payment was blocked by one of your store's configured rules.

messagestringRequired

Human-readable decline reason message.

subscription_idFlakeIdOptional

Example

{
  "id": "411486491630370816",
  "applied_coupons": [
    {
      "coupon_id": "411486491630370816",
      "coupon_version_id": "411486491630370816",
      "usage_amount": 0
    }
  ],
  "applied_giftcards": [
    {
      "giftcard_id": "411486491630370816",
      "usage_amount": 0
    }
  ],
  "billing_country": "US",
  "billing_cycle_sequence": 0,
  "billing_email": "[email protected]",
  "billing_name": "John Doe",
  "currency": "usd",
  "customer": {
    "id": "411486491630370816",
    "created_at": "2024-01-01T00:00:00Z",
    "metadata": {},
    "store_id": "411486491630370816",
    "minecraft": {
      "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
      "avatar_url": "string",
      "name": "notch"
    },
    "minecraft_platform": "unknown",
    "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
    "name": "m0uka",
    "profile": {
      "id": "string",
      "name": "string",
      "platform": "steam",
      "avatar_url": "string"
    },
    "steam": {
      "id": "76561197960287930",
      "avatar_url": "string",
      "name": "string"
    },
    "steam_id": "76561197960287930",
    "updated_at": "2024-01-01T00:00:00Z",
    "xbox_xuid": "string"
  },
  "customer_id": "411486491630370816",
  "customer_ip": "192.168.1.1",
  "discount_amount": 500,
  "discount_amount_str": "$5.00",
  "giftcard_usage_amount": 0,
  "giftcard_usage_amount_str": "$0.00",
  "is_subscription": true,
  "lines": [
    {
      "id": "411486491630370816",
      "discount_amount": 0,
      "discount_amount_str": "$0.00",
      "gift": false,
      "giftcard_usage_amount": 0,
      "giftcard_usage_amount_str": "$0.00",
      "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_name": "Premium Game Pass",
      "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",
      "checkout_line_id": "411486491630370816",
      "created_giftcard_id": "string",
      "custom_variables": {},
      "description": "string",
      "gift_to_customer": {
        "id": "411486491630370816",
        "created_at": "2024-01-01T00:00:00Z",
        "metadata": {},
        "store_id": "411486491630370816",
        "minecraft": {
          "id": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
          "avatar_url": "string",
          "name": "notch"
        },
        "minecraft_platform": "unknown",
        "minecraft_uuid": "f84c6a79-0a4e-45e0-879b-cd49ebd4c4e2",
        "name": "m0uka",
        "profile": {
          "id": "string",
          "name": "string",
          "platform": "steam",
          "avatar_url": "string"
        },
        "steam": {
          "id": "76561197960287930",
          "avatar_url": "string",
          "name": "string"
        },
        "steam_id": "76561197960287930",
        "updated_at": "2024-01-01T00:00:00Z",
        "xbox_xuid": "string"
      },
      "gift_to_customer_id": "411486491630370816",
      "payout_splits": [
        {
          "platform_fee": 0,
          "user_id": "411486491630370816",
          "percentage": 0
        }
      ],
      "pricing_region_id": "eu",
      "product_image_url": "https://cdn.example.com/images/premium-game-pass.jpg",
      "sale_id": "411486491630370816",
      "sale_version_id": "411486491630370816",
      "selected_gameserver_id": "411486491630370816",
      "subscription_change_line_id": "411486491630370816",
      "subscription_id": "411486491630370816",
      "subscription_interval_scale": "invalid",
      "subscription_interval_value": 1,
      "subscription_line_id": "411486491630370816",
      "trial_id": "411486491630370816"
    }
  ],
  "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": "pn-355eevennsow",
  "status": "created",
  "store_id": "411486491630370816",
  "subtotal_amount": 9995,
  "subtotal_amount_str": "$99.95",
  "tax_amount": 999,
  "tax_amount_str": "$9.99",
  "tax_jurisdictions": [
    {
      "name": "EU OSS",
      "taxes": [
        {
          "tax_amount": "string",
          "tax_name": "string",
          "tax_rate": "string",
          "taxable_amount": "string"
        }
      ],
      "not_taxed_reason": "string"
    }
  ],
  "total_amount": 10494,
  "total_amount_str": "$104.94",
  "type": "one_time",
  "affiliate_id": "411486491630370816",
  "billing_tax_id": "string",
  "checkout_id": "411486491630370816",
  "checkout_token": "c4qqilpphugeqf2gndnkk5ad8fdq",
  "completed_at": "2025-04-01T15:35:22Z",
  "coupon_id": "411486491630370816",
  "created_at": "2025-04-01T15:30:45Z",
  "giftcard_id": "411486491630370816",
  "last_payment_error": {
    "decline_code": "unknown",
    "message": "string"
  },
  "subscription_id": "411486491630370816"
}