Skip to main content
Retrieves the full detail of a single invoice, identified by its in_… public ID or UUID. Unlike the list endpoint, the retrieve response always includes the lines.data array with every line item and its computed amounts.
Base URL: https://invoice.horizonpay.co

Authentication

string
required
Bearer token in the form Bearer inv_live_…. The token must carry the invoices:read scope.

Path Parameters

string
required
The invoice’s public ID (in_…) or its UUID. Both forms are accepted.

Request Example


Response Example

The status field is computed at read time. An invoice will be returned as overdue once its due_date has passed, without any explicit state transition. Always trust the value returned in the API response rather than a locally cached status.

Response Fields

string
Unique public identifier for the invoice, prefixed in_.
string
Always "invoice".
string | null
Human-readable invoice number (e.g. "INV/25-26/0042"). null while the invoice is a draft; permanently assigned on finalization.
string
Current status, computed at read time. One of draft, open, paid, overdue, or void.
string
The cus_… public ID of the customer attached to this invoice.
string
Three-letter ISO 4217 currency code.
string
"send_invoice" or "charge_automatically".
string
ISO 8601 date the invoice was issued (YYYY-MM-DD).
string | null
ISO 8601 date payment is due, or null if not set.
string | null
Notes shown on the invoice body. null if not set.
Footer text shown at the bottom of the invoice. null if not set.
integer
Sum of all line totals before discounts and tax, in minor units.
integer
Total discount applied across all line items, in minor units.
integer
Taxable base amount (subtotal minus discount), in minor units.
integer
Total tax charged, in minor units.
integer
Grand total (taxable + tax), in minor units.
integer
Amount currently owed, in minor units. 0 for draft, paid, and void invoices. Equals total for open and overdue invoices.
string | null
The total expressed as words. null if not generated.
string | null
Token component of the shareable public invoice URL. null until finalized.
string | null
ISO 8601 datetime of finalization, or null for drafts.
string | null
ISO 8601 datetime payment was recorded, or null.
string | null
ISO 8601 datetime the invoice was voided, or null.
string | null
Reason provided when voiding, or null.
string
ISO 8601 datetime the invoice record was created.
string
ISO 8601 datetime of the last modification to the invoice record.
object
Always present on retrieve. Contains a data array of line item objects.
string
Unique identifier for the line item, prefixed ii_.
string
Always "invoiceitem".
string | null
The price_… public ID of the catalog price, or null for ad-hoc lines.
string | null
The prod_… public ID of the parent product, or null for ad-hoc lines.
string
The description of this line item.
number
Number of units billed.
string
Unit of measure code (e.g. "HRS", "NOS", "KGS").
integer
Price per unit in minor units.
integer
Line total after applying discount_percent, in minor units.
number
Percentage discount applied to this line (0–100).
number
Tax rate applied to this line as a percentage (0–100).
integer
Tax amount charged on this line, in minor units.

Error Codes