Remove Tax Withheld Refunds From A Credit Note

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

skip all actions to be done on the events

One ofall-disabled

skip only emails

One ofall-disabled

skip only webhooks

One ofall-disabled

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.

Parameters for tax_withheld

<p class="mb-2">An auto-generated unique identifier for the tax withheld. The value starts with the prefix <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">tax_wh_</code>. For example, <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">tax_wh_16BdDXSlbu4uV1Ee6</code> .</p>

<div class="api-description"><p class="mb-2">A <a href="https://www.chargebee.com/docs/credit-notes.html" target="_blank">Credit Note</a> is a document that specifies the money owed by a business to its customer. The seller usually issues a Credit Note for the same or lower amount than the invoice, and then repays the money to the customer or set it off against other &#x27;due&#x27; invoices.</p><h3>Credit Note Types</h3><p class="mb-2">Credit notes in Chargebee are categorized into three types: 1. <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">adjustment</code>: Adjustment credit notes are used to adjust the amount of an existing invoice in the <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">payment_due</code> or <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">not_paid</code> <a href="/docs/api/invoices/invoice-object#status">status</a>. Use this type of credit note to reduce the invoice amount, typically as a discount to the customer. Adjustment credit notes are automatically created in the following cases:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">When an invoice is written off.</li> <li class="text-base leading-relaxed">When a subscription is modified with proration enabled, and the invoice for the current term is in the <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">payment_due</code> or <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">not_paid</code> <a href="/docs/api/invoices/invoice-object#status">status</a>. 2. <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">refundable</code>: Refundable credit notes allow you to return a certain amount to the customer. These credits can be:</li> <li class="text-base leading-relaxed">Retained for automatic application on future invoices.</li> <li class="text-base leading-relaxed">Applied to existing unpaid invoices.</li> <li class="text-base leading-relaxed">Refunded to the customer. Refundable credit notes are automatically created in the following cases:</li> <li class="text-base leading-relaxed">When an invoice is refunded.</li> <li class="text-base leading-relaxed">When a subscription is changed or canceled with proration enabled, the invoice for the current term is in the <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">paid</code> <a href="/docs/api/invoices/invoice-object#status">status</a>. Refundable credits are applied to future invoices or can be refunded to the original payment method. 3. <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">store</code>: Store credit notes are created for <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">paid</code> or <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">partially_paid</code> invoice <a href="/docs/api/invoices/invoice-object#status">status</a> during subscription changes, such as upgrades, downgrades, or cancellations. Key characteristics of store credits:</li> <li class="text-base leading-relaxed">No tax component is included at the time of creation.</li> <li class="text-base leading-relaxed">A credit note document is generated, similar to refundable credits.</li> <li class="text-base leading-relaxed">Store credits are applied before tax calculations on future invoices.</li> </ul><div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong> If you have enabled <em class="italic">consolidated invoicing</em> , to know the subscriptions attached with a credit note you have to refer <a href="/docs/api/credit_notes/credit_note-object#line_items">line_item&#x27;s</a> <em class="italic">subscription_id</em> . The credit note&#x27;s <em class="italic">subscription_id</em> should <strong class="font-semibold">not</strong> be used (which will be <em class="italic">null</em> if the credit note has lines from multiple subscriptions).</p></div><div id="ref-invoice-impact" class="cb-accordion"><div class="cb-accordion-title collapsed" data-toggle="collapse" data-target="#ref-invoice-impact-content" aria-expanded="false" aria-controls="ref-invoice-impact-content"><p class="mb-2">Impact on reference invoice</p><i class="fa fa-chevron-circle-down fa-lg" aria-hidden="true"></i></div><div class="collapse" id="ref-invoice-impact-content"><p class="mb-2">The following updates are made to the reference invoice when a credit note is created/imported:</p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">If the credit note <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">type</code> is <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">adjustment</code>: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The adjustment credit note details are added to the <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">adjustment_credit_notes[]</code> attribute of the invoice.</li> <li class="text-base leading-relaxed">The invoice <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">amount_due</code> is reduced by the credit note <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">total</code>.</li> <li class="text-base leading-relaxed">The invoice <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">status</code> is updated to <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">paid</code> if the invoice <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">amount_due</code> equals the credit note <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">total</code>.</li> <li class="text-base leading-relaxed">The invoice <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">status</code> does not change if the invoice <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">amount_due</code> is greater than credit note <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">total</code>.</li> </ul> </li> <li class="text-base leading-relaxed">If the credit note <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">type</code> is <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">refundable</code>: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The refundable credit note details are added to the <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">issued_credit_notes[]</code> attribute of the invoice.</li> <li class="text-base leading-relaxed">The invoice <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">status</code> does not change.</li> </ul> </li> <li class="text-base leading-relaxed">If the credit note <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">type</code> is <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">store</code>: <ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">The store credit note details are added to the <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">issued_credit_notes[]</code> attribute of the invoice.</li> <li class="text-base leading-relaxed">The invoice <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">status</code> does not change.</li> </ul> </li> </ul></div></div></div>

