Retrieve invoice

Retrieves the details of an existing invoice.

Required permissions:

• invoice:basic:read

GET /invoices/{id}

JavaScript

JavaScript

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);

200

{
  "id": "inv_xxxxxxxxxxxxxx",
  "created_at": "2023-12-01T05:00:00.401Z",
  "number": "#0001",
  "due_date": "2023-12-01T05:00:00.401Z",
  "email_address": "[e-mail]",
  "fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
  "current_plan": {
    "id": "plan_xxxxxxxxxxxxx",
    "formatted_price": "$10.00"
  },
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}

Authorizations

Authorization · string · header · required

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 ***************************

Path Parameters

id · string · required

The unique identifier of the invoice, or a secure token.

Example:

"inv_xxxxxxxxxxxxxx"

Response

200

application/json

A successful response

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.

id · string · required

The unique identifier for the invoice.

Example:

"inv_xxxxxxxxxxxxxx"

created_at · string<date-time> · required

The datetime the invoice was created.

Example:

"2023-12-01T05:00:00.401Z"

status · enum<string> · required

The current payment status of the invoice, such as draft, open, paid, or void.

Available options: draft, open, paid, past_due, uncollectible, void

number · string · required

The sequential invoice number for display purposes.

Example:

"#0001"

due_date · string<date-time> | null · required

The deadline by which payment is expected. Null if the invoice is collected automatically.

Example:

"2023-12-01T05:00:00.401Z"

email_address · string | null · required

The email address of the customer this invoice is addressed to. Null if no email is on file.

Example:

"[e-mail]"

fetch_invoice_token · string · required

A signed token that allows fetching invoice data publicly without authentication.

Example:

"eyJhbGciOiJIUzI1NiJ9..."

current_plan · object · required

The plan that this invoice charges for.

Show child attributes

user · object · required

The user this invoice is addressed to. Null if the user account has been removed.

Show child attributes