> ## 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. # Retrieve invoice > Retrieves the details of an existing invoice. Required permissions: - `invoice:basic:read` - `member:email:read` - `member:basic:read` - `payment:basic:read` ## OpenAPI ````yaml /openapi/api-v1-stable.json get /invoices/{id} 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/{id}: get: tags: - Invoices summary: Retrieve invoice description: |- Retrieves the details of an existing invoice. Required permissions: - `invoice:basic:read` - `member:email:read` - `member:basic:read` - `payment:basic:read` operationId: retrieveInvoice parameters: - description: The unique identifier of the invoice, or a secure token. in: path name: id required: true schema: example: inv_xxxxxxxxxxxxxx type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invoice' 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 - member:email:read - member:basic:read - payment: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 }); const invoice = await client.invoices.retrieve('inv_xxxxxxxxxxxxxx'); console.log(invoice.id); components: schemas: Invoice: 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: automatically_finalizes_at: description: >- The date and time when the invoice will be automatically finalized. For charge_automatically, triggers an automatic charge. For send_invoice, sends the invoice email at the specified time. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' charge_buyer_fee: description: >- Whether the invoice includes a buyer processing fee on top of the plan price. type: boolean collection_method: $ref: '#/components/schemas/InvoiceCollectionMethods' description: >- The method used to collect payment for this invoice, such as automatic charging or manual payment. company: description: The company that issued this invoice. properties: id: description: The unique identifier for the company. example: biz_xxxxxxxxxxxxxx type: string required: - id type: object 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. description: description: >- A text description of the plan visible to customers. Maximum 1000 characters. Null if no description is set. example: >- Monthly access to all premium analytics dashboards and data exports. type: - string - 'null' 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 - description type: object customer_name: description: >- The full name of the customer this invoice is addressed to. Null if no name is on file. example: Jane Doe type: - string - 'null' 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 mailing_address: description: >- The billing/mailing address associated with this invoice, if one was provided at creation time. properties: city: description: The city of the address. type: - string - 'null' country: description: The country of the address. type: - string - 'null' line1: description: The line 1 of the address. type: - string - 'null' line2: description: The line 2 of the address. type: - string - 'null' name: description: The name of the customer. type: - string - 'null' phone: description: The phone number of the customer. type: - string - 'null' postal_code: description: The postal code of the address. type: - string - 'null' state: description: The state of the address. type: - string - 'null' required: - name - line1 - line2 - city - state - postal_code - country - phone type: - object - 'null' member: description: >- The member that the invoice was created for. Null when the invoice is addressed to an email address with no member record behind it. properties: id: description: The unique identifier for the company member. type: string required: - id type: - object - 'null' number: description: The sequential invoice number for display purposes. example: '#0001' type: string pay_online_url: description: >- The checkout URL where the customer can pay this invoice online, with their email address pre-filled and locked. type: - string - 'null' payment: description: >- The payment that settled this invoice. Null while the invoice is unpaid, when the invoice was marked paid manually, and on a subscription renewal invoice, where the settling payment cannot yet be identified. properties: id: description: The unique identifier for the payment. example: pay_xxxxxxxxxxxxxx type: string required: - id type: - object - 'null' 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 product: description: The product that this invoice was generated for. properties: id: description: The unique identifier for the product. example: prod_xxxxxxxxxxxxx type: string title: description: >- The display name of the product shown to customers on the product page and in search results. example: Pickaxe Analytics type: string required: - id - title type: object status: $ref: '#/components/schemas/InvoiceStatuses' description: >- The current payment status of the invoice, such as draft, open, paid, or void. subscription_billing_anchor_at: description: >- The date that defines when the subscription billing cycle starts. When set on a renewal plan invoice, all future billing periods anchor to this date. example: '2023-12-01T05:00:00.401Z' format: date-time type: - string - 'null' updated_at: description: The datetime the invoice was last updated. example: '2023-12-01T05:00:00.401Z' format: date-time type: string user: description: >- The user this invoice is addressed to. Null if the user account has been removed. properties: email: description: >- The user's email address. Requires the member:email:read permission to access. Null if not authorized. example: john.doe@example.com type: - string - 'null' 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 - email type: - object - 'null' required: - id - created_at - status - payment_processing - number - due_date - email_address - fetch_invoice_token - line_items - updated_at - company - user - member - payment - automatically_finalizes_at - subscription_billing_anchor_at - collection_method - charge_buyer_fee - customer_name - pay_online_url - current_plan - product - mailing_address type: object InvoiceCollectionMethods: description: The method of collection for an invoice. enum: - send_invoice - charge_automatically type: string 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 InvoiceStatuses: description: The different statuses an invoice can be in enum: - draft - open - paid - past_due - uncollectible - void 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 ````