Invoice

{
	"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",
	"line_items": [
		{
			"label": "Platform subscription",
			"position": 42,
			"quantity": 6.9,
			"total": 6.9,
			"unit_price": 6.9
		}
	],
	"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.

Show child attributes

currency

Currencies

required

The currency used for all prices on this plan (e.g., ‘usd’, ‘eur’). All monetary amounts on the plan are denominated in this currency.Available options: 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

formatted_price

string

required

The formatted price (including currency) for the plan.Example: $10.00

string

required

The unique identifier for the plan.Example: plan_xxxxxxxxxxxxx

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

string

required

The unique identifier for the invoice.Example: inv_xxxxxxxxxxxxxx

line_items

array<object>

required

Optional line items that break down the invoice total into individual charges.

Show child attributes

label

string

required

The label or description for this line item.Example: Platform subscription

position

integer

required

The display order of this line item within the invoice.Example: 42

quantity

number

required

The quantity of this line item.Example: 6.9

total

number

required

The computed total for this line item (quantity * unit_price).Example: 6.9

unit_price

number

required

The unit price for this line item.Example: 6.9

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.

Show child attributes

string

required

The unique identifier for the user.Example: user_xxxxxxxxxxxxx

name

string | null

required

The user’s display name shown on their public profile.Example: John Doe

username

string

required

The user’s unique username shown on their public profile.Example: johndoe42

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats