stripe 19.7.0.pre.alpha.3 → 19.7.0.pre.alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (89) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/api_requestor.rb +3 -0
  3. data/lib/stripe/api_version.rb +1 -1
  4. data/lib/stripe/errors.rb +3 -0
  5. data/lib/stripe/events/v1_setup_intent_succeeded_event.rb +2 -2
  6. data/lib/stripe/object_types.rb +2 -0
  7. data/lib/stripe/params/checkout/session_create_params.rb +23 -3
  8. data/lib/stripe/params/checkout/session_update_params.rb +2 -2
  9. data/lib/stripe/params/confirmation_token_create_params.rb +2 -2
  10. data/lib/stripe/params/invoice_create_params.rb +17 -1
  11. data/lib/stripe/params/invoice_create_preview_params.rb +6 -2
  12. data/lib/stripe/params/invoice_update_params.rb +17 -1
  13. data/lib/stripe/params/payment_intent_confirm_params.rb +2 -2
  14. data/lib/stripe/params/payment_intent_create_params.rb +2 -2
  15. data/lib/stripe/params/payment_intent_update_params.rb +2 -2
  16. data/lib/stripe/params/payment_link_create_params.rb +1 -1
  17. data/lib/stripe/params/payment_link_update_params.rb +1 -1
  18. data/lib/stripe/params/payment_method_create_params.rb +2 -2
  19. data/lib/stripe/params/payout_create_params.rb +21 -1
  20. data/lib/stripe/params/radar/billing_evaluation_create_params.rb +1 -1
  21. data/lib/stripe/params/setup_intent_confirm_params.rb +2 -2
  22. data/lib/stripe/params/setup_intent_create_params.rb +2 -2
  23. data/lib/stripe/params/setup_intent_update_params.rb +2 -2
  24. data/lib/stripe/params/subscription_create_params.rb +16 -0
  25. data/lib/stripe/params/subscription_item_update_params.rb +2 -2
  26. data/lib/stripe/params/subscription_update_params.rb +18 -2
  27. data/lib/stripe/params/tax/form_list_params.rb +1 -1
  28. data/lib/stripe/params/test_helpers/confirmation_token_create_params.rb +2 -2
  29. data/lib/stripe/params/v2/billing/contract_create_params.rb +4 -1
  30. data/lib/stripe/params/v2/billing/contract_update_params.rb +8 -2
  31. data/lib/stripe/params/v2/core/vault/network_token_create_from_credential_params.rb +33 -0
  32. data/lib/stripe/params/v2/core/vault/network_token_create_params.rb +59 -0
  33. data/lib/stripe/params/v2/core/vault/network_token_generate_cryptogram_params.rb +19 -0
  34. data/lib/stripe/params/v2/core/vault/network_token_retrieve_params.rb +12 -0
  35. data/lib/stripe/params/v2/money_management/financial_address_create_params.rb +23 -20
  36. data/lib/stripe/params/v2/money_management/financial_address_list_params.rb +1 -4
  37. data/lib/stripe/params/v2/money_management/financial_address_retrieve_params.rb +1 -8
  38. data/lib/stripe/params/v2/payments/off_session_payment_create_params.rb +5 -1
  39. data/lib/stripe/params/v2/signals/account_activity_create_params.rb +14 -0
  40. data/lib/stripe/params.rb +10 -0
  41. data/lib/stripe/resources/account_session.rb +1 -28
  42. data/lib/stripe/resources/apps/install.rb +115 -0
  43. data/lib/stripe/resources/charge.rb +6 -14
  44. data/lib/stripe/resources/checkout/session.rb +18 -2
  45. data/lib/stripe/resources/delegated_checkout/requested_session.rb +1 -1
  46. data/lib/stripe/resources/dispute.rb +30 -1
  47. data/lib/stripe/resources/invoice.rb +21 -2
  48. data/lib/stripe/resources/invoice_item.rb +1 -1
  49. data/lib/stripe/resources/invoice_payment.rb +1 -1
  50. data/lib/stripe/resources/issuing/authorization.rb +1 -1
  51. data/lib/stripe/resources/mandate.rb +1 -1
  52. data/lib/stripe/resources/payment_attempt_record.rb +34 -2
  53. data/lib/stripe/resources/payment_intent.rb +2 -0
  54. data/lib/stripe/resources/payment_link.rb +1 -1
  55. data/lib/stripe/resources/payment_record.rb +34 -2
  56. data/lib/stripe/resources/quote_preview_invoice.rb +19 -1
  57. data/lib/stripe/resources/radar/billing_evaluation.rb +1 -1
  58. data/lib/stripe/resources/radar/payment_evaluation.rb +44 -2
  59. data/lib/stripe/resources/subscription.rb +19 -1
  60. data/lib/stripe/resources/tax/form.rb +1 -1
  61. data/lib/stripe/resources/tax/registration.rb +27 -417
  62. data/lib/stripe/resources/tax/transaction_line_item.rb +1 -0
  63. data/lib/stripe/resources/v2/billing/contract.rb +2 -0
  64. data/lib/stripe/resources/v2/core/event_notification.rb +15 -1
  65. data/lib/stripe/resources/v2/core/fee_batch.rb +10 -20
  66. data/lib/stripe/resources/v2/core/fee_entry.rb +4 -8
  67. data/lib/stripe/resources/v2/core/vault/network_token.rb +61 -0
  68. data/lib/stripe/resources/v2/money_management/financial_address.rb +107 -120
  69. data/lib/stripe/resources/v2/money_management/inbound_transfer.rb +5 -5
  70. data/lib/stripe/resources/v2/money_management/received_credit.rb +148 -10
  71. data/lib/stripe/resources/v2/payments/off_session_payment.rb +95 -1
  72. data/lib/stripe/resources/v2/signals/account_activity.rb +17 -0
  73. data/lib/stripe/resources.rb +5 -0
  74. data/lib/stripe/services/account_session_service.rb +1 -1
  75. data/lib/stripe/services/charge_service.rb +2 -8
  76. data/lib/stripe/services/financial_connections/account_service.rb +1 -1
  77. data/lib/stripe/services/financial_connections/authorization_service.rb +1 -1
  78. data/lib/stripe/services/invoice_service.rb +2 -1
  79. data/lib/stripe/services/v2/billing/contract_service.rb +7 -0
  80. data/lib/stripe/services/v2/core/vault/network_token_service.rb +68 -0
  81. data/lib/stripe/services/v2/core/vault_service.rb +2 -1
  82. data/lib/stripe/services/v2/money_management/financial_address_service.rb +3 -3
  83. data/lib/stripe/services/v2/money_management/payout_intent_service.rb +2 -0
  84. data/lib/stripe/services.rb +2 -0
  85. data/lib/stripe/version.rb +1 -1
  86. data/lib/stripe/webhook.rb +8 -0
  87. data/rbi/stripe/stripe_client.rbi +1 -1
  88. data/rbi/stripe.rbi +1426 -780
  89. metadata +9 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b3e9493d61acb2af158d611ad82e3dc2cf7b36d07ee5fc0accc2f3dab6c4e13d
