Cancel a SetupIntent

You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.

After you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error. You can’t cancel the SetupIntent for a Checkout Session. Expire the Checkout Session instead.

post/v1/setup_intents/{intent}/cancel

Request

Base URL: https://api.stripe.com
URL: https://api.stripe.com/v1/setup_intents/{intent}/cancel
Auth: one of:
- HTTP basic
- HTTP bearer

Path parameters

intentstring required

Response

Successful response.

allowed_payment_method_typesstring[] nullable

The list of payment method types to allow for this SetupIntent. Stripe will only use methods in this list when determining the payment methods to offer.

attach_to_selfboolean

If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.

It can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer.

cancellation_reason'abandoned' | 'duplicate' | 'requested_by_customer' nullable

Reason for cancellation of this SetupIntent, one of abandoned, requested_by_customer, or duplicate.

client_secretstring nullable

The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

The client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.

createdinteger required

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

customer_accountstring nullable

ID of the Account this SetupIntent belongs to, if one exists.

If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

descriptionstring nullable

An arbitrary string attached to the object. Often useful for displaying to users.

excluded_payment_method_typesstring[] nullable

Payment method types that are excluded from this SetupIntent.

flow_directionsstring[] nullable

Indicates the directions of money movement for which this payment method is intended to be used.

Include inbound if you intend to use the payment method as the origin to pull funds from. Include outbound if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes.

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

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

payment_method_typesstring[] required

The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. A list of valid payment method types can be found here.

Status of this SetupIntent, one of requires_payment_method, requires_confirmation, requires_action, processing, canceled, or succeeded.

usagestring required

Indicates how the payment method is intended to be used in the future.

Use on_session if you intend to only reuse the payment method when the customer is in your checkout flow. Use off_session if your customer may or may not be in your checkout flow. If not provided, this value defaults to off_session.

Changes

No operation changes found yet. Some revisions have not been checked.