post /v1/setup_intents/{intent}/cancel

Cancel a SetupIntent

PostSetupIntentsIntentCancel

<p>You can cancel a SetupIntent object when it’s in one of these statuses: <code>requires_payment_method</code>, <code>requires_confirmation</code>, or <code>requires_action</code>. </p> <p>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. <a href="/docs/api/checkout/sessions/expire">Expire the Checkout Session</a> instead.</p>

Parameters

Name In Type Required Description
intent path string yes

Request Body

application/x-www-form-urlencoded

Responses

200 Successful response.
default Error response.