Create credit note
Use when issuing a refund or adjustment (e.g. customer dispute or proration). Links to an invoice; create as draft then finalize.
Request body
credit_note_number is an optional human-readable identifier for the credit note
idempotency_key is an optional key used to prevent duplicate credit note creation
invoice_id is the unique identifier of the invoice this credit note is applied to
memo is an optional free-text field for additional notes about the credit note
process_credit_note is a flag to process the credit note after creation
Response
Created
credit_note_number is the unique identifier for credit notes
currency is the three-letter ISO currency code (e.g., USD, EUR) for the credit note
customer_id is the unique identifier of the customer who owns this credit note
environment_id is the unique identifier of the environment this credit note belongs to
finalized_at is the timestamp when the credit note was finalized
id is the unique identifier for the credit note
idempotency_key is an optional key used to prevent duplicate credit note creation
invoice_id is the id of the invoice resource that this credit note is applied to
memo is an optional memo supplied on the credit note
subscription_id is the optional unique identifier of the subscription related to this credit note
total_amount is the total including creditable invoice-level discounts or minimums, and tax
voided_at is the timestamp when the credit note was voided