Stripe Refund
CertifiedCreate a Stripe refund
Stripe Refund
Create a Stripe refund
Issues a full or partial refund for a charge or PaymentIntent. Requires either chargeId or paymentIntentId; amount defaults to full if omitted.
type: io.kestra.plugin.stripe.payment.RefundExamples
Refund a payment by Charge ID
id: refund_payment
namespace: company.team
tasks:
- id: refund_payment
type: io.kestra.plugin.stripe.payment.Refund
apiKey: "{{ secret('STRIPE_API_KEY') }}"
chargeId: "ch_123456789"
Refund a specific amount for a PaymentIntent
id: refund_partial
namespace: company.team
tasks:
- id: refund_partial
type: io.kestra.plugin.stripe.payment.Refund
apiKey: "{{ secret('STRIPE_API_KEY') }}"
paymentIntentId: "pi_123456789"
amount: 500 # amount in cents
Properties
apiKey *string
Stripe API Key
Secret key for authenticating with Stripe. Starts with 'sk_' for live/test keys.
amount integerstring
Refund amount
Amount in the smallest currency unit; defaults to full refund when null
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150chargeId string
Charge ID
Charge to refund; provide this or paymentIntentId
paymentIntentId string
PaymentIntent ID
PaymentIntent to refund; provide this or chargeId
Outputs
amount integer
Refunded amount
Amount in the smallest currency unit
currency string
Refund currency
raw string
Raw Stripe response
refundId string
Refund ID
status string
Refund status
