Invoice

{
  "id": "inv_xxxxxxxxxxxxxx",
  "created_at": "2023-12-01T05:00:00.401Z",
  "status": "draft",
  "number": "#0001",
  "due_date": "2023-12-01T05:00:00.401Z",
  "email_address": "customer@example.com",
  "fetch_invoice_token": "eyJhbGciOiJIUzI1NiJ9...",
  "current_plan": {
    "id": "plan_xxxxxxxxxxxxx",
    "formatted_price": "$10.00",
    "currency": "usd"
  },
  "user": {
    "id": "user_xxxxxxxxxxxxx",
    "name": "John Doe",
    "username": "johndoe42"
  }
}

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.

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,

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:

"customer@example.com"

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

Retrieve payment method

List invoices

⌘I

Introduction

Payins

Payouts

Identity

CRM

Engagement

Courses

Developer

AI

Stats