PayNow

OrderLineDto

Represents an order line item in a customer's 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
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.
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
Example
{
  "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"
}