Skip to main content

Get Invoice PDF Report by SID

This request returns data for a particular invoice in PDF format. If the request succeeds, there will be a download link.

get /billing/invoices/{invoice_sid}.pdf

Sample

A sample GET request to get an invoice, targeted by secure ID, in PDF format:

curl -X GET \
'https://api.carrierx.com/core/v2/billing/invoices/6765ca8a-91c7-4241-98c6-42803de77e74.pdf' \
-H 'Authorization: Bearer 5ebc03d6-8b2b-44ad-bf65-72d4f1491dda'

Response

200 status code with the invoice in PDF format.

Required Scopes

To get an invoice in PDF format 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.