Interface CreditNotePreviewParams

ID of the invoice.

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.

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.

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.

Type of email to send to the customer, one of credit_note or none and the default is credit_note.

Specifies which fields in the response should be expanded.

Line items that make up the credit note. One of amount, lines, or shipping_cost must be provided.

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

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.

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

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

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 to link to this credit note.

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.