Prerequisites
- Bearer token with admin access +
?o={organization_id}
Invoice Actions
Cancel an Invoice
Mark as Paid
Mark a SENT invoice as paid without processing a payment:send_notification to true to email the customer a payment confirmation.
Change Recipient
Transfers an invoice to a different customer. This cancels the original invoice and creates a new copy for the new recipient:Charge a Subscription Invoice Again
A subscription invoice whose automatic charge failed stays open: it has no due date, so no payment reminder is scheduled, and nothing retries the charge. Charge the open amount again with the subscription’s stored payment method, or with another confirmed payment setup of the same subscriber:payment_setup_id to use the subscription’s payment method. The response is the invoice, with the attempt’s payment (id, status, amount) in meta.payment. Only open (sent or overdue) subscription invoices with an open amount can be charged, never while a payment is pending, and at most 3 times per invoice and day.
Send a Payment Reminder
Send the customer the payment reminder mail for an open invoice now, whatever the organization’s automatic reminder setting says:Creating an Invoice
All examples below assumeBASE_URL = https://{your-domain}/api/v1.
1
Find a Customer by Email
email filter performs an exact (case-insensitive) match.For a fuzzy name/email/phone search, use the search filter instead:Filter by Custom Field
Custom fields are referenced by their UUID. See Custom Field Filters for the full syntax and supported operators.true / false as the value. For multi-select fields, the in operator accepts comma-separated values.2
Create a Customer (if not found)
email, localeCreate the customer’s address as a separate resource:3
4
Add Line Items
* Provide the amount matching the invoice direction. The backend derives the other automatically.Repeat for each line item. Invoice totals recalculate after each item.
5
Send the Invoice
sent and delivers via the configured notification channel.6
Mark as Paid (optional)
Full Workflow Summary
?o={organization_id} for tenant context.