/api/v1/orders/{id}Retrieve a single order by its ID, including line items.
Customer email addresses are masked in the response.
Requires the Orders:View permission.
Path parameters
idstring· uuidrequiredThe order ID.
Order object
idstring· uuidrequiredThe order ID.
playerUsernamestringrequiredPlayer in-game name.
playerUuidstring· uuidMinecraft UUID, if known.
emailstringCustomer email, masked as
j***@example.com.statusstringrequiredOrder status.
- Values:
PendingPaidCancelledRefundedChargeback
totalAmountnumberrequiredFinal amount paid in
paymentCurrency.paymentProviderstringPayment provider used.
- Values:
StripePayPalManual
paymentCurrencystringISO 4217 currency code.
couponIdstring· uuidCoupon used, if any.
couponDiscountAmountnumberCoupon discount amount.
giftCardIdstring· uuidGift card used, if any.
giftCardAmountnumberAmount paid via gift card.
itemsobject[]requiredLine items (see schema below).
createdAtstring· date-timerequiredOrder creation timestamp.
updatedAtstring· date-timerequiredLast update timestamp.
Order item object
idstring· uuidrequiredLine item ID.
packageIdstring· uuidrequiredPackage purchased.
packageNamestringrequiredPackage name at time of purchase.
quantityintegerrequiredQuantity ordered.
priceAtPurchasenumberrequiredPrice per unit at the time of purchase.