stripe 13.5.0.pre.beta.1 → 13.6.0.pre.beta.1

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 (45) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +47 -34
  3. data/Gemfile +4 -0
  4. data/OPENAPI_VERSION +1 -1
  5. data/VERSION +1 -1
  6. data/lib/stripe/api_version.rb +1 -1
  7. data/lib/stripe/resources/billing/credit_grant.rb +8 -2
  8. data/lib/stripe/resources/charge.rb +1 -1
  9. data/lib/stripe/resources/checkout/session.rb +30 -3
  10. data/lib/stripe/resources/identity/verification_session.rb +2 -2
  11. data/lib/stripe/resources/invoice_line_item.rb +1 -1
  12. data/lib/stripe/resources/order.rb +20 -2
  13. data/lib/stripe/resources/payment_intent.rb +89 -16
  14. data/lib/stripe/resources/product.rb +4 -0
  15. data/lib/stripe/resources/tax/calculation.rb +1 -1
  16. data/lib/stripe/resources/tax_rate.rb +1 -1
  17. data/lib/stripe/resources/terminal/reader.rb +61 -0
  18. data/lib/stripe/services/billing/credit_grant_service.rb +6 -2
  19. data/lib/stripe/services/checkout/session_service.rb +20 -3
  20. data/lib/stripe/services/identity/verification_session_service.rb +1 -1
  21. data/lib/stripe/services/order_service.rb +16 -2
  22. data/lib/stripe/services/payment_intent_service.rb +75 -12
  23. data/lib/stripe/services/product_service.rb +4 -0
  24. data/lib/stripe/services/test_helpers/terminal/reader_service.rb +43 -0
  25. data/lib/stripe/version.rb +1 -1
  26. data/rbi/stripe/resources/account.rbi +1 -1
  27. data/rbi/stripe/resources/billing/credit_grant.rbi +10 -3
  28. data/rbi/stripe/resources/charge.rbi +1 -1
  29. data/rbi/stripe/resources/checkout/session.rbi +40 -8
  30. data/rbi/stripe/resources/identity/verification_session.rbi +2 -2
  31. data/rbi/stripe/resources/invoice_line_item.rbi +130 -33
  32. data/rbi/stripe/resources/order.rbi +26 -6
  33. data/rbi/stripe/resources/payment_intent.rbi +94 -28
  34. data/rbi/stripe/resources/product.rbi +5 -1
  35. data/rbi/stripe/resources/tax/calculation.rbi +1 -1
  36. data/rbi/stripe/resources/tax_rate.rbi +1 -1
  37. data/rbi/stripe/resources/terminal/reader.rbi +17 -0
  38. data/rbi/stripe/services/billing/credit_grant_service.rbi +7 -3
  39. data/rbi/stripe/services/checkout/session_service.rbi +25 -8
  40. data/rbi/stripe/services/identity/verification_session_service.rbi +1 -1
  41. data/rbi/stripe/services/order_service.rbi +20 -6
  42. data/rbi/stripe/services/payment_intent_service.rbi +75 -24
  43. data/rbi/stripe/services/product_service.rbi +5 -1
  44. data/rbi/stripe/services/test_helpers/terminal/reader_service.rbi +29 -0
  45. metadata +2 -2
@@ -1166,6 +1166,9 @@ module Stripe
1166
1166
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1167
1167
  sig { returns(String) }
1168
1168
  attr_reader :setup_future_usage
1169
+ # 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.
1170
+ sig { returns(String) }
1171
+ attr_reader :target_date
1169
1172
  # Bank account verification method.
1170
1173
  sig { returns(String) }
1171
1174
  attr_reader :verification_method
@@ -1245,6 +1248,9 @@ module Stripe
1245
1248
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1246
1249
  sig { returns(String) }
1247
1250
  attr_reader :setup_future_usage
1251
+ # 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.
1252
+ sig { returns(String) }
1253
+ attr_reader :target_date
1248
1254
  end
1249
1255
  class BacsDebit < Stripe::StripeObject
1250
1256
  class MandateOptions < Stripe::StripeObject
