SetupIntent

@JsonClass(generateAdapter = true)
data class SetupIntent : Serializable

A SetupIntent guides you through the process of setting up a customer's payment credentials for future payments.

See the API Reference for SetupIntents for more information.

Properties

Link copied to clipboard

ID of the Connect application that created the SetupIntent.

Link copied to clipboard

Reason for cancellation of this SetupIntent.

Link copied to clipboard

The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.

Link copied to clipboard
val created: Long = 0

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

Link copied to clipboard

ID of the Customer this SetupIntent belongs to, if one exists.

Link copied to clipboard

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

Link copied to clipboard
val id: String

Unique identifier for the object.

Link copied to clipboard
val isLiveMode: Boolean = false

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

Link copied to clipboard

The error encountered in the previous SetupIntent confirmation.

Link copied to clipboard

The most recent SetupAttempt for this SetupIntent, expanded as an object.

Link copied to clipboard

The ID if the most recent SetupAttempt for this SetupIntent.

Link copied to clipboard

ID of the multi use Mandate generated by the SetupIntent.

Link copied to clipboard

Set of key-value pairs that you can attach to an object.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

ID of the payment method used with this SetupIntent.

Link copied to clipboard

Payment-method-specific configuration for this SetupIntent.

Link copied to clipboard

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

Link copied to clipboard

ID of the single_use Mandate generated by the SetupIntent.

Link copied to clipboard
Link copied to clipboard

Indicates how the payment method is intended to be used in the future.