Sends an invoice to the customer via email. This endpoint supports the delivery of both ad-hoc and automatically generated invoices. Additionally, this endpoint supports email delivery to direct recipients, carbon-copy (cc) recipients, and blind carbon-copy (bcc) recipients.
File Attachments: You can attach files to invoice emails using attachment_urls[] parameter by providing URLs to the files you want to attach. When using attachments, the request must use multipart/form-data content type. Max 10 files, 10MB per file.
If no recipient email addresses are specified in the request, then the subscription's default email configuration will be used. For example, if recipient_emails is left blank, then the invoice will be delivered to the subscription's customer email address.
On success, a 204 no-content response will be returned. The response does not indicate that email(s) have been delivered, but instead indicates that emails have been successfully queued for delivery. If any invalid or malformed email address is found in the request body, the entire request will be rejected and a 422 response will be returned.
The username is a Maxio Chargify API key and the password is x. Basic authentication works only with the US and EU environments, which connect to chargify.com directly. The Maxio API Gateway environment does not accept Basic authentication.
In: header
The unique identifier for the invoice, this does not refer to the public facing invoice number.
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
curl -X POST \ --url 'https://subdomain.chargify.com/invoices/uid/deliveries.json' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ --data-raw '{ "recipient_emails": [ "user0@example.com" ], "cc_recipient_emails": [ "user1@example.com" ], "bcc_recipient_emails": [ "user2@example.com" ]}'items <= 5items <= 5items <= 5Array of URLs to files to attach to the invoice email. Max 10 files, 10MB each.
items <= 10