POST /invoices/{invoice-id}/void

Voids the specified invoice.

Use this operation when:

Voiding preserves the audit trail and allows for future reference and compliance without removing the original record.

If the invoice is for the current term of a subscription, you can regenerate it using the Regenerate an invoice API.
If the invoice is not for the current term of a subscription, you can import it using the Import an invoice API or the UI bulk import action.

The invoice status must be payment_due, posted, or not_paid.
The invoice must not have any linked_payments with txn_status set to success or in_progress.
The amount_adjusted on the invoice must be zero.
The invoice must not have any applied_credits with cn_status set to refunded or refund_due.
The invoice must not have any issued_credit_notes with cn_status set to refunded or refund_due.
The invoice must not have any linked_taxes_withheld.

Invoices

Subscription

If the invoice is for the current term of a subscription and you change the subscription later within the same term with proration enabled, Chargebee does not issue prorated credits.

Customer

Chargebee adds back any promotional credits that were applied to the invoice to customer.balances.promotional_credits.

Credit Note

If the Void invoices with credit note setting is enabled, Chargebee creates a credit note for the voided invoice:
- The credit note type is adjustment.
- The credit note status is adjusted.
- The credit note create_reason_code is Invoice Void.

Usages

Chargebee delinks the usage resources associated with the invoice by clearing the invoice_id attribute.

Integrations

Before calling this API, ensure the following:

The invoice status is payment_due, posted, or not_paid.
Remove any linked_payments with txn_status set to success or in_progress.
Remove the following credits:
- any applied_credits with cn_status set to refunded or refund_due
- any issued_credit_notes with cn_status set to refunded or refund_due
- any adjustment_credit_notes with cn_status set to adjusted
Remove any linked_taxes_withheld.

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 .
`void_reason_code`	String	No	Reason code for voiding the invoice. Select from a list of reason codes set in the Chargebee app in Settings > Configure Chargebee > Reason Codes > Invoices > Void invoice. Must be passed if set as mandatory in the app. The codes are case-sensitive.

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.