@@ -1264,6 +1270,9 @@ module Stripe
1264
1270
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1265
1271
  sig { returns(String) }
1266
1272
  attr_reader :setup_future_usage
1273
+ # 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.
1274
+ sig { returns(String) }
1275
+ attr_reader :target_date
1267
1276
  end
1268
1277
  class Bancontact < Stripe::StripeObject
1269
1278
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
@@ -1945,6 +1954,9 @@ module Stripe
1945
1954
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1946
1955
  sig { returns(String) }
1947
1956
  attr_reader :setup_future_usage
1957
+ # 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.
1958
+ sig { returns(String) }
1959
+ attr_reader :target_date
1948
1960
  end
1949
1961
  class Shopeepay < Stripe::StripeObject
1950
1962
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -2050,6 +2062,9 @@ module Stripe
2050
2062
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
2051
2063
  sig { returns(String) }
2052
2064
  attr_reader :setup_future_usage
2065
+ # 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.
2066
+ sig { returns(String) }
2067
+ attr_reader :target_date
2053
2068
  # Bank account verification method.
2054
2069
  sig { returns(String) }
2055
2070
  attr_reader :verification_method
@@ -2301,12 +2316,12 @@ module Stripe
2301
2316
  attr_reader :tracking_number
2302
2317
  end
2303
2318
  class TransferData < Stripe::StripeObject
2304
- # Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).
2319
+ # The amount transferred to the destination account. This transfer will occur automatically after the payment succeeds. If no amount is specified, by default the entire payment amount is transferred to the destination account.
2320
+ # The amount must be less than or equal to the [amount](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-amount), and must be a positive integer
2321
+ # representing how much to transfer in the smallest currency unit (e.g., 100 cents to charge $1.00).
2305
2322
  sig { returns(Integer) }
2306
2323
  attr_reader :amount
2307
- # The account (if any) that the payment is attributed to for tax
2308
- # reporting, and where funds from the payment are transferred to after
2309
- # payment success.
2324
+ # The account (if any) that the payment is attributed to for tax reporting, and where funds from the payment are transferred to after payment success.
2310
2325
  sig { returns(T.any(String, Stripe::Account)) }
2311
2326
  attr_reader :destination
2312
2327
  end
@@ -3887,15 +3902,19 @@ module Stripe
3887
3902
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
3888
3903
  sig { returns(T.nilable(String)) }
3889
3904
  attr_accessor :setup_future_usage
3905
+ # 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.
3906
+ sig { returns(String) }
3907
+ attr_accessor :target_date
3890
3908
  # Bank account verification method.
3891
3909
  sig { returns(String) }
3892
3910
  attr_accessor :verification_method
3893
3911
  sig {
3894
- params(mandate_options: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), verification_method: String).void
3912
+ params(mandate_options: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String, verification_method: String).void
3895
3913
  }
3896
3914
  def initialize(
3897
3915
  mandate_options: nil,
3898
3916
  setup_future_usage: nil,
3917
+ target_date: nil,
3899
3918
  verification_method: nil
3900
3919
  ); end
3901
3920
  end
@@ -4014,8 +4033,11 @@ module Stripe
4014
4033
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
4015
4034
  sig { returns(T.nilable(String)) }
4016
4035
  attr_accessor :setup_future_usage
4017
- sig { params(setup_future_usage: T.nilable(String)).void }
4018
- def initialize(setup_future_usage: nil); end
4036
+ # 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.
4037
+ sig { returns(String) }
4038
+ attr_accessor :target_date
4039
+ sig { params(setup_future_usage: T.nilable(String), target_date: String).void }
4040
+ def initialize(setup_future_usage: nil, target_date: nil); end
4019
4041
  end
4020
4042
  class BacsDebit < Stripe::RequestParams
4021
4043
  class MandateOptions < Stripe::RequestParams
@@ -4041,10 +4063,13 @@ module Stripe
4041
4063
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
4042
4064
  sig { returns(T.nilable(String)) }
4043
4065
  attr_accessor :setup_future_usage
