GET
/
invoices
List Invoices
curl --request GET \
  --url https://connect.withvayu.com/invoices \
  --header 'Authorization: Bearer <token>'
{
  "invoices": [
    {
      "customerId": "<string>",
      "contractId": "<string>",
      "name": "<string>",
      "billingCycle": {
        "startTime": "2023-11-07T05:31:56Z",
        "endTime": "2023-11-07T05:31:56Z"
      },
      "lineItems": [
        {
          "invoiceId": "<string>",
          "revenueBreakdown": {
            "total": 123,
            "subtotal": 123,
            "overage": 123,
            "discount": 123,
            "creditsUsed": 123,
            "tax": 1
          }
        }
      ],
      "amount": 123,
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "hasMore": true,
  "nextCursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
number
default:10
Required range: x <= 1000
​
cursor
string

Response

200
application/json

RequestSuccess

The response is of type object.