GET /customers/{customer-id}/payment_vouchers

Retrieves vouchers for a customer in reverse chronological order.

Servers

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

Path parameters

Name	Type	Required	Description
`customer-id`	String	Yes

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`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-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.

Query parameters

Name	Type	Required	Description
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`status`	Object	No	optional, enumerated string filter Current status of Payment Voucher. Possible values are : active, consumed, expired, failure. Supported operators : is, is_not, in, not_in, in, not_in Example → status[is] = "active, consumed, expired"
`sort_by`	Object	No	optional, string filter Sorts based on the specified attribute. Supported attributes : date, updated_at Supported sort-orders : asc, desc Example → sort_by[asc] = "date" This will sort the result based on the 'date' attribute in ascending(earliest first) order.
`offset`	String	No	Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.

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.