Skip to main content
{
	"created_at": "2023-12-01T05:00:00.401Z",
	"current_plan": {
		"currency": "usd",
		"formatted_price": "$10.00",
		"id": "plan_xxxxxxxxxxxxx"
	},
	"due_date": "2023-12-01T05:00:00.401Z",
	"email_address": "customer@example.com",
	"fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
	"id": "inv_xxxxxxxxxxxxxx",
	"number": "#0001",
	"status": "draft",
	"user": {
		"id": "user_xxxxxxxxxxxxx",
		"name": "John Doe",
		"username": "johndoe42"
	}
}
​
created_at
string<date-time>
required
The datetime the invoice was created.Example: 2023-12-01T05:00:00.401Z
​
current_plan
object
required
The plan that this invoice charges for.
​
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: customer@example.com
​
fetch_invoice_token
string
required
A signed token that allows fetching invoice data publicly without authentication.Example: eyJhbGciOiJIUzI1NiJ9...
​
id
string
required
The unique identifier for the invoice.Example: inv_xxxxxxxxxxxxxx
​
number
string
required
The sequential invoice number for display purposes.Example: #0001
​
status
InvoiceStatuses
required
The current payment status of the invoice, such as draft, open, paid, or void.Available options: draft, open, paid, past_due, uncollectible, void
​
user
object | null
required
The user this invoice is addressed to. Null if the user account has been removed.