> ## Documentation Index > Fetch the complete documentation index at: https://docs.whop.com/llms.txt > Use this file to discover all available pages before exploring further. # 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` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /invoices openapi: 3.1.0 info: description: >- The Whop REST API. Please see https://docs.whop.com/developer/api/getting-started for more details. termsOfService: https://whop.com/tos-developer-api/ title: Whop API version: 1.0.0 x-api-version-date: '2026-08-21' servers: - description: Production Whop API url: https://api.whop.com/api/v1 - description: Sandbox Whop API url: https://sandbox-api.whop.com/api/v1 security: [] tags: - description: Products name: Products - description: Payments name: Payments - description: Refunds name: Refunds - description: Disputes name: Disputes - description: Dispute alerts name: Dispute alerts - description: Resolution center cases name: Resolution center cases - description: Checkout configurations name: Checkout configurations - description: Setup intents name: Setup intents - description: Payment methods name: Payment methods - description: Invoices name: Invoices - description: Promo codes name: Promo codes - description: Card transactions name: Card transactions - description: Ledger accounts name: Ledger accounts - description: Withdrawals name: Withdrawals - description: Payout methods name: Payout methods - description: Verifications name: Verifications - description: Identity profiles name: Identity profiles - description: Payout accounts name: Payout accounts - description: Topups name: Topups - description: Companies name: Companies - description: Authorized users name: Authorized users - description: Fee markups name: Fee markups - description: Members name: Members - description: Memberships name: Memberships - description: Leads name: Leads - description: Entries name: Entries - description: Shipments name: Shipments - description: Reviews name: Reviews - description: Company token transactions name: Company token transactions - description: Affiliates name: Affiliates - description: Experiences name: Experiences - description: Forums name: Forums - description: Forum posts name: Forum posts - description: Chat channels name: Chat channels - description: Support channels name: Support channels - description: Messages name: Messages - description: Reactions name: Reactions - description: Dm members name: Dm members - description: Dm channels name: Dm channels - description: Notifications name: Notifications - description: Courses name: Courses - description: Course chapters name: Course chapters - description: Course lessons name: Course lessons - description: Course students name: Course students - description: Course lesson interactions name: Course lesson interactions - description: Apps name: Apps - description: Webhooks name: Webhooks - description: App builds name: App builds - description: Access tokens name: Access tokens - description: Account links name: Account links - description: Files name: Files - description: Ai chats name: Ai chats - description: Bounties name: Bounties - description: Stats name: Stats - description: Conversions name: Conversions - description: Ad reports name: Ad reports paths: /invoices: get: tags: - Invoices summary: List invoices description: >- 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` operationId: listInvoice parameters: - explode: true in: query name: after required: false schema: description: >- Returns the elements in the list that come after the specified cursor. type: string style: form - explode: true in: query name: before required: false schema: description: >- Returns the elements in the list that come before the specified cursor. type: string style: form - explode: true in: query name: first required: false schema: description: Returns the first _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: last required: false schema: description: Returns the last _n_ elements from the list. example: 42 type: integer style: form - explode: true in: query name: company_id required: false schema: description: The unique identifier of the company to list invoices for. example: biz_xxxxxxxxxxxxxx type: string style: form - explode: true in: query name: direction required: false schema: $ref: '#/components/schemas/Direction' description: >- The sort direction for ordering results, either ascending or descending. style: form - explode: true in: query name: product_ids required: false schema: description: >- Filter invoices to only those associated with these specific product identifiers. items: description: >- 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. type: string type: array style: form - explode: true in: query name: collection_methods required: false schema: description: Filter invoices by their collection method. items: $ref: '#/components/schemas/InvoiceCollectionMethods' type: array style: form - explode: true in: query name: statuses required: false schema: description: Filter invoices by their current status. items: $ref: '#/components/schemas/InvoiceStatuses' type: array style: form - explode: true in: query name: order required: false schema: $ref: '#/components/schemas/InvoicesSortableColumns' description: The field to order results by, such as creation date or due date. style: form - explode: true in: query name: created_before required: false schema: description: Only return invoices created before this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: string style: form - explode: true in: query name: created_after required: false schema: description: Only return invoices created after this timestamp. example: '2023-12-01T05:00:00.401Z' format: date-time type: string style: form responses: '200': content: application/json: schema: description: The connection type for PublicInvoice. properties: data: description: A list of nodes. items: $ref: '#/components/schemas/InvoiceListItem' type: array page_info: $ref: '#/components/schemas/PageInfo' description: Information to aid in pagination. required: - data - page_info type: object description: A successful response '400': content: application/json: example: error: code: parameter_missing message: 'Missing required parameter: amount.' param: amount type: invalid_request_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Bad request '401': content: application/json: example: error: message: Invalid or missing API key type: unauthorized schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Unauthorized '403': content: application/json: example: error: message: You do not have permission to access this resource type: forbidden schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Forbidden '404': content: application/json: example: error: message: Resource not found type: not_found schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Not found '422': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Verification required '429': content: application/json: example: error: null schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Too many requests '500': content: application/json: example: error: message: An unexpected error occurred type: internal_server_error schema: properties: error: properties: code: description: >- A short string indicating the specific error code, e.g. 'parameter_missing', 'parameter_invalid', 'invalid_json' type: - string - 'null' message: type: string param: description: The parameter that caused the error, if applicable type: - string - 'null' type: type: string required: - type - message type: object required: - error type: object description: Internal server error security: - bearerAuth: - invoice:basic:read x-codeSamples: - lang: JavaScript source: |- 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); } components: schemas: Direction: description: The direction of the sort. enum: - asc - desc type: string InvoiceCollectionMethods: description: The method of collection for an invoice. enum: - send_invoice - charge_automatically type: string InvoiceStatuses: description: The different statuses an invoice can be in enum: - draft - open - paid - past_due - uncollectible - void type: string InvoicesSortableColumns: description: Which columns can be used to sort. enum: - id - created_at - due_date type: string InvoiceListItem: description: >- An invoice represents an itemized bill sent by a company to a customer for a specific product and plan, tracking the amount owed, due date, and payment status. properties: created_at: description: The datetime the invoice was created. example: '2023-12-01T05:00:00.401Z' format: date-time type: string current_plan: description: The plan that this invoice charges for. properties: currency: $ref: '#/components/schemas/Currencies' description: >- The currency used for all prices on this plan (e.g., 'usd', 'eur'). All monetary amounts on the plan are denominated in this currency. formatted_price: description: The formatted price (including currency) for the plan. example: $10.00 type: string id: description: The unique identifier for the plan. example: plan_xxxxxxxxxxxxx type: string required: - id - formatted_price - currency type: object due_date: description: >- The deadline by which payment is expected. Null if the invoice is collected automatically. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' email_address: description: >- The email address of the customer this invoice is addressed to. Null if no email is on file. example: customer@example.com type: - string - 'null' fetch_invoice_token: description: >- A signed token that allows fetching invoice data publicly without authentication. example: eyJhbGciOiJIUzI1NiJ9... type: string id: description: The unique identifier for the invoice. example: inv_xxxxxxxxxxxxxx type: string line_items: description: >- Optional line items that break down the invoice total into individual charges. items: description: >- A line item on an invoice, representing a single charge with a label, quantity, and unit price. properties: label: description: The label or description for this line item. example: Platform subscription type: string position: description: The display order of this line item within the invoice. example: 42 type: integer quantity: description: The quantity of this line item. example: 6.9 type: number total: description: The computed total for this line item (quantity * unit_price). example: 6.9 type: number unit_price: description: The unit price for this line item. example: 6.9 type: number required: - label - quantity - unit_price - total - position type: object type: array number: description: The sequential invoice number for display purposes. example: '#0001' type: string payment_processing: description: >- Whether a payment on this invoice is still clearing. True while a delayed payment method such as ACH or SEPA settles, during which the invoice stays open and is not marked past due. type: boolean status: $ref: '#/components/schemas/InvoiceStatuses' description: >- The current payment status of the invoice, such as draft, open, paid, or void. user: description: >- The user this invoice is addressed to. Null if the user account has been removed. properties: id: description: The unique identifier for the user. example: user_xxxxxxxxxxxxx type: string name: description: The user's display name shown on their public profile. example: John Doe type: - string - 'null' username: description: The user's unique username shown on their public profile. example: johndoe42 type: string required: - id - name - username type: - object - 'null' required: - id - created_at - status - payment_processing - number - due_date - email_address - fetch_invoice_token - current_plan - line_items - user type: object PageInfo: description: Information about pagination in a connection. properties: end_cursor: description: When paginating forwards, the cursor to continue. type: - string - 'null' has_next_page: description: When paginating forwards, are there more items? type: boolean has_previous_page: description: When paginating backwards, are there more items? type: boolean start_cursor: description: When paginating backwards, the cursor to continue. type: - string - 'null' required: - end_cursor - start_cursor - has_next_page - has_previous_page type: object Currencies: description: The available currencies on the platform enum: - usd - sgd - inr - aud - brl - cad - dkk - eur - nok - gbp - sek - chf - hkd - huf - jpy - mxn - myr - pln - czk - nzd - aed - eth - ape - cop - ron - thb - bgn - idr - dop - php - try - krw - twd - vnd - pkr - clp - uyu - ars - zar - dzd - tnd - mad - kes - kwd - jod - all - xcd - amd - bsd - bhd - bob - bam - khr - crc - xof - egp - etb - gmd - ghs - gtq - gyd - ils - jmd - mop - mga - mur - mdl - mnt - nad - ngn - mkd - omr - pyg - pen - qar - rwf - sar - rsd - lkr - tzs - ttd - uzs - rub - btc - cny - usdt - kzt - awg - whop_usd - xau type: string securitySchemes: bearerAuth: bearerFormat: auth-scheme description: >- An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with `Bearer`, for example `Bearer ***************************`. scheme: bearer type: http ````