4
- data.tar.gz: 91f91213e19c6fee06984cb3eb5158448f5e82d595967c667c93afff11a71a0a
3
+ metadata.gz: eac9924e9724217da0f571411f89bb1ab1c724eea8413b236386c0020676bfce
4
+ data.tar.gz: eefe6fbed8d00c749a71dff21422b5d5dddb741fae8734b2451a288766dda934
5
5
  SHA512:
6
- metadata.gz: 5c4c6b3406dbe41f746b7a09415144758b7c6da83e21b83d32decee25fed88facfd46285643bb6ad395e167079cc0b2e9f740024a4d874f8027688c07021e383
7
- data.tar.gz: a204443120957ba91c61f9d7028eb29566e34b51305f912c1580478f987ed075b305a548d091ca2dc58614a85d4c3ca4e34e99c804932b49fb1b81c0152ee72e
6
+ metadata.gz: 6f86d1bcf5728d15b1a6f71a8d5ab9a70f638dd7abba0bf546201dd1fd35b5218eedfb499f0c55b87351ca9b63fc2eaa8db694e723ae1b8a9a8617e50eaf4fa5
7
+ data.tar.gz: 0143eef0447c1b9d37ba78bc4751cc00330ba34bd4e4ddb33efac33fd9613d9023eaee12f351ea97ec48d9d755ef13d82ae4ef153f0da86057eaa4df3cf11a98
@@ -889,6 +889,8 @@ module Stripe
889
889
 
890
890
  when "invalid_payout_method"
891
891
  InvalidPayoutMethodError.new(error_data[:message], **opts)