4066
+ # 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.
4067
+ sig { returns(String) }
4068
+ attr_accessor :target_date
4044
4069
  sig {
4045
- params(mandate_options: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: T.nilable(String)).void
4070
+ params(mandate_options: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String).void
4046
4071
  }
4047
- def initialize(mandate_options: nil, setup_future_usage: nil); end
4072
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
4048
4073
  end
4049
4074
  class Bancontact < Stripe::RequestParams
4050
4075
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
@@ -5152,10 +5177,13 @@ module Stripe
5152
5177
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
5153
5178
  sig { returns(T.nilable(String)) }
5154
5179
  attr_accessor :setup_future_usage
5180
+ # 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.
5181
+ sig { returns(String) }
5182
+ attr_accessor :target_date
5155
5183
  sig {
5156
- params(mandate_options: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String)).void
5184
+ params(mandate_options: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String).void
5157
5185
  }
5158
- def initialize(mandate_options: nil, setup_future_usage: nil); end
5186
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
5159
5187
  end
5160
5188
  class Shopeepay < Stripe::RequestParams
5161
5189
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -5317,11 +5345,14 @@ module Stripe
5317
5345
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
5318
5346
  sig { returns(T.nilable(String)) }
5319
5347
  attr_accessor :setup_future_usage
5348
+ # 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.
5349
+ sig { returns(String) }
5350
+ attr_accessor :target_date
5320
5351
  # Bank account verification method.
5321
5352
  sig { returns(String) }
5322
5353
  attr_accessor :verification_method
5323
5354
  sig {
5324
- params(financial_connections: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, mandate_options: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions, networks: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks, preferred_settlement_speed: T.nilable(String), setup_future_usage: T.nilable(String), verification_method: String).void
5355
+ params(financial_connections: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, mandate_options: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::MandateOptions, networks: ::Stripe::PaymentIntent::CreateParams::PaymentMethodOptions::UsBankAccount::Networks, preferred_settlement_speed: T.nilable(String), setup_future_usage: T.nilable(String), target_date: String, verification_method: String).void
5325
5356
  }
5326
5357
  def initialize(
5327
5358
  financial_connections: nil,
@@ -5329,6 +5360,7 @@ module Stripe
5329
5360
  networks: nil,
5330
5361
  preferred_settlement_speed: nil,
5331
5362
  setup_future_usage: nil,
5363
+ target_date: nil,
5332
5364
  verification_method: nil
5333
5365
  ); end
5334
5366
  end
@@ -7295,15 +7327,19 @@ module Stripe
7295
7327
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
7296
7328
  sig { returns(T.nilable(String)) }
7297
7329
  attr_accessor :setup_future_usage
7330
+ # 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.
7331
+ sig { returns(String) }
7332
+ attr_accessor :target_date
7298
7333
  # Bank account verification method.
7299
7334
  sig { returns(String) }
7300
7335
  attr_accessor :verification_method
7301
7336
  sig {
7302
- params(mandate_options: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), verification_method: String).void
7337
+ params(mandate_options: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String, verification_method: String).void
7303
7338
  }
7304
7339
  def initialize(
7305
7340
  mandate_options: nil,
7306
7341
  setup_future_usage: nil,
7342
+ target_date: nil,
7307
7343
  verification_method: nil
7308
7344
  ); end
7309
7345
  end
@@ -7422,8 +7458,11 @@ module Stripe
7422
7458
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
7423
7459
  sig { returns(T.nilable(String)) }
7424
7460
  attr_accessor :setup_future_usage
7425
- sig { params(setup_future_usage: T.nilable(String)).void }
7426
- def initialize(setup_future_usage: nil); end
7461
+ # 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.
7462
+ sig { returns(String) }
7463
+ attr_accessor :target_date
7464
+ sig { params(setup_future_usage: T.nilable(String), target_date: String).void }
7465
+ def initialize(setup_future_usage: nil, target_date: nil); end
7427
7466
  end
7428
7467
  class BacsDebit < Stripe::RequestParams
7429
7468
  class MandateOptions < Stripe::RequestParams
