Update credit note
PUT
/v1/credit_notes/{credit_note_id}
Update a credit note (only allowed in draft status).
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” credit_note_id
required
Credit Note Id
string format: uuid
Request Body required
Section titled “Request Body required ” CreditNoteUpdate
object
reason
Any of:
CreditNoteReason
string
null
status
Any of:
CreditNoteStatus
string
null
credit_status
Any of:
CreditStatus
string
null
refund_status
Any of:
RefundStatus
string
null
Responses
Section titled “ Responses ”Successful Response
CreditNoteResponse
object
id
required
Id
string format: uuid
number
required
Number
string
invoice_id
required
Invoice Id
string format: uuid
customer_id
required
Customer Id
string format: uuid
credit_note_type
required
Credit Note Type
string
status
required
Status
string
reason
required
Reason
string
credit_amount_cents
required
Credit Amount Cents
string
refund_amount_cents
required
Refund Amount Cents
string
balance_amount_cents
required
Balance Amount Cents
string
total_amount_cents
required
Total Amount Cents
string
taxes_amount_cents
required
Taxes Amount Cents
string
currency
required
Currency
string
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Only draft credit notes can be updated
Unauthorized
Credit note not found
Validation error