892
+ when "merchant_not_gated"
893
+ MerchantNotGatedError.new(error_data[:message], **opts)
892
894
  when "non_zero_balance"
893
895
  NonZeroBalanceError.new(error_data[:message], **opts)
894
896
  when "not_cancelable"
@@ -1118,6 +1120,7 @@ module Stripe
1118
1120
  %w[CODEX_CI codex_cli],
1119
1121
  %w[CURSOR_AGENT cursor],
1120
1122
  %w[GEMINI_CLI gemini_cli],
1123
+ %w[HERMES_AGENT hermes],
1121
1124
  %w[OPENCLAW_SHELL openclaw],
1122
1125
  %w[OPENCODE open_code],
1123
1126
  # aiAgents: The end of the section generated from our OpenAPI spec
@@ -3,7 +3,7 @@
3
3
 
4
4
  module Stripe
5
5
  module ApiVersion
6
- CURRENT = "2026-08-26.preview"
6
+ CURRENT = "2026-09-16.preview"
7
7
  CURRENT_MAJOR = ""
8
8
  end
9
9
  end
data/lib/stripe/errors.rb CHANGED
@@ -243,6 +243,9 @@ module Stripe
243
243
  class InvalidPayoutMethodError < StripeError
244
244
  end
245
245
 
246
+ class MerchantNotGatedError < StripeError
247
+ end
248
+
246
249
  class NonZeroBalanceError < StripeError
247
250
  end
248
251
 
@@ -3,7 +3,7 @@
3
3
 
4
4
  module Stripe
5
5
  module Events
6
- # Occurs when an SetupIntent has successfully setup a payment method.
6
+ # Occurs when a SetupIntent has successfully setup a payment method.
7
7
  class V1SetupIntentSucceededEvent < Stripe::V2::Core::Event
8
8
  def self.lookup_type
9
9
  "v1.setup_intent.succeeded"
@@ -21,7 +21,7 @@ module Stripe
21
21
  attr_reader :related_object
22
22
  end
23
23
 
24
- # Occurs when an SetupIntent has successfully setup a payment method.
24
+ # Occurs when a SetupIntent has successfully setup a payment method.
25
25
  class V1SetupIntentSucceededEventNotification < Stripe::V2::Core::EventNotification
26
26
  def self.lookup_type
27
27
  "v1.setup_intent.succeeded"
@@ -21,6 +21,7 @@ module Stripe
21
21
  Application.object_name => Application,
22
22
  ApplicationFee.object_name => ApplicationFee,
23
23
  ApplicationFeeRefund.object_name => ApplicationFeeRefund,
24
+ Apps::Install.object_name => Apps::Install,
24
25
  Apps::Secret.object_name => Apps::Secret,
25
26
  Balance.object_name => Balance,
26
27
  BalanceSettings.object_name => BalanceSettings,
@@ -278,6 +279,7 @@ module Stripe
278
279
  V2::Core::Health::Alert.object_name => V2::Core::Health::Alert,
279
280
  V2::Core::Health::AlertHistoryEntry.object_name => V2::Core::Health::AlertHistoryEntry,
280
281
  V2::Core::Vault::GbBankAccount.object_name => V2::Core::Vault::GbBankAccount,
282
+ V2::Core::Vault::NetworkToken.object_name => V2::Core::Vault::NetworkToken,
281
283
  V2::Core::Vault::UsBankAccount.object_name => V2::Core::Vault::UsBankAccount,
282
284
  V2::Data::Analytics::MetricQueryResult.object_name => V2::Data::Analytics::MetricQueryResult,
283
285
  V2::Data::Reporting::QueryRun.object_name => V2::Data::Reporting::QueryRun,
@@ -273,7 +273,7 @@ module Stripe
273
273
  end
274
274
 
275
275
  class Label < ::Stripe::RequestParams
276
- # Custom text for the label, displayed to the customer. Up to 50 characters.
276
+ # Custom text for the label, displayed to the customer. Up to 100 characters.
277
277
  attr_accessor :custom
278
278
  # The type of the label.
279
279
  attr_accessor :type
@@ -592,6 +592,15 @@ module Stripe
592
592
  end
593
593
 
594
594
  class Item < ::Stripe::RequestParams
595
+ class CurrentTrial < ::Stripe::RequestParams
596
+ # The ID of the trial offer to apply to the subscription item.
597
+ attr_accessor :trial_offer
598
+
599
+ def initialize(trial_offer: nil)
600
+ @trial_offer = trial_offer
601
+ end
602
+ end
603
+
595
604
  class PriceData < ::Stripe::RequestParams
596
605
  class ProductData < ::Stripe::RequestParams
597
606
  class TaxDetails < ::Stripe::RequestParams
@@ -687,6 +696,8 @@ module Stripe
687
696
  @field_encodings = { unit_amount_decimal: :decimal_string }
688
697
  end
689
698
  end
699
+ # The trial offer to apply to this subscription item.
700
+ attr_accessor :current_trial
690
701
  # The ID of the [Price](https://docs.stripe.com/api/prices). One of `price` or `price_data` is required.
691
702
  attr_accessor :price
692
703
  # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
@@ -694,7 +705,8 @@ module Stripe
694
705
  # Quantity for this item.
695
706
  attr_accessor :quantity
696
707
 
697
- def initialize(price: nil, price_data: nil, quantity: nil)
708
+ def initialize(current_trial: nil, price: nil, price_data: nil, quantity: nil)
709
+ @current_trial = current_trial
698
710
  @price = price
699
711
  @price_data = price_data
700
712
  @quantity = quantity
@@ -1371,11 +1383,19 @@ module Stripe
1371
1383
  attr_accessor :setup_future_usage
1372
1384
  # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
1373
1385
  attr_accessor :target_date
1386
+ # Attribute for param field verification_method
1387
+ attr_accessor :verification_method
1374
1388
 
1375
- def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil)
1389
+ def initialize(
1390
+ mandate_options: nil,
1391
+ setup_future_usage: nil,
1392
+ target_date: nil,
1393
+ verification_method: nil
1394
+ )
1376
1395
  @mandate_options = mandate_options
1377
1396
  @setup_future_usage = setup_future_usage
1378
1397
  @target_date = target_date
1398
+ @verification_method = verification_method
1379
1399
  end
1380
1400
  end
1381
1401
 
@@ -530,9 +530,9 @@ module Stripe
530
530
  attr_accessor :line_items
531
531
  # Set of [key-value pairs](https://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`.
532
532
  attr_accessor :metadata
533
- # A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
533
+ # A subset of parameters to apply to the PaymentIntent for Checkout Sessions in `payment` mode.
534
534
  #
535
- # You can only update these parameters when `ui_mode` is `elements` and while the session is active.
535
+ # You can only update these parameters when `ui_mode` is `elements` and while the session is active. If the PaymentIntent requires customer action or confirmation, updating these parameters abandons the current payment attempt and returns the PaymentIntent to `requires_payment_method`. You can't update these parameters after the PaymentIntent begins processing, requires capture, succeeds, or is canceled.
536
536
  attr_accessor :payment_intent_data
537
537
  # The shipping rate options to apply to this Session. Up to a maximum of 5.
538
538
  attr_accessor :shipping_options
@@ -417,9 +417,9 @@ module Stripe
417
417
  attr_accessor :alipay
418
418
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
419
419
  attr_accessor :allow_redisplay
420
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
420
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
421
421
  attr_accessor :alma
422
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
422
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
423
423
  attr_accessor :amazon_pay
424
424
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
425
425
  attr_accessor :au_becs_debit
@@ -154,6 +154,18 @@ module Stripe
154
154
  end
155
155
  end
156
156
 
157
+ class BacsDebit < ::Stripe::RequestParams
158
+ # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
159
+ attr_accessor :target_date
160
+ # Attribute for param field verification_method
161
+ attr_accessor :verification_method
162
+
163
+ def initialize(target_date: nil, verification_method: nil)
164
+ @target_date = target_date
165
+ @verification_method = verification_method
166
+ end
167
+ end
168
+
157
169
  class Bancontact < ::Stripe::RequestParams
158
170
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
159
171
  attr_accessor :preferred_language
@@ -421,6 +433,8 @@ module Stripe
421
433
  end
422
434
  # If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
423
435
  attr_accessor :acss_debit
436
+ # If paying by `bacs_debit`, this sub-hash contains details about the Bacs Direct Debit payment method options to pass to the invoice’s PaymentIntent.
437
+ attr_accessor :bacs_debit
424
438
  # If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
425
439
  attr_accessor :bancontact
426
440
  # If paying by `billie`, this sub-hash contains details about the Billie payment method options to pass to the invoice’s PaymentIntent.
