Skip to main content

This page is also available as plain markdown · OpenAPI spec

Get order

GET 

/orders/:id

Get order

Request

Path Parameters

    idstringrequired
    Example: invalid

200

Returns order detail
objectstringrequired
idstringrequired
datestringrequired
createdAtstringrequired
updatedAtstringrequired
amountnumber<float>required
currencystringrequired
paymentMethodstringrequired
statusstringrequired
customerobjectrequired
firstNamestringrequired
lastNamestringrequired
emailstringrequired
productobjectrequired
idstringrequired
namestringrequired
typestringrequired
datenullablerequired
paymentDetailsobjectrequired
subtotalnumber<float>required
discountsnumber<float>required
donationnumber<float>required
totalnumber<float>required
viewcyFeenumber<float>required
stripeFeenumber<float>required
refundedAmountnumber<float>required
netAmountnumber<float>required
refundablebooleanrequired
orderItemsundefined[]required
totalRefundableAmountintegerrequired
alreadyRefundedAmountnumber<float>required
Example: returns_order_detail
{
  "object": "order_detail",
  "id": "T31",
  "date": "2026-03-24T16:09:56Z",
  "createdAt": "2026-03-24T16:09:56Z",
  "updatedAt": "2026-03-24T16:09:56Z",
  "amount": 75,
  "currency": "usd",
  "paymentMethod": "stripe",
  "status": "completed",
  "customer": {
    "firstName": "Jane",
    "lastName": "Customer",
    "email": "jane-customer@example.com"
  },
  "product": {
    "id": "vocal-training",
    "name": "Vocal Training",
    "type": "Course",
    "date": null
  },
  "paymentDetails": {
    "subtotal": 75,
    "discounts": 0,
    "donation": 0,
    "total": 75,
    "viewcyFee": 0,
    "stripeFee": 0,
    "refundedAmount": 0,
    "netAmount": 75
  },
  "refundable": false,
  "orderItems": [],
  "totalRefundableAmount": 0,
  "alreadyRefundedAmount": 0
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required"
}

404

Returns 404 for non-existent order
objectstringrequired
statusintegerrequired
messagestringrequired
Example: returns_404_for_non-existent_order
{
  "object": "error",
  "status": 404,
  "message": "Resource not found"
}