Create a test Confirmation Token

Creates a test mode Confirmation Token server side for your integration tests.

post/v1/test_helpers/confirmation_tokens

Response

Successful response.

createdinteger required

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

expires_atinteger nullable

Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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'confirmation_token' required

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

payment_intentstring nullable

ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.

return_urlstring nullable

Return URL used to confirm the Intent.

setup_future_usage'off_session' | 'on_session' nullable

Indicates that you intend to make future payments with this ConfirmationToken's payment method.

The presence of this property will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.

setup_intentstring nullable

ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used.

use_stripe_sdkboolean required

Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to true on ConfirmationToken.

Changes

Changed in 18 of the 51 revisions of this API.101149216

Mar 23, 20268c89b982e5191See the full diff
- ○
  added the optional property /////// to the response with the status
  response-optional-property-added
Feb 23, 20269d681f6248d72See the full diff
- ○
  added to the /////// response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed from the /////// response property anyOf list for the response status
  response-property-any-of-removed
Jan 27, 2026cf859d5a7d242See the full diff
- ○
  added to the ////////////////// response property anyOf list for the response status
  response-property-any-of-added
- ○
  removed from the ////////////////// response property anyOf list for the response status
  response-property-any-of-removed
Dec 11, 2025f83e937202592See the full diff
- ▲
  the /////////////// response property's maxLength was unset from 5000 for the response status
  response-property-max-length-unset
- ▲
  the /////////////// response's property type changed from string to no type for status
  response-property-type-changed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Nov 5, 202562e8dc4ed86915See 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
- ○
  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
Oct 22, 20251e483c60b48015See 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
- ○
  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
Sep 25, 2025eb1ac21ec19c1See the full diff
- ▲
  removed the enum value paypay of the request property /
  request-property-enum-value-removed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Aug 19, 20257b79777e9bbd44See 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
- ○
  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
- ○
  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
- ○
  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
- ○
  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
Jul 22, 2025c4dc6dbe947e22See 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
- ○
  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
- ○
  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
May 21, 20254b1e0a4217db6See 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

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

Full history (18 revisions)