Skip to main content

Send Invoice PDF Report by SID to Email Addresses

This request sends this particular invoice in the PDF format to the email addresses specified in the request.

post /billing/invoices/{invoice_sid}.pdf/emails

Sample

A sample POST request to send an invoice, targeted by secure ID, in the PDF format to the email addresses specified in the request:

curl -X POST \
'https://api.carrierx.com/core/v2/billing/invoices/6765ca8a-91c7-4241-98c6-42803de77e74.pdf/emails' \
-H 'Content-Type: application/x-www-form-urlencoded' \
--data-binary 'emails=john.doe%40mail.com' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

204 status code and sends the invoice in the PDF format to an email address.

Required Scopes

To send an invoice in the PDF format to an email address the partner must have one of the following scopes enabled:

  • invoices.manage
  • invoices.read

Path Arguments

ParameterData TypeDescription
invoice_sid requiredstringThe invoice secure ID.

Body Arguments

The body contains the list of the email addresses in the URL-encoded format this invoice must be sent to. If several email addresses are passed, they must be separated with commas also in the URL-encoded format.

tip

In the URL encoded addresses, the @ character is replaced with the %40 sequence of characters, the commas are replaced with %2C, etc.