@@ -7449,10 +7488,13 @@ module Stripe
7449
7488
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
7450
7489
  sig { returns(T.nilable(String)) }
7451
7490
  attr_accessor :setup_future_usage
7491
+ # 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.
7492
+ sig { returns(String) }
7493
+ attr_accessor :target_date
7452
7494
  sig {
7453
- params(mandate_options: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: T.nilable(String)).void
7495
+ params(mandate_options: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String).void
7454
7496
  }
7455
- def initialize(mandate_options: nil, setup_future_usage: nil); end
7497
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
7456
7498
  end
7457
7499
  class Bancontact < Stripe::RequestParams
7458
7500
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
@@ -8560,10 +8602,13 @@ module Stripe
8560
8602
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
8561
8603
  sig { returns(T.nilable(String)) }
8562
8604
  attr_accessor :setup_future_usage
8605
+ # 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.
8606
+ sig { returns(String) }
8607
+ attr_accessor :target_date
8563
8608
  sig {
8564
- params(mandate_options: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String)).void
8609
+ params(mandate_options: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String).void
8565
8610
  }
8566
- def initialize(mandate_options: nil, setup_future_usage: nil); end
8611
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
8567
8612
  end
8568
8613
  class Shopeepay < Stripe::RequestParams
8569
8614
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -8725,11 +8770,14 @@ module Stripe
8725
8770
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
8726
8771
  sig { returns(T.nilable(String)) }
8727
8772
  attr_accessor :setup_future_usage
8773
+ # 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.
8774
+ sig { returns(String) }
8775
+ attr_accessor :target_date
8728
8776
  # Bank account verification method.
8729
8777
  sig { returns(String) }
8730
8778
  attr_accessor :verification_method
8731
8779
  sig {
8732
- params(financial_connections: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, mandate_options: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions, networks: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks, preferred_settlement_speed: T.nilable(String), setup_future_usage: T.nilable(String), verification_method: String).void
8780
+ params(financial_connections: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, mandate_options: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::MandateOptions, networks: ::Stripe::PaymentIntent::UpdateParams::PaymentMethodOptions::UsBankAccount::Networks, preferred_settlement_speed: T.nilable(String), setup_future_usage: T.nilable(String), target_date: String, verification_method: String).void
8733
8781
  }
8734
8782
  def initialize(
8735
8783
  financial_connections: nil,
@@ -8737,6 +8785,7 @@ module Stripe
8737
8785
  networks: nil,
8738
8786
  preferred_settlement_speed: nil,
8739
8787
  setup_future_usage: nil,
8788
+ target_date: nil,
8740
8789
  verification_method: nil
8741
8790
  ); end
8742
8791
  end
@@ -11442,15 +11491,19 @@ module Stripe
11442
11491
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
11443
11492
  sig { returns(T.nilable(String)) }
11444
11493
  attr_accessor :setup_future_usage
11494
+ # 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.
11495
+ sig { returns(String) }
11496
+ attr_accessor :target_date
11445
11497
  # Bank account verification method.
11446
11498
  sig { returns(String) }
11447
11499
  attr_accessor :verification_method
11448
11500
  sig {
11449
- params(mandate_options: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), verification_method: String).void
11501
+ params(mandate_options: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String, verification_method: String).void
11450
11502
  }
11451
11503
  def initialize(
11452
11504
  mandate_options: nil,
11453
11505
  setup_future_usage: nil,
11506
+ target_date: nil,
11454
11507
  verification_method: nil
11455
11508
  ); end
11456
11509
  end
@@ -11569,8 +11622,11 @@ module Stripe
11569
11622
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
11570
11623
  sig { returns(T.nilable(String)) }
11571
11624
  attr_accessor :setup_future_usage
11572
- sig { params(setup_future_usage: T.nilable(String)).void }
11573
- def initialize(setup_future_usage: nil); end
11625
+ # 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.
11626
+ sig { returns(String) }
11627
+ attr_accessor :target_date
11628
+ sig { params(setup_future_usage: T.nilable(String), target_date: String).void }
11629
+ def initialize(setup_future_usage: nil, target_date: nil); end
11574
11630
  end
