Skip to content

Get an employer invoice's PDF download link

GET/v1/employers/{employer_id}/invoices/{invoice_id}/pdf

Returns the time-limited PDF download link for a single invoice belonging to the employer’s billing customer. invoice_id is the external Chargebee id (not a prefixed UUID). The caller must be authorized for the employer; an unknown or unauthorized employer or invoice returns 404.

Path ParametersExpand Collapse
employer_id: string

Unique employer identifier (empr_*)

invoice_id: string

External Chargebee invoice id (not a prefixed UUID).

ReturnsExpand Collapse
data: { download_url }
download_url: string

Time-limited Chargebee PDF download link for the invoice.

Get an employer invoice's PDF download link

curl https://api.vitablehealth.com/v1/employers/$EMPLOYER_ID/invoices/$INVOICE_ID/pdf \
    -H "Authorization: Bearer $VITABLE_CONNECT_API_KEY"
{
  "data": {
    "download_url": "https://chargebee.example/invoices/INV-00042.pdf"
  }
}
Returns Examples
{
  "data": {
    "download_url": "https://chargebee.example/invoices/INV-00042.pdf"
  }
}