Skip to main content

This page is also available as plain markdown · OpenAPI spec

List orders

GET 

/orders

List orders

Request

Query Parameters

    pageinteger
    Example: 1
    perPageinteger
    Example: 1
    querystring
    Example: unique-search-buyer
    sincestring
    Example: 2025-04-01
    sortstring
    Example: -date
    untilstring
    Example: 2025-04-30

200

Returns the owner's orders
dataobject[]required
objectstring
idstring
datestring
createdAtstring
updatedAtstring
amountnumber<float>
currencystring
paymentMethodstring
statusstring
customerobject
firstNamestringrequired
lastNamestringrequired
emailstringrequired
productobject
idstringrequired
namestringrequired
typestringrequired
datenullablerequired
paymentDetailsobject
subtotalnumber<float>required
discountsnumber<float>required
donationnumber<float>required
totalnumber<float>required
viewcyFeenumber<float>required
stripeFeenumber<float>required
refundedAmountnumber<float>required
netAmountnumber<float>required
refundablenullable
objectstringrequired
pageintegerrequired
totalPagesintegerrequired
perPageintegerrequired
totalCountintegerrequired
hasNextPagebooleanrequired
Example: returns_the_owner's_orders
{
  "data": [
    {
      "object": "order",
      "id": "T18",
      "date": "2025-04-10T12:00:00Z",
      "createdAt": "2025-04-10T12:00:00Z",
      "updatedAt": "2026-03-24T16:09:55Z",
      "amount": 50,
      "currency": "usd",
      "paymentMethod": "stripe",
      "status": "completed",
      "customer": {
        "firstName": "Bob",
        "lastName": "Buyer",
        "email": "bob-buyer@example.com"
      },
      "product": {
        "id": "piano-masterclass",
        "name": "Piano Masterclass",
        "type": "Course",
        "date": null
      },
      "paymentDetails": {
        "subtotal": 50,
        "discounts": 0,
        "donation": 0,
        "total": 50,
        "viewcyFee": 0,
        "stripeFee": 0,
        "refundedAmount": 0,
        "netAmount": 50
      },
      "refundable": null
    },
    {
      "object": "order",
      "id": "T17",
      "date": "2025-03-15T12:00:00Z",
      "createdAt": "2025-03-15T12:00:00Z",
      "updatedAt": "2026-03-24T16:09:55Z",
      "amount": 100,
      "currency": "usd",
      "paymentMethod": "stripe",
      "status": "completed",
      "customer": {
        "firstName": "Alice",
        "lastName": "Buyer",
        "email": "alice-buyer@example.com"
      },
      "product": {
        "id": "jazz-workshop",
        "name": "Jazz Workshop",
        "type": "Course",
        "date": null
      },
      "paymentDetails": {
        "subtotal": 100,
        "discounts": 0,
        "donation": 0,
        "total": 100,
        "viewcyFee": 0,
        "stripeFee": 0,
        "refundedAmount": 0,
        "netAmount": 100
      },
      "refundable": null
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 2,
  "hasNextPage": false
}

401

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