Skip to main content
GET
Get invoice

Authorizations

Authorization
string
header
required

Your organization's active API key.

Path Parameters

invoiceId
string
required

The invoice ID from the invoice list.

Pattern: ^in_[A-Za-z0-9]+$

Response

Invoice

id
string
required
number
string | null
required
status
enum<string>
required
Available options:
open,
paid,
void,
uncollectible
description
string | null
required
currency
string
required
Example:

"usd"

total_cents
integer
required
amount_paid_cents
integer
required
amount_due_cents
integer
required
created_at
string<date-time>
required
paid_at
string<date-time> | null
required
hosted_invoice_url
string<uri> | null
required

Page where the invoice can be viewed and paid.

pdf_available
boolean
required

Whether GET /invoices/{invoiceId}/pdf can return a PDF.