Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a ConfirmationToken

Retrieves an existing ConfirmationToken object

get/v1/confirmation_tokens/{confirmation_token}

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.

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.