import Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const invoiceListItem of client.invoices.list()) {
console.log(invoiceListItem.id);
}{
"data": [
{
"id": "inv_xxxxxxxxxxxxxx",
"created_at": "2023-12-01T05:00:00.401Z",
"status": "draft",
"number": "#0001",
"due_date": "2023-12-01T05:00:00.401Z",
"email_address": "customer@example.com",
"fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
"current_plan": {
"id": "plan_xxxxxxxxxxxxx",
"formatted_price": "$10.00",
"currency": "usd"
},
"user": {
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"username": "johndoe42"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}Returns a paginated list of invoices for a company, with optional filtering by product, status, collection method, and creation date.
Required permissions:
invoice:basic:readimport Whop from '@whop/sdk';
const client = new Whop({
apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const invoiceListItem of client.invoices.list()) {
console.log(invoiceListItem.id);
}{
"data": [
{
"id": "inv_xxxxxxxxxxxxxx",
"created_at": "2023-12-01T05:00:00.401Z",
"status": "draft",
"number": "#0001",
"due_date": "2023-12-01T05:00:00.401Z",
"email_address": "customer@example.com",
"fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
"current_plan": {
"id": "plan_xxxxxxxxxxxxx",
"formatted_price": "$10.00",
"currency": "usd"
},
"user": {
"id": "user_xxxxxxxxxxxxx",
"name": "John Doe",
"username": "johndoe42"
}
}
],
"page_info": {
"end_cursor": "<string>",
"start_cursor": "<string>",
"has_next_page": true,
"has_previous_page": true
}
}A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
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.
42
Returns the last n elements from the list.
42
The unique identifier of the company to list invoices for.
"biz_xxxxxxxxxxxxxx"
The sort direction for ordering results, either ascending or descending.
asc, desc Filter invoices to only those associated with these specific product identifiers.
Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.
Filter invoices by their collection method.
The method of collection for an invoice.
send_invoice, charge_automatically Filter invoices by their current status.
The different statuses an invoice can be in
draft, open, paid, past_due, void The field to order results by, such as creation date or due date.
id, created_at, due_date Only return invoices created before this timestamp.
"2023-12-01T05:00:00.401Z"
Only return invoices created after this timestamp.
"2023-12-01T05:00:00.401Z"
Was this page helpful?