Create a credit note
POST / v1 / credit_notes
Issue a credit note to adjust the amount of a finalized invoice. A credit note will first reduce the invoice’s amount_remaining (and amount_due), but not below zero. This amount is indicated by the credit note’s pre_payment_amount. The excess amount is indicated by post_payment_amount, and it can result in any combination of the following:
- Refunds: create a new refund (using refund _ amount ) or link existing refunds (using refunds ).
- Customer balance credit: credit the customer’s balance (using credit _ amount ) which will be automatically applied to their next invoice when it’s finalized.
- Outside of Stripe credit: record the amount that is or will be credited outside of Stripe (using out _ of _ band _ amount ).
The sum of refunds, customer balance credits, and outside of Stripe credits must equal the post_payment_amount.
You may issue multiple credit notes for an invoice. Each credit note may increment the invoice’s pre_payment_credit_notes_amount, post_payment_credit_notes_amount, or both, depending on the invoice’s amount_remaining at the time of credit note creation.
For invoices that also have refunds created through the Refund API, the credit note API subtracts those refund amounts from the maximum creditable amount. This prevents the combined credit notes and refunds from exceeding the invoice amount. If you use both, ensure the combined total does not exceed the invoice’s paid amount.
Parameters
- invoice string Required ID of the invoice.
- lines array of objects Required conditionally Line items that make up the credit note. One of
amount,lines, orshipping_costmust be provided. - memo string The credit note’s memo appears on the credit note PDF.
- metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata. - reason enum Reason for issuing this credit note, one of
duplicate,fraudulent,order_change, orproduct_unsatisfactoryPossible enum valuesduplicateCredit issued for a duplicate payment or chargefraudulentCredit note issued for fraudulent activityorder_changeCredit note issued for order changeproduct_unsatisfactoryCredit note issued for unsatisfactory product
More parameters
- amount integer Required conditionally
- credit _ amount integer
- effective _ at timestamp
- email _ type enum
- out _ of _ band _ amount integer
- refund _ amount integer
- refunds array of objects
- shipping _ cost object Required conditionally
Returns
Returns a credit note object if the call succeeded.
Response
Update a credit note
POST / v1 / credit_notes /:id
Updates an existing credit note.
Parameters
- memo string Credit note memo.
- metadata map Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to
metadata.
Returns
Returns the updated credit note object if the call succeeded.
Response
Retrieve a credit note
GET / v1 / credit_notes /:id
Retrieves the credit note object with the given identifier.
Parameters
No parameters.
Returns
Returns a credit note object if a valid identifier was provided.
Response