Skip to main content
GET
/
v1
/
invoices
List
curl --request GET \
  --url https://{defaultHost}/v1/invoices \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/invoices"
  },
  "data": [
    {
      "id": "2728c499-9746-4750-a2f2-da1ee0f3b2ba",
      "object": "invoice",
      "automatic_collection": false,
      "due_date": null,
      "footer": null,
      "issue_date": null,
      "live_mode": true,
      "memo": null,
      "metadata": {},
      "notifications_enabled": true,
      "order_number": null,
      "status": "draft",
      "portal_url": "http://app.example.com/portal_redirect/invoices/2728c499-9746-4750-a2f2-da1ee0f3b2ba",
      "notification_sent_at": null,
      "reminder_notification_sent_at": null,
      "checkout": "d59a3ea9-5491-4a0a-9a63-31a97695c934",
      "created_at": 1767909707,
      "updated_at": 1767909707
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
customer_ids[]
string[]

Only return objects that belong to the given customers.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
page
integer

The page of items you want returned.

​
query
string

The query to be used for full text search of this collection.

​
status[]
string[]

Only return objects with the given status.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.