Idempotency Supported
Updates the custom fields and comment of a credit note.
Use this operation to add or change custom field values, or to attach an internal comment, without modifying other credit note attributes. Pass at least one credit note custom field or comment; otherwise the credit note is returned unchanged.
Impacts
Credit note
- Updates any credit note custom fields included in the request. Existing custom field values that you omit from the request are left unchanged.
- Adds an internal comment when you pass
comment.
Sample Request
Sample Result[JSON]
URL Format
POST https://[site].chargebee.com/api/v2/credit_notes/{credit-note-id}/update
Input Parameters
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 .
Returns
Credit note object
Resource object representing credit_note