Skip to main content
Schema2020-08-27object

setup_attempt

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

Source
openapi/spec3.json
Commit
d70de345383d
Active snapshot
da69df7e6e11

PaymentFlowsSetupIntentSetupAttempt

object

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation was successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

application
optionalnullable

The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation.

created integer (unix-time)
required

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

customer
optionalnullable

The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation.

id string
required

Unique identifier for the object.

livemode boolean
required

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

object string
required

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

on_behalf_of
optionalnullable

The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation.

payment_method
required

ID of the payment method used with this SetupAttempt.

setup_error
optionalnullable

The error encountered during this attempt to confirm the SetupIntent, if any.

setup_intent
required

ID of the SetupIntent that this attempt belongs to.

status string
required

Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`.

usage string
required

The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`.