Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
POST /v1/invoices//send finalizes a draft if needed and emails the customer the hosted pay link.
POST /v1/invoices/{invoiceId}/send
invoices:write · Idempotency-Key: optional
Finalizes a draft (which turns its link on), then emails the pay link. You can send an open invoice again as a reminder. Each send fires an invoice.sent event.
curl -X POST https://api.stg.cleo-pay.com/v1/invoices/d7e8f9a0-b1c2-4d3e-8f4a-5b6c7d8e9f0a/send \
--header "Authorization: Bearer $CLEO_API_KEY" \
--header "Content-Type: application/json" \
--data '{ "emails": ["ap@northwind.example"] }'
200 with the invoice. The email does not attach a PDF; the hosted page offers it.
| Code | When |
|---|---|
validation_error | The invoice cannot be sent in its status (for example paid or void), finalizing left it blocked, or the customer has no email and you sent no emails. |
payments_locked, setup_incomplete, setup_required, feature_unavailable | The business cannot receive yet. |