Class: Stripe::SetupIntentUpdateParams

Inherits:
RequestParams show all
Defined in:
lib/stripe/params/setup_intent_update_params.rb

Defined Under Namespace

Classes: PaymentMethodData, PaymentMethodOptions, SetupDetails

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from RequestParams

attr_accessor, coerce_params, coerce_value, field_encodings, new, #to_h

Constructor Details

#initialize(attach_to_self: nil, customer: nil, customer_account: nil, description: nil, excluded_payment_method_types: nil, expand: nil, flow_directions: nil, metadata: nil, payment_method: nil, payment_method_configuration: nil, payment_method_data: nil, payment_method_options: nil, payment_method_types: nil, setup_details: nil) ⇒ SetupIntentUpdateParams

Returns a new instance of SetupIntentUpdateParams.



1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1363

def initialize(
  attach_to_self: nil,
  customer: nil,
  customer_account: nil,
  description: nil,
  excluded_payment_method_types: nil,
  expand: nil,
  flow_directions: nil,
  metadata: nil,
  payment_method: nil,
  payment_method_configuration: nil,
  payment_method_data: nil,
  payment_method_options: nil,
  payment_method_types: nil,
  setup_details: nil
)
  @attach_to_self = attach_to_self
  @customer = customer
  @customer_account = 
  @description = description
  @excluded_payment_method_types = excluded_payment_method_types
  @expand = expand
  @flow_directions = flow_directions
  @metadata = metadata
  @payment_method = payment_method
  @payment_method_configuration = payment_method_configuration
  @payment_method_data = payment_method_data
  @payment_method_options = payment_method_options
  @payment_method_types = payment_method_types
  @setup_details = setup_details
end

Instance Attribute Details

#attach_to_self ⇒ Object

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.



1328
1329
1330
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1328

def attach_to_self
  @attach_to_self
end

#customer ⇒ Object

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.



1332
1333
1334
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1332

def customer
  @customer
end

#customer_account ⇒ Object

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.



1336
1337
1338
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1336

def 
  @customer_account
end

#description ⇒ Object

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



1338
1339
1340
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1338

def description
  @description
end

#excluded_payment_method_types ⇒ Object

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



1340
1341
1342
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1340

def excluded_payment_method_types
  @excluded_payment_method_types
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.



1342
1343
1344
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1342

def expand
  @expand
end

#flow_directions ⇒ Object

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.



1346
1347
1348
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1346

def flow_directions
  @flow_directions
end

#metadata ⇒ Object

Set of [key-value pairs](docs.stripe.com/api/metadata) 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`.



1348
1349
1350
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1348

def metadata
  @metadata
end

#payment_method ⇒ Object

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.



1350
1351
1352
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1350

def payment_method
  @payment_method
end

#payment_method_configuration ⇒ Object

The ID of the [payment method configuration](docs.stripe.com/api/payment_method_configurations) to use with this SetupIntent.



1352
1353
1354
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1352

def payment_method_configuration
  @payment_method_configuration
end

#payment_method_data ⇒ Object

When included, this hash creates a PaymentMethod that is set as the [‘payment_method`](docs.stripe.com/api/setup_intents/object#setup_intent_object-payment_method) value in the SetupIntent.



1355
1356
1357
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1355

def payment_method_data
  @payment_method_data
end

#payment_method_options ⇒ Object

Payment method-specific configuration for this SetupIntent.



1357
1358
1359
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1357

def payment_method_options
  @payment_method_options
end

#payment_method_types ⇒ Object

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](dashboard.stripe.com/settings/payment_methods). A list of valid payment method types can be found [here](docs.stripe.com/api/payment_methods/object#payment_method_object-type).



1359
1360
1361
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1359

def payment_method_types
  @payment_method_types
end

#setup_details ⇒ Object

Provides industry-specific information about the SetupIntent.



1361
1362
1363
 
# File 'lib/stripe/params/setup_intent_update_params.rb', line 1361

def setup_details
  @setup_details
end