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.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, all 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
Chargebacks, documents and held funds
Requires v1.3.0 or later, as do authorize/capture,
applicationStatus and the subscription resources.Retrying safely
Requires v1.4.0 or later. Charges, authorizations, captures, refunds and voids send anIdempotency-Key, so a call that timed out can be retried without charging twice. The SDK generates a key for each call and reuses it on its own retries. Pass your own key, the same one on every retry of that payment, to stay safe across restarts:
IdempotencyException. See Retrying Safely.

