715c4defcbbf
List invoices
Returns a paginated list of invoices for a company, with optional filtering by product, status, collection method, and creation date.
Required permissions:
- invoice:basic:read
Query parameters
Returns the elements in the list that come after the specified cursor.
Returns the elements in the list that come before the specified cursor.
Returns the first n elements from the list.
Returns the last n elements from the list.
The unique identifier of the company to list invoices for.
The direction of the sort.
Filter invoices to only those associated with these specific product identifiers.
Filter invoices by their collection method.
Filter invoices by their current status.
Which columns can be used to sort.
Only return invoices created before this timestamp.
Only return invoices created after this timestamp.
Response
A successful response
Example response
{
"data": [
{
"created_at": "2023-12-01T05:00:00.401Z",
"current_plan": {
"formatted_price": "$10.00",
"id": "plan_xxxxxxxxxxxxx"
},
"due_date": "2023-12-01T05:00:00.401Z",
"email_address": "customer@example.com",
"fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
"id": "inv_xxxxxxxxxxxxxx",
"line_items": [
{
"label": "Platform subscription",
"position": 42,
"quantity": 6.9,
"total": 6.9,
"unit_price": 6.9
}
],
"number": "#0001",
"user": {
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"username": "johndoe42"
}
}
]
}