API Reference
Invoices
Invoices with line items, paid through hosted checkout.
Create
Returns:
Send
Emails the customer a link to the hosted checkout for the backing session. Requires customerEmail to be set; returns 403 otherwise. A voided invoice can't be sent.
Void
Cannot void a paid invoice. Issue a refund instead. Voiding cancels the backing payment session.
Read
The list also takes customerId. It returns invoices whose payment session belongs to that customer, so an invoice nobody has opened yet won't match. from and to limit it to invoices created in a range. See List filters.
Lifecycle
An hourly scheduler job flips sent invoices past dueAt to overdue and fires invoice.overdue. Any invoice that isn't paid can be voided.
Webhook events
| Event | Fires when |
|---|---|
invoice.created | A new invoice was created |
invoice.paid | The backing session confirmed |
invoice.overdue | dueAt passed without payment |
Sending an invoice doesn't fire a webhook.

