SetupIntent class

A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments. For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

Create a SetupIntent as soon as you're ready to collect your customer's payment credentials. Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid. The SetupIntent then transitions through multiple statuses as it guides you through the setup process.

Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions may need to be run through Strong Customer Authentication at the time of payment method collection in order to streamline later off-session payments. If the SetupIntent is used with a Customer, upon success, it will automatically attach the resulting payment method to that Customer. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.

By using SetupIntents, you ensure that your customers experience the minimum set of required friction, even as regulations change over time.

https://stripe.com/docs/api/setup_intents

Annotations

• @freezed

Constructors

SetupIntent({required String id, @Default("setup_intent") String object, String? application, @JsonKey(name: "attach_to_self") String? attachToSelf, @JsonKey(name: "cancellation_reason") SetupIntentCancellationReason? cancellationReason, @JsonKey(name: "client_secret") required String clientSecret, int? created, String? customer, String? description, @JsonKey(name: "flow_directions") List<SetupIntentFlowDirections>? flowDirections, @JsonKey(name: "last_setup_error") dynamic lastSetupError, @JsonKey(name: "latest_attempt") String? latestAttempt, @Default(true) bool livemode, String? mandate, @Default({}) Map<String, dynamic> metadata, @JsonKey(name: "next_action") dynamic nextAction, @JsonKey(name: "on_behalf_of") String? onBehalfOf, @JsonKey(name: "payment_method") String? paymentMethod, @JsonKey(name: "payment_method_options") dynamic paymentMethodOptions, @JsonKey(name: "payment_method_types") @Default([]) List<PaymentMethodType> paymentMethodTypes, @JsonKey(name: "single_use_mandate") String? singleUseMandate, required SetupIntentsStatus status, @Default(SetupIntentUsage.offSession) SetupIntentUsage usage})

const

factory

SetupIntent.fromJson(Map<String, dynamic> json)

factory

Properties

application → String?

CONNECT ONLY ID of the Connect application that created the SetupIntent.

no setter, inherited

attachToSelf → String?

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.

no setter, inherited

cancellationReason → SetupIntentCancellationReason?

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

no setter, inherited

clientSecret → String

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.

no setter, inherited

copyWith → $SetupIntentCopyWith<SetupIntent>

no setter, inherited

created → int?

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

no setter, inherited

customer → String?

The ID of the Customer this SetupIntent belongs to.

no setter, inherited

description → String?

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

no setter, inherited

flowDirections → List<SetupIntentFlowDirections>?

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

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

id → String

Unique identifier for the object.

no setter, inherited

lastSetupError → dynamic

The error encountered in the previous SetupIntent confirmation.

no setter, inherited

latestAttempt → String?

The most recent SetupAttempt for this SetupIntent.

no setter, inherited

livemode → bool

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

no setter, inherited

mandate → String?

ID of the multi use Mandate generated by the SetupIntent.

no setter, inherited

metadata → Map<String, dynamic>

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.

no setter, inherited

nextAction → dynamic

If present, this property tells you what actions you need to take in order for your customer to continue payment setup.

no setter, inherited

object → String

String representing the object’s type. Objects of the same type share the same value. Value is "setup_intent".

no setter, inherited

onBehalfOf → String?

CONNECT ONLY The account (if any) for which the setup is intended.

no setter, inherited

paymentMethod → String?

ID of the payment method used in this SetupIntent.

no setter, inherited

paymentMethodOptions → dynamic

Payment-method-specific configuration for this SetupIntent.

no setter, inherited

paymentMethodTypes → List<PaymentMethodType>

The list of payment method types (e.g. card) that this SetupIntent is allowed to set up.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

singleUseMandate → String?

ID of the single_use Mandate generated by the SetupIntent.

no setter, inherited

status → SetupIntentsStatus

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

no setter, inherited

usage → SetupIntentUsage

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.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited