List Vouchers For An Invoice

The number of resources to be returned.

Default 10

<p class="mb-2">Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code> to the value of <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">next_offset</code> obtained in the previous iteration of the API call.</p>

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_not\] = "active, consumed, expired"*

\* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection

One ofactiveconsumedexpiredfailure

\* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection

One ofactiveconsumedexpiredfailure

\* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection

One ofactiveconsumedexpiredfailure

\* \`active\` - Active and ready to be consumed \* \`consumed\` - Consumed for a transaction and cannot be used again \* \`expired\` - Expired before consumed and cannot be used again \* \`failure\` - Failed to create the voucher due to gateway rejection

One ofactiveconsumedexpiredfailure

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.

One ofdateupdated_at

One ofdateupdated_at

The device from which the customer has made the request

The email address of your customer/user. Use this when the email address has only ASCII characters.

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.

The IP address of the customer where the request originated

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.

The Payment Voucher resource represents a voucher that has been created for a customer to initiate voucher-based payment. This resource contains relevant details such as the voucher URL, the amount of the voucher, the status of the voucher, and more. Currently, the only supported voucher-based payment source is Boleto. Boleto is a payment method in Brazil that is regulated by the Central Bank of Brazil and is considered an official form of payment. This is also a popular voucher-based payment method in Brazil. **Note:** This resource can be extended in the future to support other types of payment sources for vouchers.

<p class="mb-2">This attribute is returned only if more resources are present. To fetch the next set of resources use this value for the input parameter <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">offset</code>.</p>