Send invoice emails
Send a specific email (email_type) to the customer for a list of invoices, asynchronously in batch. An invoice whose status doesn’t resolve to the requested email is skipped. Results can be tracked via webhooks with the invoice.batch.email_succeeded, invoice.batch.email_skipped and invoice.batch.email_failed events.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Send invoice emails payload
The email to send. The invoice's status must resolve to this email, otherwise it is skipped with reason email_type_mismatch.
invoice_ready: The to-pay invoice email (forto_pay,partially_paid,lateinvoices).invoice_settled: The paid-invoice email (forpaidinvoices).invoice_errored: The failed-payment email (forerrorinvoices with a payment method).credit_note_settled: The credit-note email (for paid refunds).
invoice_ready, invoice_settled, invoice_errored, credit_note_settled "invoice_ready"
IDs of the invoices to send the email for. Processed asynchronously; each outcome is reported via webhook events.
1 - 10000 elementsOptional client-supplied identifier for the batch. Echoed back in the response and on the emitted webhook events. Generated if omitted.
"batch_1eTaiytfA0i2Va"
Response
Identifier of the batch request. Use it to correlate the invoice.batch.email_succeeded, invoice.batch.email_skipped and invoice.batch.email_failed webhook events.
"batch_1eTaiytfA0i2Va"

