GET
/
invoices
curl --request GET \
  --url https://commerce.driv.ly/api/invoices
{
  "data": [
    {
      "id": "inv_39dk39dks933",
      "deal": "deal_5ksj49dkvdl2",
      "customer": "cus_k3j5s9qj3w0d"
    }
  ],
  "success": true,
  "page": 2,
  "nextPage": 3,
  "prevPage": 1,
  "totalPages": 3,
  "totalCount": 25,
  "limit": 10,
  "pagingCounter": 11,
  "hasPrevPage": true,
  "hasNextPage": true
}

Query Parameters

depth
integer

The number of levels of related objects to include in the response

sort
string

Pass the name of a top-level field to sort by that field in ascending order. Prefix the name of the field with a minus symbol ("-") to sort in descending order.

limit
number

Limit number of results, default 10

where
object

Search for results fitting criteria, uses qs library for query string parsing

Response

200
application/json

Invoices Found

The response is of type object.