Sends the invoice to the customer's e-mail and other CC e-mails provided in the request.
Sends an existing invoice to a customer's email address. The invoice can also be sent to additional recipients using the CC feature. This endpoint is used to notify customers about charges or to remind them of pending invoices.
Key Features
- Sends an invoice to the customer's primary email.
- Allows inclusion of additional email recipients using CC.
- Can be called immediately after creating or updating an invoice.
- Updates the invoice's status to SENT and records the timestamp in the
sent_atfield.
Usage Notes
Invoice Requirements
The invoice must exist in the system and be linked to a valid id.
The invoice must not be marked as deleted (deleted_at must be null).
CC Recipients
Use the ccEmails field in the request body to send the invoice to additional email addresses.
Example:
{
"ccEmails": ["[email protected]", "[email protected]"]
}Resending Invoices
Invoices can be sent multiple times as reminders. Each resend will update the sent_at timestamp.
Email Content
The email includes the invoice details and a payment link (if applicable) for the customer to review and pay the invoice.
Response Structure
| Code | Response | Reason |
|---|---|---|
| 200 | Success | The invoice was successfully sent via email. |
| 400 | Bad Request | Invalid or missing invoice ID or email details. |
| 401 | Unauthorized | Authentication failed. |
| 404 | Not Found | An invoice with the specified ID does not exist. |
| 500 | Internal Server Error | Unexpected server error. |
Important Considerations
- Email Validity: Ensure the customer's email address is valid to avoid delivery issues.
- Draft Invoices: Invoices must be finalized before sending. Draft invoices (
status=DRAFT) cannot be sent. - Customer Access: The email will include a direct link to view and pay the invoice if applicable. Ensure hosted invoice page settings are properly configured.
- Audit Trail: Each send request is logged, and the
sent_atfield is updated to track when the invoice was sent.