11575
11631
  class BacsDebit < Stripe::RequestParams
11576
11632
  class MandateOptions < Stripe::RequestParams
@@ -11596,10 +11652,13 @@ module Stripe
11596
11652
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
11597
11653
  sig { returns(T.nilable(String)) }
11598
11654
  attr_accessor :setup_future_usage
11655
+ # 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.
11656
+ sig { returns(String) }
11657
+ attr_accessor :target_date
11599
11658
  sig {
11600
- params(mandate_options: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: T.nilable(String)).void
11659
+ params(mandate_options: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String).void
11601
11660
  }
11602
- def initialize(mandate_options: nil, setup_future_usage: nil); end
11661
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
11603
11662
  end
11604
11663
  class Bancontact < Stripe::RequestParams
11605
11664
  # Preferred language of the Bancontact authorization page that the customer is redirected to.
@@ -12707,10 +12766,13 @@ module Stripe
12707
12766
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
12708
12767
  sig { returns(T.nilable(String)) }
12709
12768
  attr_accessor :setup_future_usage
12769
+ # 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.
12770
+ sig { returns(String) }
12771
+ attr_accessor :target_date
12710
12772
  sig {
12711
- params(mandate_options: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String)).void
12773
+ params(mandate_options: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String).void
12712
12774
  }
12713
- def initialize(mandate_options: nil, setup_future_usage: nil); end
12775
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
12714
12776
  end
12715
12777
  class Shopeepay < Stripe::RequestParams
12716
12778
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -12872,11 +12934,14 @@ module Stripe
12872
12934
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
12873
12935
  sig { returns(T.nilable(String)) }
12874
12936
  attr_accessor :setup_future_usage
12937
+ # 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.
12938
+ sig { returns(String) }
12939
+ attr_accessor :target_date
12875
12940
  # Bank account verification method.
12876
12941
  sig { returns(String) }
12877
12942
  attr_accessor :verification_method
12878
12943
  sig {
12879
- params(financial_connections: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, mandate_options: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions, networks: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks, preferred_settlement_speed: T.nilable(String), setup_future_usage: T.nilable(String), verification_method: String).void
12944
+ params(financial_connections: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, mandate_options: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::MandateOptions, networks: ::Stripe::PaymentIntent::ConfirmParams::PaymentMethodOptions::UsBankAccount::Networks, preferred_settlement_speed: T.nilable(String), setup_future_usage: T.nilable(String), target_date: String, verification_method: String).void
12880
12945
  }
12881
12946
  def initialize(
12882
12947
  financial_connections: nil,
@@ -12884,6 +12949,7 @@ module Stripe
12884
12949
  networks: nil,
12885
12950
  preferred_settlement_speed: nil,
12886
12951
  setup_future_usage: nil,
12952
+ target_date: nil,
12887
12953
  verification_method: nil
12888
12954
  ); end
12889
12955
  end
@@ -397,6 +397,9 @@ module Stripe
397
397
  # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
398
398
  sig { returns(::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount) }
399
399
  attr_accessor :custom_unit_amount
400
+ # Set of [key-value pairs](https://stripe.com/docs/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`.
401
+ sig { returns(T::Hash[String, String]) }
402
+ attr_accessor :metadata
400
403
  # The recurring components of a price such as `interval` and `interval_count`.
401
404
  sig { returns(::Stripe::Product::CreateParams::DefaultPriceData::Recurring) }
402
405
  attr_accessor :recurring
@@ -410,12 +413,13 @@ module Stripe
410
413
  sig { returns(String) }
411
414
  attr_accessor :unit_amount_decimal
