Amount in smallest currency unit (e.g., 1000 for $10.00 USD) to refund. If omitted, a full refund is issued. Cannot exceed the charge's remaining refundable amount.
chargestring
Identifier of the charge to refund. Required if `payment_intent` is not provided.
reasonstring
Reasons for issuing a refund in Stripe.
metadataobject
Key-value pairs to attach to the refund, for storing structured information like order numbers or internal IDs.
payment_intentstring
Identifier of the PaymentIntent to refund. Required if `charge` is not provided.
reverse_transferboolean
Reverse an associated transfer? Reversal is proportional to refund amount. Applies if the original charge had a reversible transfer.
refund_application_feeboolean
Refund the application fee? If true, full refunds refund the entire fee; partials refund proportionally. Applies if the original charge had an application fee.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not