SetupIntents
Returns a list of SetupIntents.
Table Specific Information
Select
Server-Side Query Support
The add-in 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 add-in.
- Customer supports the following operator: =.
- PaymentMethod supports the following operator: =.
- AttachToSelf supports the following operator: =.
- Created supports the following operator: =.
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 | Unique identifier for the object. | |
| AutomaticPaymentMethodsAllowRedirects | String | Controls whether this SetupIntent will accept redirect-based payment methods. | |
| AutomaticPaymentMethodsEnabled | Boolean | Automatically calculates compatible payment methods | |
| Application | String | ID of the Connect application that created the SetupIntent. | |
| AttachToSelf | Boolean | If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account. | |
| CancellationReason | String | Reason for cancellation of this SetupIntent | |
| ClientSecret | String | The client secret of this SetupIntent. Used for client-side retrieval using a publishable key. | |
| Created | Integer | Time at which the object was created. Measured in seconds since the Unix epoch. | |
| Customer | String | ID of the Customer this SetupIntent belongs to | |
| Description | String | An arbitrary string attached to the object. Often useful for displaying to users. | |
| FlowDirections | String | Indicates the directions of money movement for which this payment method is intended to be used. | |
| LastSetupErrorCode | String | For some errors that could be handled programmatically, a short string indicating the error code reported. | |
| LastSetupErrorDeclineCode | String | For card errors resulting from a card issuer decline, a short string indicating the card issuer’s reason for the decline if they provide 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 PaymentMethod object for errors returned on a request involving a PaymentMethod. | |
| 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 a an object. | |
| LatestAttempt | String | The most recent SetupAttempt for this SetupIntent. | |
| Livemode | Boolean | Has the value true if the object exists in live mode or the value false if the object exists in test mode. | |
| Mandate | String | ID of the multi use Mandate generated by the SetupIntent. | |
| NextAction | String | If present, this property tells you what actions you need to take in order for your customer to continue payment setup. | |
| PaymentMethod | String | ID of the payment method used with this SetupIntent. | |
| Status | String | Status of this SetupIntent | |
| Usage | String | Indicates how the payment method is intended to be used in the future. | |
| Object | String | String representing the objects type. Objects of the same type share the same value. | |
| OnBehalfOf | String | The account (if any) for which the setup is intended. | |
| PaymentMethodConfigurationDetailsId | String | ID of the payment method configuration used. | |
| PaymentMethodConfigurationDetailsParent | String | ID of the parent payment method configuration used. | |
| PaymentmethodOptions | String | Payment method-specific configuration for this SetupIntent. | |
| PaymentMethodTypes | String | The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. | |
| SingleUseMandate | String | ID of the single_use Mandate generated by the SetupIntent. |