Expire a pending refund.

Expire a refund with a status of requires_action.

post/v1/test_helpers/refunds/{refund}/expire

Path parameters

refundstring required

Response

Successful response.

amountinteger required

Amount, in cents (or local equivalent).

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

currencystring currency required

Three-letter ISO currency code, in lowercase. Must be a supported currency.

customer_accountstring nullable

ID of the account of this refund.

descriptionstring

An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).

failure_reasonstring

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.

idstring required

Unique identifier for the object.

instructions_emailstring

For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.

metadataobject nullable

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.

object'refund' required

String representing the object's type. Objects of the same type share the same value.

pending_reason'charge_pending' | 'insufficient_funds' | 'processing'

Provides the reason for why the refund is pending. Possible values are: processing, insufficient_funds, or charge_pending.

reason'duplicate' | 'expired_uncaptured_charge' | 'fraudulent' | 'requested_by_customer' nullable

Reason for the refund, which is either user-provided (duplicate, fraudulent, or requested_by_customer) or generated by Stripe internally (expired_uncaptured_charge).

receipt_numberstring nullable

This is the transaction number that appears on email receipts sent for this refund.

statusstring nullable

Status of the refund. This can be pending, requires_action, succeeded, failed, or canceled. Learn more about failed refunds.

Changes

Changed in 9 of the 51 revisions of this API.171624

Nov 5, 202562e8dc4ed8691See the full diff
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
Oct 22, 20251e483c60b4801See the full diff
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
Aug 19, 20257b79777e9bbd2See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e1See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Feb 14, 20251199cc3c557429See the full diff
- ▲
  the response property /////////////// became optional for the status
  response-property-became-optional
- ▲
  the response property //////////// became optional for the status
  response-property-became-optional
- ○
  added the optional property /////////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025b8a91ebdacb78See the full diff
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property ////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
- ○
  added the optional property //// to the response with the status
  response-optional-property-added
Dec 14, 202446de5407335916See the full diff
- ●
  added the new al_tin enum value to the /////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the //////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the ///////////// response property for the response status
  response-property-enum-value-added
- ●
  added the new al_tin enum value to the /////////////// response property for the response status
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 11, 2024d8ab202758612See the full diff
- ○
  added the optional property ///////// to the response with the status
  response-optional-property-added
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Oct 23, 202433103c93fb8c15See the full diff
- ▲
  the ///////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the /////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ////////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ///////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the ///////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the //////// response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history