Skip to main content

Installation

Requires PHP 8.3+

Quickstart

Configuration

Available Resources

Invoices

Requires v1.1.0 or later for the invoices resource, and v1.1.1 or later to identify the customer by customer_uuid.
Invoices are built from line items that each reference a merchant item (a fund or designation). Draft invoices can be edited; once sent they are locked. Identify the customer with customer_uuid — the same uuid every other resource uses, and the only identifier the customer endpoints return.

Statuses

$invoice->status is one of draft, sent, viewed, partially_paid, paid, void or refunded — lowercase. Compare against paid to detect settlement; partially_paid means a payment landed but a balance remains, which $invoice->balance reports. There is no overdue status — being overdue is a property of an open invoice past its due date and reads as $invoice->isOverdue. overdue and all are accepted as filter values on list().

Recurring invoices

Error Handling