POST /invoices/{invoice-id}/apply_credits

Applies a customer's refundable credits to a specified invoice.

You can either specify the credit notes to be applied, or let Chargebee apply the available credit notes automatically.

Invoice

The amount_due decreases by the amount of credits applied.
The invoice status:
- changes to paid if the applied credits fully cover the amount due.
- remains unchanged if the applied credits only partially cover the amount due.

Credit Notes

The credit note status:

changes to refunded if the entire credit_note.amount_available is applied to the invoice.
remains refund_due if only part of the credit_note.amount_available is applied.

Before calling this API, make sure the following conditions are met:

Servers

Name	Type	Required	Description
`invoice-id`	String	Yes

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 Valid 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 Valid 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 Valid values: `"all-disabled"`

Name	Type	Required	Description
`comment`	String	No	An internal comment to be added for this operation, to the invoice. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing Hosted Page or any document such as the Invoice PDF .
`credit_notes`	Object	No	Parameters for credit_notes
`credit_notes.id[]`	Array	No	The ID of the credit note to be applied to the invoice. Constraints `credit_note.type` must be `refundable`. The `credit_note.customer_id` must always be the same as `invoice.customer_id` even if `invoice.payment_owner` is different. Default behavior When the parameter is not passed, available refundable credits with the customer are applied to the invoice.

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.