Create a credit note
POST {{baseUrl}}/v1/credit_notes
Issue a credit note to adjust the amount of a finalized invoice. For a status=open
invoice, a credit note reduces
its amount_due
. For a status=paid
invoice, a credit note does not affect its amount_due
. Instead, it can result
in any combination of the following:
- Refund: create a new refund (using
refund_amount
) or link an existing refund (usingrefund
). - 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
).
For post-payment credit notes the sum of the refund, credit and outside of Stripe amounts must equal the credit note total.
You may issue multiple credit notes for an invoice. Each credit note will increment the invoice’s pre_payment_credit_notes_amount
or post_payment_credit_notes_amount
depending on its status
at the time of credit note creation.
Request Body
[{"name"=>"invoice", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"credit_amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"effective_at", "value"=>"<unix-time>", "datatype"=>"string"}, {"name"=>"expand[0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"expand[1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[0][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[0][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[0][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[0][invoice_line_item]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[0][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[0][tax_amounts][0][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[0][tax_amounts][0][tax_rate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[0][tax_amounts][0][taxable_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[0][tax_amounts][1][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[0][tax_amounts][1][tax_rate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[0][tax_amounts][1][taxable_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[0][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[0][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[0][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[0][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"lines[1][type]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[1][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[1][description]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[1][invoice_line_item]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[1][quantity]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[1][tax_amounts][0][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[1][tax_amounts][0][tax_rate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[1][tax_amounts][0][taxable_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[1][tax_amounts][1][amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[1][tax_amounts][1][tax_rate]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[1][tax_amounts][1][taxable_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[1][tax_rates][0]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[1][tax_rates][1]", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"lines[1][unit_amount]", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"lines[1][unit_amount_decimal]", "value"=>"<decimal>", "datatype"=>"string"}, {"name"=>"memo", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"out_of_band_amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"reason", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"refund", "value"=>"<string>", "datatype"=>"string"}, {"name"=>"refund_amount", "value"=>"<integer>", "datatype"=>"string"}, {"name"=>"shipping_cost[shipping_rate]", "value"=>"<string>", "datatype"=>"string"}]
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |