POST /usages/pdf

Retrieves usages record for an invoice in PDF file format.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"
`chargebee-event-webhook`	String	No	skip only webhooks Possible values: `"all-disabled"`
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-event-actions`	String	No	skip all actions to be done on the events Possible values: `"all-disabled"`
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.
`chargebee-event-email`	String	No	skip only emails Possible values: `"all-disabled"`

Request body fields

Name Type Required Description

Name	Type	Required	Description
`disposition_type`	String	No	Determines the pdf should be rendered as inline or attachment in the browser. * attachment - PDF is rendered as attachment in the browser * inline - PDF is rendered as inline in the browser Possible values: `"attachment"` `"inline"` Default value: "attachment"
`invoice`	Object	No	Parameters for invoice
`invoice.id`	String	Yes	The invoice number. Acts as a identifier for invoice and typically generated sequentially.

disposition_type

String

Determines the pdf should be rendered as inline or attachment in the browser. * attachment - PDF is rendered as attachment in the browser * inline - PDF is rendered as inline in the browser

Possible values:

"attachment"
"inline"

Default value: "attachment"

invoice

Object

Parameters for invoice

invoice.id

String

Yes

The invoice number. Acts as a identifier for invoice and typically generated sequentially.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.