Retrieve a ConfirmationToken

Changed on Sep 29, 2026

Retrieves an existing ConfirmationToken object

get/v1/confirmation_tokens/{confirmation_token}

Request

Base URL: https://api.stripe.com
URL: https://api.stripe.com/v1/confirmation_tokens/{confirmation_token}
Auth: one of:
- HTTP basic
- HTTP bearer

Path parameters

confirmation_tokenstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

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

Sep 29, 20267cff4cc46d06 Revision changes
- warning
  added the new final_payment_failure enum value to the ////////// response property for the response status
- warning
  added the new first_payment_failure enum value to the ////////// response property for the response status
Sep 25, 20268b5c2f03d4cd Revision changes
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property /////////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property ////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property //////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property //////////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property ///////////////////// to the response with the status
- info
  added the optional property //////////////// to the response with the status
- info
  added the optional property //////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ////////////////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property /////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ////////////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property ///////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property //////////////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property /////////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ////////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
- info
  added the optional property ///////////// to the response with the status
This list may be incomplete.

Some revisions have not been checked yet.

Operation history (5 revisions)