412
415
  sig {
413
- params(currency: String, currency_options: T::Hash[String, ::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions], custom_unit_amount: ::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount, recurring: ::Stripe::Product::CreateParams::DefaultPriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
416
+ params(currency: String, currency_options: T::Hash[String, ::Stripe::Product::CreateParams::DefaultPriceData::CurrencyOptions], custom_unit_amount: ::Stripe::Product::CreateParams::DefaultPriceData::CustomUnitAmount, metadata: T::Hash[String, String], recurring: ::Stripe::Product::CreateParams::DefaultPriceData::Recurring, tax_behavior: String, unit_amount: Integer, unit_amount_decimal: String).void
414
417
  }
415
418
  def initialize(
416
419
  currency: nil,
417
420
  currency_options: nil,
418
421
  custom_unit_amount: nil,
422
+ metadata: nil,
419
423
  recurring: nil,
420
424
  tax_behavior: nil,
421
425
  unit_amount: nil,
@@ -162,7 +162,7 @@ module Stripe
162
162
  # The tax rate percentage as a string. For example, 8.5% is represented as `"8.5"`.
163
163
  sig { returns(String) }
164
164
  attr_reader :percentage_decimal
165
- # Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.
165
+ # Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
166
166
  sig { returns(T.nilable(String)) }
167
167
  attr_reader :rate_type
168
168
  # State, county, province, or region.
@@ -62,7 +62,7 @@ module Stripe
62
62
  # Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.
63
63
  sig { returns(Float) }
64
64
  attr_reader :percentage
65
- # Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location.
65
+ # Indicates the type of tax rate applied to the taxable amount. This value can be `null` when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.
66
66
  sig { returns(T.nilable(String)) }
67
67
  attr_reader :rate_type
68
68
  # [ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2), without country prefix. For example, "NY" for New York, United States.
@@ -810,6 +810,23 @@ module Stripe
810
810
  type: nil
811
811
  ); end
812
812
  end
813
+ class SucceedInputCollectionParams < Stripe::RequestParams
814
+ # Specifies which fields in the response should be expanded.
815
+ sig { returns(T::Array[String]) }
816
+ attr_accessor :expand
817
+ # Skip behavior for input collection.
818
+ sig { returns(String) }
819
+ attr_accessor :skip_non_required_inputs
820
+ sig { params(expand: T::Array[String], skip_non_required_inputs: String).void }
821
+ def initialize(expand: nil, skip_non_required_inputs: nil); end
822
+ end
823
+ class TimeoutInputCollectionParams < Stripe::RequestParams
824
+ # Specifies which fields in the response should be expanded.
825
+ sig { returns(T::Array[String]) }
826
+ attr_accessor :expand
827
+ sig { params(expand: T::Array[String]).void }
828
+ def initialize(expand: nil); end
829
+ end
813
830
  # Cancels the current reader action.
814
831
  sig {
815
832
  params(params: T.any(::Stripe::Terminal::Reader::CancelActionParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Terminal::Reader)
@@ -90,7 +90,7 @@ module Stripe
90
90
  # Amount of this credit grant.
91
91
  sig { returns(::Stripe::Billing::CreditGrantService::CreateParams::Amount) }
92
92
  attr_accessor :amount
93
- # Configuration specifying what this credit grant applies to.
93
+ # Configuration specifying what this credit grant applies to. We currently only support `metered` prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them.
94
94
  sig { returns(::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig) }
95
95
  attr_accessor :applicability_config
96
96
  # The category of this credit grant.
@@ -114,8 +114,11 @@ module Stripe
114
114
  # A descriptive name shown in the Dashboard.
115
115
  sig { returns(String) }
116
116
  attr_accessor :name
117
+ # The desired priority for applying this credit grant. If not specified, it will be set to the default value of 50. The highest priority is 0 and the lowest is 100.
118
+ sig { returns(Integer) }
119
+ attr_accessor :priority
117
120
  sig {
118
- params(amount: ::Stripe::Billing::CreditGrantService::CreateParams::Amount, applicability_config: ::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig, category: String, customer: String, effective_at: Integer, expand: T::Array[String], expires_at: Integer, metadata: T::Hash[String, String], name: String).void
121
+ params(amount: ::Stripe::Billing::CreditGrantService::CreateParams::Amount, applicability_config: ::Stripe::Billing::CreditGrantService::CreateParams::ApplicabilityConfig, category: String, customer: String, effective_at: Integer, expand: T::Array[String], expires_at: Integer, metadata: T::Hash[String, String], name: String, priority: Integer).void
119
122
  }
120
123
  def initialize(
121
124
  amount: nil,
@@ -126,7 +129,8 @@ module Stripe
126
129
  expand: nil,
127
130
  expires_at: nil,
128
131
  metadata: nil,
129
- name: nil
132
+ name: nil,
133
+ priority: nil
130
134
  ); end
131
135
  end
132
136
  class RetrieveParams < Stripe::RequestParams
@@ -769,16 +769,20 @@ module Stripe
769
769
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
770
770
  sig { returns(String) }
771
771
  attr_accessor :setup_future_usage
772
+ # 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.
773
+ sig { returns(String) }
774
+ attr_accessor :target_date
772
775
  # Verification method for the intent
773
776
  sig { returns(String) }
774
777
  attr_accessor :verification_method
775
778
  sig {
776
- params(currency: String, mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: String, verification_method: String).void
779
+ params(currency: String, mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: String, target_date: String, verification_method: String).void
777
780
  }
778
781
  def initialize(
779
782
  currency: nil,
780
783
  mandate_options: nil,
781
784
  setup_future_usage: nil,
785
+ target_date: nil,
782
786
  verification_method: nil
783
787
  ); end
784
788
  end
@@ -844,8 +848,11 @@ module Stripe
844
848
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
845
849
  sig { returns(String) }
846
850
  attr_accessor :setup_future_usage
847
- sig { params(setup_future_usage: String).void }
848
- def initialize(setup_future_usage: nil); end
851
+ # 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.
852
+ sig { returns(String) }
853
+ attr_accessor :target_date
854
+ sig { params(setup_future_usage: String, target_date: String).void }
855
+ def initialize(setup_future_usage: nil, target_date: nil); end
849
856
  end
850
857
  class BacsDebit < Stripe::RequestParams
851
858
  class MandateOptions < Stripe::RequestParams
@@ -869,10 +876,13 @@ module Stripe
869
876
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
870
877
  sig { returns(String) }
871
878
  attr_accessor :setup_future_usage
879
+ # 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.
880
+ sig { returns(String) }
881
+ attr_accessor :target_date
872
882
  sig {
873
- params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: String).void
883
+ params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::BacsDebit::MandateOptions, setup_future_usage: String, target_date: String).void
874
884
  }
875
- def initialize(mandate_options: nil, setup_future_usage: nil); end
885
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
876
886
  end
877
887
  class Bancontact < Stripe::RequestParams
878
888
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -1424,10 +1434,13 @@ module Stripe
1424
1434
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1425
1435
  sig { returns(String) }
1426
1436
  attr_accessor :setup_future_usage
1437
+ # 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.
1438
+ sig { returns(String) }
1439
+ attr_accessor :target_date
1427
1440
  sig {
1428
- params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String).void
1441
+ params(mandate_options: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: String, target_date: String).void
1429
1442
  }