@@ -454,6 +468,7 @@ module Stripe
454
468
 
455
469
  def initialize(
456
470
  acss_debit: nil,
471
+ bacs_debit: nil,
457
472
  bancontact: nil,
458
473
  billie: nil,
459
474
  bizum: nil,
@@ -471,6 +486,7 @@ module Stripe
471
486
  wechat_pay: nil
472
487
  )
473
488
  @acss_debit = acss_debit
489
+ @bacs_debit = bacs_debit
474
490
  @bancontact = bancontact
475
491
  @billie = billie
476
492
  @bizum = bizum
@@ -752,7 +768,7 @@ module Stripe
752
768
  attr_accessor :payment_settings
753
769
  # How to handle pending invoice items on invoice creation. Defaults to `exclude` if the parameter is omitted.
754
770
  attr_accessor :pending_invoice_items_behavior
755
- # The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
771
+ # The rendering-related settings that control how invoices render in customer-facing interfaces such as the PDF or hosted invoice page.
756
772
  attr_accessor :rendering
757
773
  # Settings for the cost of shipping for this invoice.
758
774
  attr_accessor :shipping_cost
@@ -2277,9 +2277,9 @@ module Stripe
2277
2277
  attr_accessor :metadata
2278
2278
  # Plan ID for this item, as a string.
2279
2279
  attr_accessor :plan
2280
- # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
2280
+ # The ID of the price object. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
2281
2281
  attr_accessor :price
2282
- # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
2282
+ # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both.
2283
2283
  attr_accessor :price_data
2284
2284
  # Quantity for this item.
2285
2285
  attr_accessor :quantity
@@ -2481,6 +2481,8 @@ module Stripe
2481
2481
  attr_accessor :on_behalf_of
2482
2482
  # Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
2483
2483
  attr_accessor :preview_mode
2484
+ # A pricing token whose presentment currency and exchange rate are used to convert the amounts on the previewed invoice into the customer-facing presentment currency. When omitted, amounts are returned in the settlement currency.
2485
+ attr_accessor :pricing_token
2484
2486
  # The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.
2485
2487
  attr_accessor :schedule
2486
2488
  # The schedule creation or modification params to apply as a preview. Cannot be used with `subscription` or `subscription_` prefixed fields.
@@ -2503,6 +2505,7 @@ module Stripe
2503
2505
  issuer: nil,
2504
2506
  on_behalf_of: nil,
2505
2507
  preview_mode: nil,
2508
+ pricing_token: nil,
2506
2509
  schedule: nil,
2507
2510
  schedule_details: nil,
2508
2511
  subscription: nil,
@@ -2520,6 +2523,7 @@ module Stripe
2520
2523
  @issuer = issuer
2521
2524
  @on_behalf_of = on_behalf_of
2522
2525
  @preview_mode = preview_mode
2526
+ @pricing_token = pricing_token
2523
2527
  @schedule = schedule
2524
2528
  @schedule_details = schedule_details
2525
2529
  @subscription = subscription
@@ -133,6 +133,18 @@ module Stripe
133
133
  end
134
134
  end
135
135
 
136
+ class BacsDebit < ::Stripe::RequestParams
137
+ # Controls when Stripe will attempt to debit the funds from the customer's account. The date must be a string in YYYY-MM-DD format. The date must be in the future and between 3 and 15 calendar days from now.
138
+ attr_accessor :target_date
139
+ # Attribute for param field verification_method
140
+ attr_accessor :verification_method
141
+
142
+ def initialize(target_date: nil, verification_method: nil)
143
+ @target_date = target_date
144
+ @verification_method = verification_method
145
+ end
146
+ end
147
+
136
148
  class Bancontact < ::Stripe::RequestParams
137
149
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
138
150
  attr_accessor :preferred_language
@@ -400,6 +412,8 @@ module Stripe
400
412
  end
401
413
  # If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
402
414
  attr_accessor :acss_debit
415
+ # If paying by `bacs_debit`, this sub-hash contains details about the Bacs Direct Debit payment method options to pass to the invoice’s PaymentIntent.
416
+ attr_accessor :bacs_debit
403
417
  # If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
404
418
  attr_accessor :bancontact
405
419
  # If paying by `billie`, this sub-hash contains details about the Billie payment method options to pass to the invoice’s PaymentIntent.
@@ -433,6 +447,7 @@ module Stripe
433
447
 
