GET /v1/credit_notes/preview

amount (integer, query, optional)

The integer amount in cents (or local equivalent) representing the total amount of the credit note.

credit_amount (integer, query, optional)

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.

expand (array, query, optional)

Specifies which fields in the response should be expanded.

invoice (string, query, required)

ID of the invoice.

Constraints: {'maxLength': 5000}

lines (array, query, optional)

Line items that make up the credit note.

memo (string, query, optional)

The credit note's memo appears on the credit note PDF.

Constraints: {'maxLength': 5000}

metadata (object, query, optional)

Set of [key-value pairs](https://stripe.com/docs/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 (integer, query, optional)

The integer amount in cents (or local equivalent) representing the amount that is credited outside of Stripe.

reason (string, query, optional)

Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`

Constraints: {'enum': ['duplicate', 'fraudulent', 'order_change', 'product_unsatisfactory']}

refund (string, query, optional)

ID of an existing refund to link this credit note to.

refund_amount (integer, query, optional)

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 (object, query, optional)

When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is included in the credit note.