1430
- def initialize(mandate_options: nil, setup_future_usage: nil); end
1443
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
1431
1444
  end
1432
1445
  class Sofort < Stripe::RequestParams
1433
1446
  # Indicates that you intend to make future payments with this PaymentIntent's payment method.
@@ -1474,15 +1487,19 @@ module Stripe
1474
1487
  # When processing card payments, Stripe uses `setup_future_usage` to help you comply with regional legislation and network rules, such as [SCA](/strong-customer-authentication).
1475
1488
  sig { returns(String) }
1476
1489
  attr_accessor :setup_future_usage
1490
+ # 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.
1491
+ sig { returns(String) }
1492
+ attr_accessor :target_date
1477
1493
  # Verification method for the intent
1478
1494
  sig { returns(String) }
1479
1495
  attr_accessor :verification_method
1480
1496
  sig {
1481
- params(financial_connections: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, verification_method: String).void
1497
+ params(financial_connections: ::Stripe::Checkout::SessionService::CreateParams::PaymentMethodOptions::UsBankAccount::FinancialConnections, setup_future_usage: String, target_date: String, verification_method: String).void
1482
1498
  }
1483
1499
  def initialize(
1484
1500
  financial_connections: nil,
1485
1501
  setup_future_usage: nil,
1502
+ target_date: nil,
1486
1503
  verification_method: nil
1487
1504
  ); end