434
448
  def initialize(
435
449
  acss_debit: nil,
450
+ bacs_debit: nil,
436
451
  bancontact: nil,
437
452
  billie: nil,
438
453
  bizum: nil,
@@ -450,6 +465,7 @@ module Stripe
450
465
  wechat_pay: nil
451
466
  )
452
467
  @acss_debit = acss_debit
468
+ @bacs_debit = bacs_debit
453
469
  @bancontact = bancontact
454
470
  @billie = billie
455
471
  @bizum = bizum
@@ -719,7 +735,7 @@ module Stripe
719
735
  attr_accessor :on_behalf_of
720
736
  # Configuration settings for the PaymentIntent that is generated when the invoice is finalized.
721
737
  attr_accessor :payment_settings
722
- # The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.
738
+ # The rendering-related settings that control how invoices render in customer-facing interfaces such as the PDF or hosted invoice page.
723
739
  attr_accessor :rendering
724
740
  # Settings for the cost of shipping for this invoice.
725
741
  attr_accessor :shipping_cost
@@ -2716,9 +2716,9 @@ module Stripe
2716
2716
  attr_accessor :alipay
2717
2717
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
2718
2718
  attr_accessor :allow_redisplay
2719
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
2719
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
2720
2720
  attr_accessor :alma
2721
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
2721
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
2722
2722
  attr_accessor :amazon_pay
2723
2723
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
2724
2724
  attr_accessor :au_becs_debit
@@ -2730,9 +2730,9 @@ module Stripe
2730
2730
  attr_accessor :alipay
2731
2731
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
2732
2732
  attr_accessor :allow_redisplay
2733
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
2733
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
2734
2734
  attr_accessor :alma
2735
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
2735
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
2736
2736
  attr_accessor :amazon_pay
2737
2737
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
2738
2738
  attr_accessor :au_becs_debit
@@ -2708,9 +2708,9 @@ module Stripe
2708
2708
  attr_accessor :alipay
2709
2709
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
2710
2710
  attr_accessor :allow_redisplay
2711
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
2711
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
2712
2712
  attr_accessor :alma
2713
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
2713
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
2714
2714
  attr_accessor :amazon_pay
2715
2715
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
2716
2716
  attr_accessor :au_becs_debit
@@ -127,7 +127,7 @@ module Stripe
127
127
  end
128
128
 
129
129
  class Label < ::Stripe::RequestParams
130
- # Custom text for the label, displayed to the customer. Up to 50 characters.
130
+ # Custom text for the label, displayed to the customer. Up to 100 characters.
131
131
  attr_accessor :custom
132
132
  # The type of the label.
133
133
  attr_accessor :type
@@ -112,7 +112,7 @@ module Stripe
112
112
  end
113
113
 
114
114
  class Label < ::Stripe::RequestParams
115
- # Custom text for the label, displayed to the customer. Up to 50 characters.
115
+ # Custom text for the label, displayed to the customer. Up to 100 characters.
116
116
  attr_accessor :custom
117
117
  # The type of the label.
118
118
  attr_accessor :type
@@ -465,9 +465,9 @@ module Stripe
465
465
  attr_accessor :alipay
466
466
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
467
467
  attr_accessor :allow_redisplay
468
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
468
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
469
469
  attr_accessor :alma
470
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
470
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
471
471
  attr_accessor :amazon_pay
472
472
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
473
473
  attr_accessor :au_becs_debit
@@ -3,7 +3,23 @@
3
3
 
4
4
  module Stripe
5
5
  class PayoutCreateParams < ::Stripe::RequestParams
6
- # A positive integer in cents representing how much to payout.
6
+ class PayoutMethodOptions < ::Stripe::RequestParams
7
+ class FinancialAccount < ::Stripe::RequestParams
8
+ # Identifies the currency to credit in the destination Financial Account. Must be a currency supported by the target Financial Account. When omitted, the payout uses the currency parameter.
9
+ attr_accessor :destination_currency
10
+
11
+ def initialize(destination_currency: nil)
12
+ @destination_currency = destination_currency
13
+ end
14
+ end
15
+ # Additional options for a Financial Account payout method. Only valid when payout_method is a Financial Account ID.
16
+ attr_accessor :financial_account
17
+
18
+ def initialize(financial_account: nil)
19
+ @financial_account = financial_account
20
+ end
21
+ end
22
+ # A positive integer in cents representing how much to pay out.
7
23
  attr_accessor :amount
