Orders
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
The ID of the store to retrieve orders for.
411486491630370816The maximum number of items to return in a single request.
Returns items after the specified ID. Used for forward pagination through results.
411486491630370816Returns items before the specified ID. Used for backward pagination through results.
411486491630370816Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
Order ID
411486491630370816Customer ID
411486491630370816Billing Email
Customer IP
Subscription ID
411486491630370816Checkout ID
411486491630370816Flag indicating if the order is a subscription
Affiliate ID
411486491630370816Coupon ID
411486491630370816Gift card ID
411486491630370816Product ID
411486491630370816Sale ID
411486491630370816OK
Represents a customer order
411486491630370816The PayNow order ID identifier starting with pn-.
pn-355eevennsow411486491630370816411486491630370816Defines the type of items contained in an order
411486491630370816The checkout token for this order
c4qqilpphugeqf2gndnkk5ad8fdq411486491630370816Signifies if the order is a subscription order
411486491630370816411486491630370816411486491630370816The billing name for this order
John DoeThe billing country for this order
USThe billing cycle sequence (current renewal count) if this is a subscription order
The IP address (IPv4 or IPv6) of the customer at time of order
192.168.1.1The currency code used for this order
usdThe total discount amount applied to this order in smallest currency unit
500The discount amount formatted as a string
$5.00The subtotal amount for this order in smallest currency unit
9995The subtotal amount formatted as a string
$99.95The tax amount for this order in smallest currency unit
999The tax amount formatted as a string
$9.99The total amount for this order in smallest currency unit
10494The total amount formatted as a string
$104.94The amount of gift card value used for this order in smallest currency unit
0The gift card usage amount formatted as a string
$0.00The presentment currency code used for this order (currency shown to customer)
eurThe presentment subtotal amount in smallest currency unit
9995The presentment subtotal amount formatted as a string
€99.95The presentment discount amount in smallest currency unit
500The presentment discount amount formatted as a string
€5.00The presentment gift card usage amount in smallest currency unit
0The presentment gift card usage amount formatted as a string
€0.00The presentment tax amount in smallest currency unit
999The presentment tax amount formatted as a string
€9.99The presentment total amount in smallest currency unit
10494The presentment total amount formatted as a string
€104.94The date and time when this order was created
2025-04-01T15:30:45ZThe date and time when this order was completed, if applicable
2025-04-01T15:35:22ZError response
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
The ID of the store to retrieve the order for.
411486491630370816The ID of the order.
411486491630370816OK
Represents a customer order
411486491630370816The PayNow order ID identifier starting with pn-.
pn-355eevennsow411486491630370816411486491630370816Defines the type of items contained in an order
411486491630370816The checkout token for this order
c4qqilpphugeqf2gndnkk5ad8fdq411486491630370816Signifies if the order is a subscription order
411486491630370816411486491630370816411486491630370816The billing name for this order
John DoeThe billing country for this order
USThe billing cycle sequence (current renewal count) if this is a subscription order
The IP address (IPv4 or IPv6) of the customer at time of order
192.168.1.1The currency code used for this order
usdThe total discount amount applied to this order in smallest currency unit
500The discount amount formatted as a string
$5.00The subtotal amount for this order in smallest currency unit
9995The subtotal amount formatted as a string
$99.95The tax amount for this order in smallest currency unit
999The tax amount formatted as a string
$9.99The total amount for this order in smallest currency unit
10494The total amount formatted as a string
$104.94The amount of gift card value used for this order in smallest currency unit
0The gift card usage amount formatted as a string
$0.00The presentment currency code used for this order (currency shown to customer)
eurThe presentment subtotal amount in smallest currency unit
9995The presentment subtotal amount formatted as a string
€99.95The presentment discount amount in smallest currency unit
500The presentment discount amount formatted as a string
€5.00The presentment gift card usage amount in smallest currency unit
0The presentment gift card usage amount formatted as a string
€0.00The presentment tax amount in smallest currency unit
999The presentment tax amount formatted as a string
€9.99The presentment total amount in smallest currency unit
10494The presentment total amount formatted as a string
€104.94The date and time when this order was created
2025-04-01T15:30:45ZThe date and time when this order was completed, if applicable
2025-04-01T15:35:22ZError response
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
The ID of the store to refund the order for.
411486491630370816The ID of the order.
411486491630370816411486491630370816Determines if the refund should be taken from the connected user's balance. Only relevant for connected platforms.
OK
411486491630370816411486491630370816411486491630370816411486491630370816411486491630370816Represents the current status of a refund in the system
Reason for failure if the refund has failed
Three-letter currency code of the refund
Amount of the refund in smallest currency unit (e.g., cents)
String representation of the refund amount, formatted for display
Amount of payment processor fees in smallest currency unit
String representation of gateway fee amount, formatted for display
Amount of tax being refunded in smallest currency unit
String representation of tax amount, formatted for display
Amount of platform fees in smallest currency unit
String representation of platform fee amount, formatted for display
Net amount for the store after fees in smallest currency unit
String representation of store net amount, formatted for display
Amount of the refund to be paid by the store in smallest currency unit
String representation of store refund amount, formatted for display
Optional currency code used for presentment to the customer if different from the base currency
Optional amount in presentment currency in smallest currency unit
Exchange rate used while refunding. Only present for payments made in non-settlement currency.
Indicates whether the refund should be taken from the connected user's balance. Only relevant for platforms.
Date and time when the refund was created
Optional date and time when the refund was approved
Optional date and time when the refund entered pending status
Optional date and time when the refund was completed
Optional date and time when the refund was canceled
Optional date and time when the refund failed
Error response
Last updated
Was this helpful?
