Preview a credit note

GetCreditNotesPreview

<p>Get a preview of a credit note without creating it.</p>

Parameters

Name	In	Type	Required	Description
amount	query	integer	no	The integer amount in cents (or local equivalent) representing the total amount of the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
credit_amount	query	integer	no	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	query	integer	no	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.
email_type	query	string	no	Type of email to send to the customer, one of `credit_note` or `none` and the default is `credit_note`.
expand	query	string[]	no	Specifies which fields in the response should be expanded.
invoice	query	string	yes	ID of the invoice.
lines	query	object[]	no	Line items that make up the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.
memo	query	string	no	The credit note's memo appears on the credit note PDF.
metadata	query	object	no	Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
out_of_band_amount	query	integer	no	The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.
reason	query	string	no	Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`
refund_amount	query	integer	no	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.
refunds	query	object[]	no	Refunds to link to this credit note.
shipping_cost	query	object	no	When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note. One of `amount`, `lines`, or `shipping_cost` must be provided.

Request Body

application/x-www-form-urlencoded

Responses

200 Successful response.

default Error response.