Zum Hauptinhalt springen
Create, send, and manage invoices through the admin API. For general conventions, see JSON-API Conventions. For authentication, see Authentication.

Prerequisites

  • Bearer token with admin access + ?o={organization_id}

Invoice Actions

Cancel an Invoice

Creates a credit note and voids the invoice.

Mark as Paid

Mark a SENT invoice as paid without processing a payment:
Set 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:
Omit 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:
At most one reminder per invoice in 24 hours. It is refused while a payment is pending (for example a SEPA debit that has not settled) and when the customer has no real email address. Both actions share a rate limit of 60 requests per hour per user.

Creating an Invoice

All examples below assume BASE_URL = https://{your-domain}/api/v1.
1

Find a Customer by Email

The 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.
For checkbox fields, pass true / false as the value. For multi-select fields, the in operator accepts comma-separated values.
2

Create a Customer (if not found)

Required: email, localeCreate the customer’s address as a separate resource:
3

Create the Invoice (draft)

Customer linking

When the invoice is sent, the backend snapshots recipient and buyer_data from the customer so the invoice stays valid even if the profile changes later.

Attributes

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

Transitions status to sent and delivers via the configured notification channel.
6

Mark as Paid (optional)


Full Workflow Summary

All endpoints include ?o={organization_id} for tenant context.

Common Errors