Skip to main content
Scope: invoices:read
string
required
The invoice’s id. It is also data.id on invoice.* events.
A bill the business pays is not an invoice and answers 404 not_found. Read it with GET /v1/payables/{payableId}.

Response

string
draft (not sent), open (sent, awaiting payment), paid, void, declined or blocked (the customer’s business refused it).
string
none, scheduled, processing, held, settled, failed or clawback.
object
id (the contact id, or null while the customer is a pending invitation) and displayName.
enabled is true only while the customer can pay through the link: it is on and not expired, the invoice is open with money due, and the business can receive. url is the hosted page. expiresAt may be null.
string
The invoice in the Cleo web app.
array
name, description, quantity, unitAmountCents, totalCents.