8
24
  # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
9
25
  attr_accessor :currency
@@ -19,6 +35,8 @@ module Stripe
19
35
  attr_accessor :method
20
36
  # The ID of a v2 FinancialAccount to send funds to.
21
37
  attr_accessor :payout_method
38
+ # Additional options that complement the payout_method. The keys in this dictionary identify the type of payout method the options apply to.
39
+ attr_accessor :payout_method_options
22
40
  # The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
23
41
  attr_accessor :source_type
24
42
  # A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all. For US ACH payouts, this maps to the ACH Company Entry Description field, which the NACHA standard limits to 10 characters. Stripe truncates descriptors longer than 10 characters for US ACH payouts.
@@ -33,6 +51,7 @@ module Stripe
33
51
  metadata: nil,
34
52
  method: nil,
35
53
  payout_method: nil,
54
+ payout_method_options: nil,
36
55
  source_type: nil,
37
56
  statement_descriptor: nil
38
57
  )
@@ -44,6 +63,7 @@ module Stripe
44
63
  @metadata = metadata
45
64
  @method = method
46
65
  @payout_method = payout_method
66
+ @payout_method_options = payout_method_options
47
67
  @source_type = source_type
48
68
  @statement_descriptor = statement_descriptor
49
69
  end
@@ -32,7 +32,7 @@ module Stripe
32
32
  attr_accessor :customer
33
33
  # The ID of the Account representing the customer whose upcoming payment is being evaluated.
34
34
  attr_accessor :customer_account
35
- # Attributes of the customer being evaluated. Supply these when the customer isn't represented by a Customer or an Account. If `customer` or `customer_account` is also supplied, the attributes on that object are used and these are ignored.
35
+ # Attributes of the customer being evaluated. Exactly one of `customer`, `customer_account`, and `data` must be supplied: use `data` when the customer isn't represented by a Customer or an Account.
36
36
  attr_accessor :data
37
37
 
38
38
  def initialize(customer: nil, customer_account: nil, data: nil)
@@ -456,9 +456,9 @@ module Stripe
456
456
  attr_accessor :alipay
457
457
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
458
458
  attr_accessor :allow_redisplay
459
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
459
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
460
460
  attr_accessor :alma
461
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
461
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
462
462
  attr_accessor :amazon_pay
463
463
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
464
464
  attr_accessor :au_becs_debit
@@ -470,9 +470,9 @@ module Stripe
470
470
  attr_accessor :alipay
471
471
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
472
472
  attr_accessor :allow_redisplay
473
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
473
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
474
474
  attr_accessor :alma
475
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
475
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
476
476
  attr_accessor :amazon_pay
477
477
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
478
478
  attr_accessor :au_becs_debit
@@ -417,9 +417,9 @@ module Stripe
417
417
  attr_accessor :alipay
418
418
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
419
419
  attr_accessor :allow_redisplay
420
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
420
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
421
421
  attr_accessor :alma
422
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
422
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
423
423
  attr_accessor :amazon_pay
424
424
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
425
425
  attr_accessor :au_becs_debit
@@ -677,6 +677,18 @@ module Stripe
677
677
  end
678
678
  end
679
679
 
680
+ class BacsDebit < ::Stripe::RequestParams
681
+ # Controls when the funds will be captured from the customer's account.
682
+ attr_accessor :debit_behavior
683
+ # Attribute for param field verification_method
684
+ attr_accessor :verification_method
685
+
686
+ def initialize(debit_behavior: nil, verification_method: nil)
687
+ @debit_behavior = debit_behavior
688
+ @verification_method = verification_method
689
+ end
690
+ end
691
+
680
692
  class Bancontact < ::Stripe::RequestParams
681
693
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
682
694
  attr_accessor :preferred_language
@@ -985,6 +997,8 @@ module Stripe
985
997
  end
986
998
  # This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
987
999
  attr_accessor :acss_debit
1000
+ # This sub-hash contains details about the Bacs Direct Debit payment method options to pass to the invoice’s PaymentIntent.
1001
+ attr_accessor :bacs_debit
988
1002
  # This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
989
1003
  attr_accessor :bancontact
990
1004
  # This sub-hash contains details about the Billie payment method options to pass to the invoice’s PaymentIntent.
@@ -1018,6 +1032,7 @@ module Stripe
1018
1032
 
