Send invoice by email
Send invoice
Emails the invoice :id to one or more recipients. Use it to deliver the bill to the customer (and any extra addresses).
Authentication
Merchant API key in x-api-key. Requires scope Merchant.payment_link.update. Optionally scope with x-application-account-id.
Path parameters
id— invoice (payment request) id.
Body (application/json)
emails— non-empty array of valid email addresses to send the invoice to.
Returns a MutationResponseDto (success, message) indicating how many recipients the invoice was dispatched to.
Notas: Handler: billingInvoicesService.send. Each entry is validated as an email; the array must not be empty.
Authentication
x-api-keystring
API Key authentication via header
Path parameters
id
Id of the invoice (payment request).
Headers
x-application-account-id
Scope the request to a specific store / account instead of the one resolved from the API key. Aliases: the x-account-id header, or the application_account_id / account_id query parameter.
Request
This endpoint expects an object.
emails