Interface RefundCreateParams

Export

RefundCreateParams

Hierarchy

  • RefundCreateParams

Properties

amount? metadata? payment_intent_id reason? refund_platform_fee?

Properties

Optional amount

amount?: number

A positive integer representing how much of this charge to refund in the smallest currency unit (e.g., 100 cents to charge $1.00). The default is the entire charge.

Memberof

RefundCreateParams

Optional metadata

metadata?: {
    [key: string]: string;
}

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 (i.e. \'\' or null) to them. All keys can be unset by posting an empty value (i.e. {} or null) to metadata.

Memberof

RefundCreateParams

Type declaration

  • [key: string]: string

payment_intent_id

payment_intent_id: string

ID of the PaymentIntent to refund.

Memberof

RefundCreateParams

Optional reason

reason?: RefundCreateParamsReason

String indicating the reason for the refund. If set, possible values are duplicate, fraudulent, and requested_by_customer.

Memberof

RefundCreateParams

Optional refund_platform_fee

refund_platform_fee?: boolean

Boolean indicating whether the platform fee should be refunded when refunding this charge. If a full charge refund is given, the full platform fee will be refunded. Otherwise, the platform fee will be refunded in an amount proportional to the amount of the charge refunded.

Memberof

RefundCreateParams

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc