Skip to main content
GET
Get an Invoice

Authorizations

Authorization
string
header
required

API token from Dashboard > Settings > API Tokens.

Path Parameters

invoice_id
string<uuid>
required

Response

Successful Response

id
string<uuid>
required
invoice_number
string
required
status
enum<string>
required

Invoice status enumeration.

Available options:
draft,
pending,
paid,
failed,
refunded,
cancelled
subtotal
number
required
tax
number
required
total
number
required

Total, in USD.

refunded_total
number
required
period_start
string<date-time>
required
period_end
string<date-time>
required
due_date
string<date-time>
required
paid_at
string<date-time> | null
required
payment_method
string | null
required
hosted_invoice_url
string | null
required

Hosted invoice page, or null.

created_at
string<date-time>
required
items
InvoiceItem · object[]
required