Credit-note id.

The identifier of the customer this credit note belongs to.

The identifier of the subscription this Credit Note belongs to. **Note:** If *consolidated invoicing* is enabled, to know the subscriptions attached with this Credit Note you have to refer [line_item's](/docs/api/credit_notes/credit_note-object#line_items) *subscription_id* . This attribute should **not** be used (which will be *null* if this credit note has lines from multiple subscriptions).

The identifier of the invoice against which this Credit Note is issued

The credit note type. [Learn more](/docs/api/credit_notes/credit-note-object) about credit note types. \* store - Store Credit Note \* refundable - Refundable Credit Note \* adjustment - Adjustment Credit Note

One ofadjustmentrefundablestore

The reason for issuing this credit note. The following reason codes are supported now\[Deprecated; use the [create_reason_code](/docs/api/credit_notes/credit_note-object#create_reason_code) parameter instead\] \* subscription_change - This reason will be set automatically for Credit Notes created during Change Subscription operation when [proration](https://www.chargebee.com/docs/proration.html) is enabled \* order_change - Order Change \* other - Can be set when none of the above reason codes are applicable \* fraudulent - FRAUDULENT \* chargeback - Can be set when you are recording your customer Chargebacks \* subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation. \* waiver - Waiver \* subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation \* product_unsatisfactory - Product Unsatisfactory \* order_cancellation - Order Cancellation \* write_off - This reason will be set automatically for the Credit Notes created during invoice [Write Off](https://www.chargebee.com/docs/invoice-operations.html#write-off) operation. \* service_unsatisfactory - Service Unsatisfactory

One ofwrite_offsubscription_changesubscription_cancellationsubscription_pausechargebackproduct_unsatisfactoryservice_unsatisfactoryorder_changeorder_cancellationwaiverotherfraudulent

The credit note status. \* voided - When the Credit Note has been cancelled. \* refund_due - When the credits are yet to be used, or have been partially used. \* refunded - When the entire credits (Credit Note amount) have been used (i.e either allocated to invoices or refunded). \* adjusted - When the Credit Note has been adjusted against an invoice.

One ofadjustedrefundedrefund_duevoided

VAT number of the customer for whom this credit note is raised.

The date the credit note is issued.

The price type of the credit note. \* tax_inclusive - All amounts in the document are inclusive of tax. \* tax_exclusive - All amounts in the document are exclusive of tax.

One oftax_exclusivetax_inclusiveDefault "tax_exclusive"

The currency code (ISO 4217 format) for the credit note

Credit Note amount in cents.

Default 0

The amount allocated to invoices from the credit note.

Default 0

The refunds issued from this credit note.

Default 0

The yet to be used credits of this credit note.

Default 0

The time this credit note gets fully used. Please note that this field is not present when partial refunds are issued.

Timestamp indicating the date and time this credit note gets voided.

The date/time when the credit note was raised. This date/time can be backdated, which means that the date/time can be earlier than the date/time the credit note was created.

<p class="mb-2">Version number of this resource. The <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">resource_version</code> is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>

Timestamp indicating when this credit note was last updated. This attribute will be present only if the resource has been updated after 2016-09-28.

The subscription channel this object originated from and is maintained in. \* play_store - The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions) created in Google Play Store. Direct manipulation of this object via UI or API is disallowed. In-App Subscriptions is currently in early access. Contact [eap@chargebee.com](mailto:eap@chargebee.com) for more information. \* web - The object was created (and is maintained) for the web channel directly in Chargebee via API or UI. \* app_store - The object data is synchronized with data from [in-app subscription(s)](/docs/api/in_app_subscriptions) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed.

One ofwebapp_storeplay_store

<p class="mb-2">This attribute is returned only if additional resources are available. Use this value as the input parameter for <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">line_items_offset</code> to retrieve the next set of resources.</p> <div class="alert alert-info"><p class="mb-2"><strong class="font-semibold">Note:</strong></p><ul class="list-disc list-outside ml-6 my-4 space-y-2"> <li class="text-base leading-relaxed">Applicable only when Enterprise-scale Invoicing is enabled.</li> <li class="text-base leading-relaxed">Enterprise-scale Invoicing is currently in <strong class="font-semibold">Private Beta</strong>. Please reach out to <a href="https://www.chargebee.com/docs/billing/2.0/kb/getting-started/how-to-contact-chargebees-support-team?utm_source=docs_api&amp;utm_medium=content&amp;utm_campaign=support" target="_blank" rel="noopener noreferrer" class="text-blue-600 hover:text-blue-800 underline">Chargebee Support</a> to enable this feature.</li> </ul></div>

The Credit Note sub-total

Invoice subtotal in the currency of the place of supply.

Total invoice amount in the currency of the place of supply.

The currency code (ISO 4217 format) of the place of supply in which VAT needs to be converted and displayed.

<p class="mb-2">Indicates the rounded-off amount. For example, if your invoice amount is $99.99, and the amount is rounded off to $100.00, in this case, $100.00 is your invoice amount, $0.01 is the <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">round_off_amount</code>. If there is no <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">round-off amount</code> , it will display <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">0</code> .</p>

Indicates the fractional correction amount.

The list of notes attached to this credit note. Each note is displayed on customer-facing documents such as the [Credit Note PDF](/docs/api/credit_notes#retrieve_credit_note_as_pdf). Currently this list contains the note configured for the customer; additional note types may be added in future.

Indicates that this resource has been deleted.

Specifies the customer's category for the Goods and Services Tax (GST). This field is returned only if you've configured GST for the India region.

This parameter represents the exchange rate as a relative price of the base currency that appears as local currency in invoices and credit notes. The local currency exchange rate specifically refers to the exchange rate of a country's currency when converting it to another currency. For example, if you want to convert US dollars to euros, the local currency exchange rate would be the rate at which you can convert US dollars to euros.

Reason code for creating the credit note. Must be one from a list of reason codes set in the Chargebee app in **Settings \> Configure Chargebee \> Reason Codes \> Credit Notes \> Create Credit Note**. Must be passed if set as mandatory in the app. The codes are case-sensitive

<p class="mb-2">An overridden value for the first two characters of the <a href="https://en.wikipedia.org/wiki/VAT_identification_number" target="_blank">full VAT number</a>. Only applicable specifically for customers with <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p> <p class="mb-2"><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">country</code> as <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">XI</code> (which is <strong class="font-semibold">United Kingdom - Northern Ireland</strong> ).</p> <p class="mb-2">When you have enabled <a href="https://www.chargebee.com/docs/eu-vat.html" target="_blank">EU VAT</a> in 2021 or have <a href="https://www.chargebee.com/docs/brexit.html#what-needs-to-be-done-in-chargebee" target="_blank">manually enabled</a> the Brexit configuration, you have the option of setting <code><a href="/docs/api/customers/customer-object#billing_address">billing_address</a></code></p> <p class="mb-2"><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">country</code> as <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">XI</code>. That&#x27;s the code for <strong class="font-semibold">United Kingdom - Northern Ireland</strong>. The first two characters of the VAT number in such a case is <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">XI</code> by default. However, if the VAT number was registered in UK, the value should be <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">GB</code>. 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">vat_number_prefix</code> to <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">GB</code> for such cases.</p>

<p class="mb-2">The unique ID of the <a href="/docs/api/advanced-features">business entity</a> of this credit_note. This is always the same as the business entity of the invoice referred to by <code><a href="/docs/api/credit_notes/credit_note-object#reference_invoice_id">reference_invoice_id</a></code>.</p> <span featureId="cb-mbe" isMicro="true"></span>

The line items of this credit note

The list of tiers applicable for this line item

The list of discount(s) applied for each line item of this credit note.

The list of taxes applied on line items

The list of addresses used for tax calculation on line items.