SetupIntents
Returns setup intents, including payment method configuration, the latest setup attempt, and any setup errors encountered.
View-Specific Information
SELECT
The driver uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the driver.
| Column | Supported Operators |
| Customer | = |
| PaymentMethod | = |
| AttachToSelf | = |
| Created | = |
You can select from SetupIntents with the following queries:
SELECT * FROM SetupIntents
SELECT * FROM SetupIntents WHERE Customer = 'cus_PEW7WrieLzCMkW'
SELECT * FROM SetupIntents WHERE PaymentMethod = 'pm_1GhPzLJXTn'
SELECT * FROM SetupIntents WHERE AttachToSelf = true
SELECT * FROM SetupIntents WHERE Created >= '2024-01-01'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier for the setup intent. | |
| AutomaticPaymentMethodsAllowRedirects | String | Controls whether this setup intent accepts redirect-based payment methods. | |
| AutomaticPaymentMethodsEnabled | Boolean | Indicates whether compatible payment methods are automatically calculated. | |
| Application | String | The Id of the Connect application that created the setup intent. | |
| AttachToSelf | Boolean | Indicates whether the setup intent's payment method is attached to the in-context Stripe account. If present, the payment method is attached to that account. | |
| CancellationReason | String | The reason for cancellation of this setup intent. | |
| ClientSecret | String | The client secret of this setup intent, used for client-side retrieval with a publishable key. | |
| Created | Datetime | The time at which the setup intent was created, measured in seconds since the Unix epoch. | |
| Customer | String |
Customers.Id | The Id of the customer this setup intent belongs to. |
| Description | String | An arbitrary string attached to the setup intent, often useful for displaying to users. | |
| FlowDirections | String | The directions of money movement for which this payment method is intended to be used. | |
| LastSetupErrorCode | String | A short string indicating the error code reported, for errors that can be handled programmatically. | |
| LastSetupErrorDeclineCode | String | A short string indicating the card issuer's reason for the decline, for card errors resulting from a card issuer decline, if the issuer provides one. | |
| LastSetupErrorDocURL | String | A URL to more information about the error code reported. | |
| LastSetupErrorMessage | String | A human-readable message providing more details about the error. For card errors, these messages can be shown to your users. | |
| LastSetupErrorParam | String | If the error is parameter-specific, the parameter related to the error. | |
| LastSetupErrorPaymentMethod | String | The payment method object for errors returned on a request involving a payment method. | |
| LastSetupErrorPaymentMethodType | String | If the error is specific to the type of payment method, the payment method type that had a problem. | |
| LastSetupErrorType | String | The type of error returned. | |
| MetadataAggregate | String | The set of key-value pairs that you can attach to the setup intent. | |
| LatestAttempt | String | The most recent setup attempt for this setup intent. | |
| Livemode | Boolean | Indicates whether the object exists in live mode. Has the value true if the object exists in live mode, or the value false if the object exists in test mode. | |
| Mandate | String | The Id of the multi-use mandate generated by the setup intent. | |
| NextAction | String | The actions you need to take in order for your customer to continue payment setup, if present. | |
| PaymentMethod | String | The Id of the payment method used with this setup intent. | |
| Status | String | The status of this setup intent. | |
| Usage | String | Indicates how the payment method is intended to be used in the future. | |
| Object | String | The string representing the object's type. Objects of the same type share the same value. | |
| OnBehalfOf | String | The account (if any) for which the setup is intended. | |
| PaymentMethodConfigurationDetailsId | String | The Id of the payment method configuration used. | |
| PaymentMethodConfigurationDetailsParent | String | The Id of the parent payment method configuration used. | |
| PaymentmethodOptions | String | The payment method-specific configuration for this setup intent. | |
| PaymentMethodTypes | String | The list of payment method types, such as card, that this setup intent is allowed to set up. | |
| SingleUseMandate | String | The Id of the single-use mandate generated by the setup intent. |