Sample - Stripe API
POST/v1/test_helpers/refunds/{refund}/expire

Expire a pending refund

Expires a pending refund by changing a refund with status requires_action to an expired state. Provide the refund identifier for the refund to expire. You can use expand to include additional response fields.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 1 body field
refundstringrequired
The unique identifier of the pending refund to expire.

Optional form-encoded parameters for expanding fields in the returned refund object.

expandarray<string>optional
Specifies which fields in the response should be expanded.

2 status codes
200Returns the updated refund object after expiration, including its amount, currency, charge, customer, status details, and any next action or failure information.
amountintegerrequired
Amount, in cents (or local equivalent).
balance_transactionstringoptional
Balance transaction that describes the impact on your account balance.
chargestringoptional
ID of the charge that's refunded.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
customerstringoptional
ID of the customer of this refund.
customer_accountstringoptional
ID of the account of this refund.
descriptionstringoptional
An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).
destination_detailsobjectoptional
failure_balance_transactionstringoptional
After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.
failure_reasonstringoptional
Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`.
idstringrequired
Unique identifier for the object.
instructions_emailstringoptional
For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
next_actionobjectoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:refund
payment_intentstringoptional
ID of the PaymentIntent that's refunded.
payment_methodstringoptional
ID of the payment method associated with this refund.
pending_reasonstringoptional
Provides the reason for why the refund is pending. Possible values are: `processing`, `insufficient_funds`, or `charge_pending`.
Allowed:charge_pendinginsufficient_fundsprocessing
presentment_detailsobjectoptional
reasonstringoptional
Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).
Allowed:duplicateexpired_uncaptured_chargefraudulentrequested_by_customer
receipt_numberstringoptional
This is the transaction number that appears on email receipts sent for this refund.
source_transfer_reversalstringoptional
The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.
statusstringoptional
Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://docs.stripe.com/refunds#failed-refunds).
transfer_reversalstringoptional
This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter.
defaultReturns an error object containing an `error` property with the error type and related diagnostic information.
errorobjectrequired

Error handling

refund must identify the refund to expire. If provided, each expand value must be a string no longer than 5,000 characters, and the refund must have status requires_action before you expire it.