v1

latestOpenAPI 3.0.02026-07-244074117.0 KB
Customers

List customer's orders

Lists all orders for a single customer using pagination.

get/v4/customers/{customerId}/orders

Path parameters

customerIdstring required

The customer ID assigned by Slope

Query parameters

status'pending' | 'approved' | 'submitted' | 'opening' | 'open' | 'finalizing' | 'finalized' | 'unpaid' | 'partiallyPaid' | 'complete' | 'defaulted' | 'rejected' | 'canceled' | 'refunded' | 'repayment'

When specified, only orders with the given status are returned.

limitinteger

The maximum number of objects to list.

orderBystring[]

The object attribute(s) to sort by.

order'asc' | 'desc'

The direction to sort by, one of asc or desc.

beforeCursorstring

The cursor used to fetch the previous page of objects.

afterCursorstring

The cursor used to fetch the next page of objects.

Headers

Slope-Link-Tokenstring

The link token generated when the customer granted you access to their Slope account.

Response

The paginated list of customers orders.

Example response

{
  "data": [
    {
      "paymentSchedule": [
        {
          "date": "2024-01-01"
        }
      ],
      "quotes": [
        {
          "payments": [
            {
              "number": 1,
              "date": "2024-02-15T00:00:00Z",
              "principal": 95000,
              "customerFee": 500,
              "amount": 105000,
              "financingFee": 2500
            }
          ]
        }
      ]
    }
  ]
}