Invoices

Returns a paginated list of invoices, optionally filtered by date range, client, or order ID.

Create a new invoice with line items, billing address, and optional shipping. Accepts both standard and flexible item formats.

terms values: upon_receipt, 7, 14, 30 (days).

items: Array of { id, qty, taxes[] } — required.

billingAddress and showBilling/showShipping control whether addresses are shown/required on the payment page.

customValues: Extra properties passed to the payment form. Keys must be pre-configured in the merchant setup.

applyDiscount: If applicable, applies a configured credit card discount.

customerId links the invoice to a customer vault.

overrideDefaultPaymentMethod: Override the default payment method from the customer vault.

Permanently delete an invoice.

Update an existing invoice.

status values: draft, overdue, sent, paid-in-full, partially-paid, cancelled (default: draft).

To cancel an invoice: Send { "status": "cancelled" }.

terms values (for update): upon_receipt, 30, 60, 90.

applyDiscount: Apply/remove the configured credit card discount.

customValues: Update custom field values (keys must be pre-configured in merchant setup).

Send an invoice to a customer via email. Provide email in the request body.

Generate a PDF file for the given invoice. Returns a JSON object with fileName and fileUrl (the URL to download the PDF).

Retrieve a single invoice by ID.

Send a payment link for this invoice via SMS. Provide phoneNumber (any valid US number including area code) in the request body.