List orders

GET 
/orders

List orders

Request

Query Parameters

pageinteger
Example: 1
perPageinteger
Example: 1
querystring
Example: jane-customer
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

datestringrequired

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

metaobjectrequired

requestIdstringrequired

Example: returns_the_owner's_orders

{
  "data": [
    {
      "object": "order",
      "id": "T572027702",
      "date": "2025-05-01T12:00:00Z",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00",
      "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": "2025-06-18T18:00:00Z"
      },
      "paymentDetails": {
        "subtotal": 75,
        "discounts": 0,
        "donation": 0,
        "total": 75,
        "viewcyFee": 7.5,
        "stripeFee": 3.75,
        "refundedAmount": 0,
        "netAmount": 63.75
      },
      "refundable": null
    },
    {
      "object": "order",
      "id": "T354828371",
      "date": "2025-04-10T12:00:00Z",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00",
      "amount": 50,
      "currency": "usd",
      "paymentMethod": "stripe",
      "status": "completed",
      "customer": {
        "firstName": "Bob",
        "lastName": "Customer",
        "email": "bob@example.com"
      },
      "product": {
        "id": "piano-masterclass",
        "name": "Piano Masterclass",
        "type": "Course",
        "date": "2025-06-15T18:00:00Z"
      },
      "paymentDetails": {
        "subtotal": 50,
        "discounts": 0,
        "donation": 0,
        "total": 50,
        "viewcyFee": 5,
        "stripeFee": 2.5,
        "refundedAmount": 0,
        "netAmount": 42.5
      },
      "refundable": null
    },
    {
      "object": "order",
      "id": "T339434021",
      "date": "2025-03-15T12:00:00Z",
      "createdAt": "2024-01-02T03:04:05+01:00",
      "updatedAt": "2024-01-02T03:04:05+01:00",
      "amount": 100,
      "currency": "usd",
      "paymentMethod": "stripe",
      "status": "completed",
      "customer": {
        "firstName": "Alice",
        "lastName": "Patron",
        "email": "alice@example.com"
      },
      "product": {
        "id": "jazz-workshop",
        "name": "Jazz Workshop",
        "type": "Course",
        "date": "2025-06-11T18:00:00Z"
      },
      "paymentDetails": {
        "subtotal": 100,
        "discounts": 0,
        "donation": 0,
        "total": 100,
        "viewcyFee": 10,
        "stripeFee": 5,
        "refundedAmount": 0,
        "netAmount": 85
      },
      "refundable": null
    }
  ],
  "object": "list",
  "page": 1,
  "totalPages": 1,
  "perPage": 25,
  "totalCount": 3,
  "hasNextPage": false,
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}

401

Returns 401

objectstringrequired

statusintegerrequired

messagestringrequired

metaobjectrequired

requestIdstringrequired

Example: returns_401

{
  "object": "error",
  "status": 401,
  "message": "Authentication required",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}