GET
/
invoices
JavaScript
import Whopsdk from 'whopsdk';

const client = new Whopsdk({
  apiKey: 'My API Key',
});

// Automatically fetches more pages as needed.
for await (const invoiceListItem of client.invoices.list({ company_id: 'biz_xxxxxxxxxxxxxx' })) {
  console.log(invoiceListItem.id);
}
{
  "data": [
    null
  ],
  "page_info": {
    "end_cursor": "<string>",
    "start_cursor": "<string>",
    "has_next_page": true,
    "has_previous_page": true
  }
}

Query Parameters

​
after
string | null

Returns the elements in the list that come after the specified cursor.

​
before
string | null

Returns the elements in the list that come before the specified cursor.

​
first
integer | null

Returns the first n elements from the list.

Example:

42

​
last
integer | null

Returns the last n elements from the list.

Example:

42

​
company_id
string
required

The ID of the company to list invoices for

Example:

"biz_xxxxxxxxxxxxxx"

​
direction
enum<string> | null

The direction of the sort.

Available options:
asc,
desc
​
filters
object | null

The filters to apply to the invoices

​
order
enum<string> | null

Which columns can be used to sort.

Available options:
id,
created_at,
due_date

Response

A successful response

The connection type for Invoice.

​
data
array | null
required

A list of nodes.

​
page_info
object
required

Information to aid in pagination.