1019
1033
  def initialize(
1020
1034
  acss_debit: nil,
1035
+ bacs_debit: nil,
1021
1036
  bancontact: nil,
1022
1037
  billie: nil,
1023
1038
  bizum: nil,
@@ -1035,6 +1050,7 @@ module Stripe
1035
1050
  wechat_pay: nil
1036
1051
  )
1037
1052
  @acss_debit = acss_debit
1053
+ @bacs_debit = bacs_debit
1038
1054
  @bancontact = bancontact
1039
1055
  @billie = billie
1040
1056
  @bizum = bizum
@@ -180,9 +180,9 @@ module Stripe
180
180
  attr_accessor :payment_behavior
181
181
  # The identifier of the new plan for this subscription item.
182
182
  attr_accessor :plan
183
- # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
183
+ # The ID of the price object. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
184
184
  attr_accessor :price
185
- # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
185
+ # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both.
186
186
  attr_accessor :price_data
187
187
  # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
188
188
  attr_accessor :proration_behavior
@@ -581,9 +581,9 @@ module Stripe
581
581
  attr_accessor :metadata
582
582
  # Plan ID for this item, as a string.
583
583
  attr_accessor :plan
584
- # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
584
+ # The ID of the price object. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
585
585
  attr_accessor :price
586
- # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
586
+ # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. You can use either `price` or `price_data`, but not both, to set or change this item's price. If you're updating an existing item without changing its price, omit both.
587
587
  attr_accessor :price_data
588
588
  # Quantity for this item.
589
589
  attr_accessor :quantity
@@ -659,6 +659,18 @@ module Stripe
659
659
  end
660
660
  end
661
661
 
662
+ class BacsDebit < ::Stripe::RequestParams
663
+ # Controls when the funds will be captured from the customer's account.
664
+ attr_accessor :debit_behavior
665
+ # Attribute for param field verification_method
666
+ attr_accessor :verification_method
667
+
668
+ def initialize(debit_behavior: nil, verification_method: nil)
669
+ @debit_behavior = debit_behavior
670
+ @verification_method = verification_method
671
+ end
672
+ end
673
+
662
674
  class Bancontact < ::Stripe::RequestParams
663
675
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
664
676
  attr_accessor :preferred_language
@@ -967,6 +979,8 @@ module Stripe
967
979
  end
968
980
  # This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.
969
981
  attr_accessor :acss_debit
982
+ # This sub-hash contains details about the Bacs Direct Debit payment method options to pass to the invoice’s PaymentIntent.
983
+ attr_accessor :bacs_debit
970
984
  # This sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.
971
985
  attr_accessor :bancontact
972
986
  # This sub-hash contains details about the Billie payment method options to pass to the invoice’s PaymentIntent.
@@ -1000,6 +1014,7 @@ module Stripe
1000
1014
 
1001
1015
  def initialize(
1002
1016
  acss_debit: nil,
1017
+ bacs_debit: nil,
1003
1018
  bancontact: nil,
1004
1019
  billie: nil,
1005
1020
  bizum: nil,
@@ -1017,6 +1032,7 @@ module Stripe
1017
1032
  wechat_pay: nil
1018
1033
  )
1019
1034
  @acss_debit = acss_debit
1035
+ @bacs_debit = bacs_debit
1020
1036
  @bancontact = bancontact
1021
1037
  @billie = billie
1022
1038
  @bizum = bizum
@@ -9,7 +9,7 @@ module Stripe
9
9
  attr_accessor :account
10
10
  # The external reference to the payee whose forms will be retrieved.
11
11
  attr_accessor :external_reference
12
- # Specifies the payee type. Either `account` or `external_reference`.
12
+ # Specifies the payee type.
13
13
  attr_accessor :type
14
14
 
15
15
  def initialize(account: nil, external_reference: nil, type: nil)
@@ -418,9 +418,9 @@ module Stripe
418
418
  attr_accessor :alipay
419
419
  # This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
420
420
  attr_accessor :allow_redisplay
421
- # If this is a Alma PaymentMethod, this hash contains details about the Alma payment method.
421
+ # If this is an Alma PaymentMethod, this hash contains details about the Alma payment method.
422
422
  attr_accessor :alma
423
- # If this is a AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
423
+ # If this is an AmazonPay PaymentMethod, this hash contains details about the AmazonPay payment method.
424
424
  attr_accessor :amazon_pay
425
425
  # If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
426
426
  attr_accessor :au_becs_debit