Interface Refund

interface Refund {
    amount_refunded?: number;
    payment_record_refund?: Stripe.CreditNotePreviewParams.Refund.PaymentRecordRefund;
    refund?: string;
    type?: Stripe.CreditNotePreviewParams.Refund.Type;
}

Index

Properties

amount_refunded? payment_record_refund? refund? type?

Properties

`Optional`amount_refunded

amount_refunded?: number

Amount of the refund that applies to this credit note, in cents (or local equivalent). Defaults to the entire refund amount.

`Optional`payment_record_refund

payment_record_refund?: Stripe.CreditNotePreviewParams.Refund.PaymentRecordRefund

The PaymentRecord refund details to link to this credit note. Required when type is payment_record_refund.

`Optional`refund

refund?: string

ID of an existing refund to link this credit note to. Required when type is refund.

`Optional`type

type?: Stripe.CreditNotePreviewParams.Refund.Type

Type of the refund, one of refund or payment_record_refund. Defaults to refund.