Skip to main content
GET
/
invoices
/
{id}
JavaScript
import Whop from '@whop/sdk';

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

const invoice = await client.invoices.retrieve('inv_xxxxxxxxxxxxxx');

console.log(invoice.id);
{
  "id": "inv_xxxxxxxxxxxxxx",
  "created_at": "2023-12-01T05:00:00.401Z",
  "status": "open",
  "number": "#0001",
  "due_date": "2023-12-01T05:00:00.401Z",
  "email_address": "[email protected]",
  "fetch_invoice_token": "<string>",
  "current_plan": {
    "id": "plan_xxxxxxxxxxxxx",
    "formatted_price": "$10.00",
    "currency": "usd"
  },
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

​
id
string
required

The ID of the invoice or a token

Example:

"inv_xxxxxxxxxxxxxx"

Response

A successful response

A statement that defines an amount due by a customer.

​
id
string
required

The ID of the invoice.

Example:

"inv_xxxxxxxxxxxxxx"

​
created_at
string<date-time>
required

The date the invoice was created.

Example:

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

​
status
enum<string>
required

The status of the invoice.

Available options:
open,
paid,
past_due,
void
​
number
string
required

The number of the invoice.

Example:

"#0001"

​
due_date
string<date-time> | null
required

The date the invoice is due.

Example:

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

​
email_address
string | null
required

The email address that the invoice was created for.

Example:

"[email protected]"

​
fetch_invoice_token
string
required

A signed token that allows fetching the invoice data publically without being authenticated.

​
current_plan
object
required

The plan that the invoice was created for.

​
user
object
required

The user that the invoice was created for.