Preview a credit note

GET {{baseUrl}}/v1/credit_notes/preview?invoice=<string>

Get a preview of a credit note without creating it.

Request Params

Key	Datatype	Description
`amount`	string	The integer amount in cents (or local equivalent) representing the total amount of the credit note.
`credit_amount`	string	The integer amount in cents (or local equivalent) representing the amount to credit the customer's balance, which will be automatically applied to their next invoice.
`effective_at`	string	The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF.
`expand[0]`	string	Specifies which fields in the response should be expanded.
`expand[1]`	string	Specifies which fields in the response should be expanded.
`invoice`	string	(Required) ID of the invoice.
`lines[0][type]`	string	Line items that make up the credit note.
`lines[0][amount]`	string	Line items that make up the credit note.
`lines[0][description]`	string	Line items that make up the credit note.
`lines[0][invoice_line_item]`	string	Line items that make up the credit note.
`lines[0][quantity]`	string	Line items that make up the credit note.
`lines[0][tax_amounts][0][amount]`	string	Line items that make up the credit note.
`lines[0][tax_amounts][0][tax_rate]`	string	Line items that make up the credit note.
`lines[0][tax_amounts][0][taxable_amount]`	string	Line items that make up the credit note.
`lines[0][tax_amounts][1][amount]`	string	Line items that make up the credit note.
`lines[0][tax_amounts][1][tax_rate]`	string	Line items that make up the credit note.
`lines[0][tax_amounts][1][taxable_amount]`	string	Line items that make up the credit note.
`lines[0][tax_rates][0]`	string	Line items that make up the credit note.
`lines[0][tax_rates][1]`	string	Line items that make up the credit note.
`lines[0][unit_amount]`	string	Line items that make up the credit note.
`lines[0][unit_amount_decimal]`	string	Line items that make up the credit note.
`lines[1][type]`	string	Line items that make up the credit note.
`lines[1][amount]`	string	Line items that make up the credit note.
`lines[1][description]`	string	Line items that make up the credit note.
`lines[1][invoice_line_item]`	string	Line items that make up the credit note.
`lines[1][quantity]`	string	Line items that make up the credit note.
`lines[1][tax_amounts][0][amount]`	string	Line items that make up the credit note.
`lines[1][tax_amounts][0][tax_rate]`	string	Line items that make up the credit note.
`lines[1][tax_amounts][0][taxable_amount]`	string	Line items that make up the credit note.
`lines[1][tax_amounts][1][amount]`	string	Line items that make up the credit note.
`lines[1][tax_amounts][1][tax_rate]`	string	Line items that make up the credit note.
`lines[1][tax_amounts][1][taxable_amount]`	string	Line items that make up the credit note.
`lines[1][tax_rates][0]`	string	Line items that make up the credit note.
`lines[1][tax_rates][1]`	string	Line items that make up the credit note.
`lines[1][unit_amount]`	string	Line items that make up the credit note.
`lines[1][unit_amount_decimal]`	string	Line items that make up the credit note.
`memo`	string	The credit note's memo appears on the credit note PDF.
`out_of_band_amount`	string	The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
`reason`	string	Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
`refund`	string	ID of an existing refund to link this credit note to.
`refund_amount`	string	The integer amount in cents (or local equivalent) representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
`shipping_cost[shipping_rate]`	string	When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.

HEADERS

Key	Datatype	Required	Description
`Content-Type`	string