1488
1505
  end
@@ -124,7 +124,7 @@ module Stripe
124
124
  returns(::Stripe::Identity::VerificationSessionService::CreateParams::ProvidedDetails)
125
125
  }
126
126
  attr_accessor :provided_details
127
- # Token referencing a Customer resource.
127
+ # Customer ID
128
128
  sig { returns(String) }
129
129
  attr_accessor :related_customer
130
130
  # The URL that the user will be redirected to upon completing the verification flow.
@@ -312,15 +312,19 @@ module Stripe
312
312
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
313
313
  sig { returns(T.nilable(String)) }
314
314
  attr_accessor :setup_future_usage
315
+ # 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.
316
+ sig { returns(String) }
317
+ attr_accessor :target_date
315
318
  # Bank account verification method.
316
319
  sig { returns(String) }
317
320
  attr_accessor :verification_method
318
321
  sig {
319
- params(mandate_options: ::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), verification_method: String).void
322
+ params(mandate_options: ::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String, verification_method: String).void
320
323
  }
321
324
  def initialize(
322
325
  mandate_options: nil,
323
326
  setup_future_usage: nil,
327
+ target_date: nil,
324
328
  verification_method: nil
325
329
  ); end
326
330
  end
@@ -686,10 +690,13 @@ module Stripe
686
690
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
687
691
  sig { returns(T.nilable(String)) }
688
692
  attr_accessor :setup_future_usage
693
+ # 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.
694
+ sig { returns(String) }
695
+ attr_accessor :target_date
689
696
  sig {
690
- params(mandate_options: ::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String)).void
697
+ params(mandate_options: ::Stripe::OrderService::CreateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String).void
691
698
  }
692
- def initialize(mandate_options: nil, setup_future_usage: nil); end
699
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
693
700
  end
694
701
  class Sofort < Stripe::RequestParams
695
702
  # Language shown to the payer on redirect.
@@ -1419,15 +1426,19 @@ module Stripe
1419
1426
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
1420
1427
  sig { returns(T.nilable(String)) }
1421
1428
  attr_accessor :setup_future_usage
1429
+ # 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.
1430
+ sig { returns(String) }
1431
+ attr_accessor :target_date
1422
1432
  # Bank account verification method.
1423
1433
  sig { returns(String) }
1424
1434
  attr_accessor :verification_method
1425
1435
  sig {
1426
- params(mandate_options: ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), verification_method: String).void
1436
+ params(mandate_options: ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::AcssDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String, verification_method: String).void
1427
1437
  }
1428
1438
  def initialize(
1429
1439
  mandate_options: nil,
1430
1440
  setup_future_usage: nil,
1441
+ target_date: nil,
1431
1442
  verification_method: nil
1432
1443
  ); end
1433
1444
  end
@@ -1793,10 +1804,13 @@ module Stripe
1793
1804
  # If you've already set `setup_future_usage` and you're performing a request using a publishable key, you can only update the value from `on_session` to `off_session`.
1794
1805
  sig { returns(T.nilable(String)) }
1795
1806
  attr_accessor :setup_future_usage
1807
+ # 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.
1808
+ sig { returns(String) }
1809
+ attr_accessor :target_date
1796
1810
  sig {
1797
- params(mandate_options: ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String)).void
1811
+ params(mandate_options: ::Stripe::OrderService::UpdateParams::Payment::Settings::PaymentMethodOptions::SepaDebit::MandateOptions, setup_future_usage: T.nilable(String), target_date: String).void
1798
1812
  }
1799
- def initialize(mandate_options: nil, setup_future_usage: nil); end
1813
+ def initialize(mandate_options: nil, setup_future_usage: nil, target_date: nil); end
1800
1814
  end
1801
1815
  class Sofort < Stripe::RequestParams
1802
1816
  # Language shown to the payer on redirect.