POST /exports/credit_notes

The device from which the customer has made the request

Default value: "application/x-www-form-urlencoded"

skip only webhooks

Possible values:

• "all-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.

skip all actions to be done on the events

Possible values:

• "all-disabled"

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

The IP address of the customer where the request originated

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.

skip only emails

Possible values:

• "all-disabled"

Parameters for credit_note

The yet to be used credits of this Credit Note.

The refunds issued from this Credit Note.

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

Possible values:

• "false"
• "true"

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_create_reason_code) parameter instead\]

* `write_off` - This reason will be set automatically for the Credit Notes created during invoice Write Off operation. * `subscription_change` - This reason will be set automatically for Credit Notes created during Change Subscription operation when proration is enabled * `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation * `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation. * `chargeback` - Can be set when you are recording your customer Chargebacks * `product_unsatisfactory` - Product Unsatisfactory * `service_unsatisfactory` - Service Unsatisfactory * `order_change` - Order Change * `order_cancellation` - Order Cancellation * `waiver` - Waiver * `other` - Can be set when none of the above reason codes are applicable * `fraudulent` - FRAUDULENT

Possible values:

• "service_unsatisfactory"
• "chargeback"
• "other"
• "write_off"
• "product_unsatisfactory"
• "fraudulent"
• "subscription_change"
• "subscription_cancellation"
• "order_change"
• "subscription_pause"
• "order_cancellation"
• "waiver"

* `write_off` - This reason will be set automatically for the Credit Notes created during invoice Write Off operation. * `subscription_change` - This reason will be set automatically for Credit Notes created during Change Subscription operation when proration is enabled * `subscription_cancellation` - This reason will be set automatically for Credit Notes created during cancel subscription operation * `subscription_pause` - This reason will be automatically set to credit notes created during pause/resume subscription operation. * `chargeback` - Can be set when you are recording your customer Chargebacks * `product_unsatisfactory` - Product Unsatisfactory * `service_unsatisfactory` - Service Unsatisfactory * `order_change` - Order Change * `order_cancellation` - Order Cancellation * `waiver` - Waiver * `other` - Can be set when none of the above reason codes are applicable * `fraudulent` - FRAUDULENT

Possible values:

• "service_unsatisfactory"
• "chargeback"
• "other"
• "write_off"
• "product_unsatisfactory"
• "fraudulent"
• "subscription_change"
• "subscription_cancellation"
• "order_change"
• "subscription_pause"
• "order_cancellation"
• "waiver"

The credit note status.

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

Possible values:

• "refund_due"
• "adjusted"
• "refunded"
• "voided"

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

Possible values:

• "refund_due"
• "adjusted"
• "refunded"
• "voided"

Timestamp indicating the date and time this Credit Note gets voided.

The price type of the Credit Note.

* `tax_exclusive` - All amounts in the document are exclusive of tax. * `tax_inclusive` - All amounts in the document are inclusive of tax.

Possible values:

• "tax_exclusive"
• "tax_inclusive"

* `tax_exclusive` - All amounts in the document are exclusive of tax. * `tax_inclusive` - All amounts in the document are inclusive of tax.

Possible values:

• "tax_exclusive"
• "tax_inclusive"

The date the Credit Note is issued.

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

Credit Note amount in cents.

To filter based on updated at. This attribute will be present only if the resource has been updated after 2016-09-28.

Credit-note id.

The identifier of the customer this Credit Note belongs to.

The subscription channel this object originated from and is maintained in.

* `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) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) 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 for more information.

Possible values:

• "web"
• "play_store"
• "app_store"

* `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) created in Apple App Store. Direct manipulation of this object via UI or API is disallowed. * `play_store` - The object data is synchronized with data from in-app subscription(s) 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 for more information.

Possible values:

• "web"
• "play_store"
• "app_store"

The amount allocated to the invoices.

The credit note type. [Learn more](credit_notes?lang=curl#credit_note_types) about credit note types.

* `adjustment` - Adjustment Credit Note * `refundable` - Refundable Credit Note * `store` - Store Credit Note

Possible values:

• "refundable"
• "store"
• "adjustment"

* `adjustment` - Adjustment Credit Note * `refundable` - Refundable Credit Note * `store` - Store Credit Note

Possible values:

• "refundable"
• "store"
• "adjustment"

To filter based on subscription_id. NOTE: Not to be used if *consolidated invoicing* feature is enabled.

Possible values:

• "false"
• "true"