POST /orders/{order-id}/create_refundable_credit_note

This API is used to create a refundable credit note for the order

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Path parameters

Name	Type	Required	Description
`order-id`	String	Yes

Request headers

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

Request body fields

Name	Type	Required	Description
`comment`	String	No	Comment, if any, on the refund.
`credit_note`	Object	No	Parameters for credit_note
`credit_note.reason_code`	String	Yes	The reason for issuing this Credit Note. The following reason codes are supported now[Deprecated; use the create_reason_code parameter instead] * product_unsatisfactory - Product Unsatisfactory * chargeback - Can be set when you are recording your customer Chargebacks * service_unsatisfactory - Service Unsatisfactory * 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 * fraudulent - FRAUDULENT * other - Can be set when none of the above reason codes are applicable * subscription_pause - This reason will be automatically set to credit notes created during pause/resume subscription operation. * waiver - Waiver * order_cancellation - Order Cancellation * order_change - Order Change * subscription_cancellation - This reason will be set automatically for Credit Notes created during cancel subscription operation Possible values: `"service_unsatisfactory"` `"chargeback"` `"other"` `"write_off"` `"product_unsatisfactory"` `"fraudulent"` `"subscription_change"` `"subscription_cancellation"` `"order_change"` `"subscription_pause"` `"order_cancellation"` `"waiver"`
`credit_note.total`	Integer	Yes	Credit Note amount in cents. Default value: 0
`customer_notes`	String	No	The Customer Notes to be filled in the Credit Notes created to capture this refund detail.

How to start integrating

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.