payments-core/com.stripe.android.model/ConfirmPaymentIntentParams/SetupFutureUsage

SetupFutureUsage

enum SetupFutureUsage : Enum<ConfirmPaymentIntentParams.SetupFutureUsage>

Indicates that you intend to make future payments with this PaymentIntent’s payment method.

Providing this parameter will attach the payment method to the PaymentIntent’s Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be attached to a Customer after the transaction completes.

When processing card payments, Stripe also uses setup_future_usage to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.

If setup_future_usage is already set, you may only update the value from OnSession to OffSession.

See setup_future_usage.

Entries

OnSession

Use on_session if you intend to only reuse the payment method when your customer is present in your checkout flow.

OffSession

Use off_session if your customer may or may not be in your checkout flow.

Blank

Use `` if you want to clear reusable from the payment intent. Note: this only works if the PaymentIntent was created with no setup_future_usage.

Properties

entries

val entries: EnumEntries<ConfirmPaymentIntentParams.SetupFutureUsage>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

valueOf

fun valueOf(value: String): ConfirmPaymentIntentParams.SetupFutureUsage

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<ConfirmPaymentIntentParams.SetupFutureUsage>

Returns an array containing the constants of this enum type, in the order they're declared.