POST /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"

An internal comment to be added for this operation, to the credit note. This comment is displayed on the Chargebee UI. It is not displayed on any customer-facing Hosted Page or any document such as the Credit Note PDF.

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

Parameters for line_items

Unit amount of the line item. Required for FLAT_FEE, PER_UNIT and VOLUME pricing model.

Start date of this line item.

Description for the line item.

End date of this line item.

Amount of the line item. Applicable only for STAIRSTEP, TIERED pricing_model.

Quantity of the line item. Required for PER_UNIT and VOLUME pricing model.

The decimal representation of the quantity of the line_item. Applicable for the line_item when the pricing_model is per_unit and volume. Can be provided only when multi-decimal pricing is enabled.

Uniquely identifies a line_item

The decimal representation of the unit amount of the line_item. The value is in major units of the currency. Applicable for the line_item when the pricing_model is flat_fee, per_unit or volume. Can be provided only when multi-decimal pricing is enabled.

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

Possible values:

• "service_unsatisfactory"
• "other"
• "product_unsatisfactory"
• "order_change"
• "order_cancellation"
• "waiver"

The credit note type. Learn more about credit note types. * refundable - Refundable Credit Note * store - Store Credit Note * adjustment - Adjustment Credit Note

Possible values:

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

A note to be added for this operation, to the credit note. This note is displayed on customer-facing documents such as the Credit Note PDF.

The date the Credit Note is issued.

Credit Note amount in cents. You can either pass the total parameter or the line_items parameter. Passing both will result in an error.

Default value: 0

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.