Mayson Monorepo Documentation
    Preparing search index...

    Interface SetupIntentUpdateParams

    interface SetupIntentUpdateParams {
        attach_to_self?: boolean;
        customer?: string;
        customer_account?: string;
        description?: string;
        excluded_payment_method_types?: Emptyable<
            Stripe.SetupIntentUpdateParams.ExcludedPaymentMethodType[],
        >;
        expand?: string[];
        flow_directions?: Stripe.SetupIntentUpdateParams.FlowDirection[];
        metadata?: Emptyable<MetadataParam>;
        payment_method?: string;
        payment_method_configuration?: string;
        payment_method_data?: Stripe.SetupIntentUpdateParams.PaymentMethodData;
        payment_method_options?: Stripe.SetupIntentUpdateParams.PaymentMethodOptions;
        payment_method_types?: string[];
    }
    Index

    Properties

    attach_to_self? customer? customer_account? description? excluded_payment_method_types? expand? flow_directions? metadata? payment_method? payment_method_configuration? payment_method_data? payment_method_options? payment_method_types?

    Properties

    attach_to_self?: boolean

    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.

    customer?: string

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

    If present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent.

    customer_account?: string

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

    If present, the SetupIntent's payment method will be attached to the Account on successful setup. Payment methods attached to other Accounts cannot be used with this SetupIntent.

    description?: string

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

    excluded_payment_method_types?: Emptyable<
        Stripe.SetupIntentUpdateParams.ExcludedPaymentMethodType[],
    >

    The list of payment method types to exclude from use with this SetupIntent.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    flow_directions?: Stripe.SetupIntentUpdateParams.FlowDirection[]

    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.

    metadata?: Emptyable<MetadataParam>

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    payment_method?: string

    ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent. To unset this field to null, pass in an empty string.

    payment_method_configuration?: string

    The ID of the payment method configuration to use with this SetupIntent.

    payment_method_data?: Stripe.SetupIntentUpdateParams.PaymentMethodData

    When included, this hash creates a PaymentMethod that is set as the payment_method value in the SetupIntent.

    payment_method_options?: Stripe.SetupIntentUpdateParams.PaymentMethodOptions

    Payment method-specific configuration for this SetupIntent.

    payment_method_types?: string[]

    The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this, Stripe will dynamically show relevant payment methods from your payment method settings. A list of valid payment method types can be found here.

    Settings

    Member Visibility

    On This Page

    Properties