stripe 18.1.0.pre.alpha.2 → 18.1.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 (38) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stripe/event_types.rb +20 -0
  3. data/lib/stripe/events/v2_iam_api_key_created_event.rb +20 -0
  4. data/lib/stripe/events/v2_iam_api_key_default_secret_revealed_event.rb +20 -0
  5. data/lib/stripe/events/v2_iam_api_key_expired_event.rb +20 -0
  6. data/lib/stripe/events/v2_iam_api_key_permissions_updated_event.rb +20 -0
  7. data/lib/stripe/events/v2_iam_api_key_rotated_event.rb +38 -0
  8. data/lib/stripe/events/v2_iam_api_key_updated_event.rb +20 -0
  9. data/lib/stripe/object_types.rb +1 -0
  10. data/lib/stripe/params/account_create_params.rb +4 -4
  11. data/lib/stripe/params/account_person_create_params.rb +4 -4
  12. data/lib/stripe/params/account_person_update_params.rb +4 -4
  13. data/lib/stripe/params/account_update_params.rb +4 -4
  14. data/lib/stripe/params/delegated_checkout/requested_session_create_params.rb +2 -2
  15. data/lib/stripe/params/delegated_checkout/requested_session_update_params.rb +2 -2
  16. data/lib/stripe/params/payment_intent_create_params.rb +14 -1
  17. data/lib/stripe/params/product_catalog/trial_offer_create_params.rb +60 -0
  18. data/lib/stripe/params/token_create_params.rb +8 -8
  19. data/lib/stripe/params/v2/core/event_list_params.rb +4 -1
  20. data/lib/stripe/params/v2/core/event_retrieve_params.rb +8 -1
  21. data/lib/stripe/params.rb +1 -0
  22. data/lib/stripe/resources/account_session.rb +27 -0
  23. data/lib/stripe/resources/delegated_checkout/requested_session.rb +6 -14
  24. data/lib/stripe/resources/payment_intent.rb +16 -0
  25. data/lib/stripe/resources/person.rb +2 -2
  26. data/lib/stripe/resources/product_catalog/trial_offer.rb +101 -0
  27. data/lib/stripe/resources/v2/core/event.rb +50 -1
  28. data/lib/stripe/resources/v2/money_management/received_credit.rb +16 -0
  29. data/lib/stripe/resources/v2/money_management/received_debit.rb +37 -1
  30. data/lib/stripe/resources.rb +7 -0
  31. data/lib/stripe/services/product_catalog/trial_offer_service.rb +19 -0
  32. data/lib/stripe/services/product_catalog_service.rb +13 -0
  33. data/lib/stripe/services/v1_services.rb +2 -1
  34. data/lib/stripe/services.rb +2 -0
  35. data/lib/stripe/stripe_object.rb +22 -1
  36. data/lib/stripe/version.rb +1 -1
  37. data/rbi/stripe.rbi +398 -56
  38. metadata +12 -2
data/rbi/stripe.rbi CHANGED
@@ -3053,6 +3053,28 @@ module Stripe
3053
3053
  @field_remappings = {}
3054
3054
  end
3055
3055
  end
3056
+ class CheckScanning < ::Stripe::StripeObject
3057
+ class Features < ::Stripe::StripeObject
3058
+ def self.inner_class_types
3059
+ @inner_class_types = {}
3060
+ end
3061
+ def self.field_remappings
3062
+ @field_remappings = {}
3063
+ end
3064
+ end
3065
+ # Whether the embedded component is enabled.
3066
+ sig { returns(T::Boolean) }
3067
+ def enabled; end
3068
+ # Attribute for field features
3069
+ sig { returns(Features) }
3070
+ def features; end
3071
+ def self.inner_class_types
3072
+ @inner_class_types = {features: Features}
3073
+ end
3074
+ def self.field_remappings
3075
+ @field_remappings = {}
3076
+ end
3077
+ end
3056
3078
  class DisputesList < ::Stripe::StripeObject
3057
3079
  class Features < ::Stripe::StripeObject
3058
3080
  # Whether to allow capturing and cancelling payment intents. This is `true` by default.
@@ -3588,6 +3610,9 @@ module Stripe
3588
3610
  # Attribute for field tax_settings
3589
3611
  sig { returns(TaxSettings) }
3590
3612
  def tax_settings; end
3613
+ # Configuration for the [check scanning](/connect/supported-embedded-components/check-scanning/) embedded component.
3614
+ sig { returns(T.nilable(CheckScanning)) }
3615
+ def check_scanning; end
3591
3616
  def self.inner_class_types
3592
3617
  @inner_class_types = {
3593
3618
  account_management: AccountManagement,
@@ -3612,6 +3637,7 @@ module Stripe
3612
3637
  payouts_list: PayoutsList,
3613
3638
  tax_registrations: TaxRegistrations,
3614
3639
  tax_settings: TaxSettings,
3640
+ check_scanning: CheckScanning,
3615
3641
  }
3616
3642
  end
3617
3643
  def self.field_remappings
@@ -5556,7 +5582,7 @@ module Stripe
5556
5582
  end
5557
5583
  end
5558
5584
  class SelfReportedIncome < ::Stripe::StripeObject
5559
- # Amount in the minor currency unit (e.g., cents for USD)
5585
+ # The amount in the minor currency unit (for example, cents for USD).
5560
5586
  sig { returns(Integer) }
5561
5587
  def amount; end
5562
5588
  # 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).
@@ -5570,7 +5596,7 @@ module Stripe
5570
5596
  end
5571
5597
  end
5572
5598
  class SelfReportedMonthlyHousingPayment < ::Stripe::StripeObject
5573
- # Amount in the minor currency unit (e.g., cents for USD)
5599
+ # The amount in the minor currency unit (for example, cents for USD).
5574
5600
  sig { returns(Integer) }
5575
5601
  def amount; end
5576
5602
  # 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).
@@ -17954,7 +17980,7 @@ module Stripe
17954
17980
  # ZIP or postal code.
17955
17981
  sig { returns(T.nilable(String)) }
17956
17982
  def postal_code; end
17957
- # State, county, province, or region.
17983
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
17958
17984
  sig { returns(T.nilable(String)) }
17959
17985
  def state; end
17960
17986
  def self.inner_class_types
@@ -18097,18 +18123,6 @@ module Stripe
18097
18123
  # The total before any discounts or taxes are applied.
18098
18124
  sig { returns(Integer) }
18099
18125
  def amount_subtotal; end
18100
- # The total after discounts but before taxes are applied.
18101
- sig { returns(Integer) }
18102
- def amount_subtotal_after_discount; end
18103
- # The total after discounts and taxes.
18104
- sig { returns(Integer) }
18105
- def amount_total; end
18106
- # The per-unit amount of the item after discounts but before taxes are applied.
18107
- sig { returns(Integer) }
18108
- def unit_amount_after_discount; end
18109
- # The per-unit discount amount. If no discount were applied, defaults to 0.
18110
- sig { returns(Integer) }
18111
- def unit_discount; end
18112
18126
  def self.inner_class_types
18113
18127
  @inner_class_types = {}
18114
18128
  end
@@ -18148,7 +18162,7 @@ module Stripe
18148
18162
  # ZIP or postal code.
18149
18163
  sig { returns(String) }
18150
18164
  def postal_code; end
18151
- # State, county, province, or region.
18165
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
18152
18166
  sig { returns(String) }
18153
18167
  def state; end
18154
18168
  def self.inner_class_types
@@ -18236,18 +18250,18 @@ module Stripe
18236
18250
  @field_remappings = {}
18237
18251
  end
18238
18252
  end
18239
- # The amount discount of the total details.
18240
- sig { returns(T.nilable(Integer)) }
18241
- def amount_discount; end
18242
18253
  # The amount fulfillment of the total details.
18243
18254
  sig { returns(T.nilable(Integer)) }
18244
18255
  def amount_fulfillment; end
18245
18256
  # The amount tax of the total details.
18246
18257
  sig { returns(T.nilable(Integer)) }
18247
18258
  def amount_tax; end
18248
- # Total of all items after discounts but before taxes are applied.
18259
+ # The amount of order-level discounts applied to the cart. The total discount amount for this session can be computed by summing the cart discount and the item discounts.
18260
+ sig { returns(T.nilable(Integer)) }
18261
+ def amount_cart_discount; end
18262
+ # The amount of item-level discounts applied to the cart. The total discount amount for this session can be computed by summing the cart discount and the item discounts.
18249
18263
  sig { returns(T.nilable(Integer)) }
18250
- def amount_subtotal_after_discount; end
18264
+ def amount_items_discount; end
18251
18265
  # The applicable fees of the total details.
18252
18266
  sig { returns(T.nilable(T::Array[ApplicableFee])) }
18253
18267
  def applicable_fees; end
@@ -33347,6 +33361,17 @@ module Stripe
33347
33361
  @field_remappings = {}
33348
33362
  end
33349
33363
  end
33364
+ class PaymentsOrchestration < ::Stripe::StripeObject
33365
+ # Whether this feature is enabled.
33366
+ sig { returns(T::Boolean) }
33367
+ def enabled; end
33368
+ def self.inner_class_types
33369
+ @inner_class_types = {}
33370
+ end
33371
+ def self.field_remappings
33372
+ @field_remappings = {}
33373
+ end
33374
+ end
33350
33375
  # Allocated Funds configuration for this PaymentIntent.
33351
33376
  sig { returns(T.nilable(AllocatedFunds)) }
33352
33377
  def allocated_funds; end
@@ -33510,6 +33535,9 @@ module Stripe
33510
33535
  # A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers).
33511
33536
  sig { returns(T.nilable(String)) }
33512
33537
  def transfer_group; end
33538
+ # When you enable this parameter, this PaymentIntent will route your payment to processors that you configure in the dashboard.
33539
+ sig { returns(T.nilable(PaymentsOrchestration)) }
33540
+ def payments_orchestration; end
33513
33541
  # Manually reconcile the remaining amount for a customer_balance PaymentIntent.
33514
33542
  sig {
33515
33543
  params(params: T.any(::Stripe::PaymentIntentApplyCustomerBalanceParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::PaymentIntent)
@@ -41885,6 +41913,88 @@ module Stripe
41885
41913
  end
41886
41914
  end
41887
41915
  # typed: true
41916
+ module Stripe
41917
+ module ProductCatalog
41918
+ # Resource for the TrialOffer API, used to describe a subscription item's trial period settings.
41919
+ # Renders a TrialOffer object that describes the price, duration, end_behavior of a trial offer.
41920
+ class TrialOffer < APIResource
41921
+ class Duration < ::Stripe::StripeObject
41922
+ class Relative < ::Stripe::StripeObject
41923
+ # The number of iterations of the price's interval for this trial offer.
41924
+ sig { returns(Integer) }
41925
+ def iterations; end
41926
+ def self.inner_class_types
41927
+ @inner_class_types = {}
41928
+ end
41929
+ def self.field_remappings
41930
+ @field_remappings = {}
41931
+ end
41932
+ end
41933
+ # Attribute for field relative
41934
+ sig { returns(Relative) }
41935
+ def relative; end
41936
+ # The type of trial offer duration.
41937
+ sig { returns(String) }
41938
+ def type; end
41939
+ def self.inner_class_types
41940
+ @inner_class_types = {relative: Relative}
41941
+ end
41942
+ def self.field_remappings
41943
+ @field_remappings = {}
41944
+ end
41945
+ end
41946
+ class EndBehavior < ::Stripe::StripeObject
41947
+ class Transition < ::Stripe::StripeObject
41948
+ # The new price to use at the end of the trial offer period.
41949
+ sig { returns(String) }
41950
+ def price; end
41951
+ def self.inner_class_types
41952
+ @inner_class_types = {}
41953
+ end
41954
+ def self.field_remappings
41955
+ @field_remappings = {}
41956
+ end
41957
+ end
41958
+ # Attribute for field transition
41959
+ sig { returns(Transition) }
41960
+ def transition; end
41961
+ # The type of behavior when the trial offer ends.
41962
+ sig { returns(String) }
41963
+ def type; end
41964
+ def self.inner_class_types
41965
+ @inner_class_types = {transition: Transition}
41966
+ end
41967
+ def self.field_remappings
41968
+ @field_remappings = {}
41969
+ end
41970
+ end
41971
+ # Attribute for field duration
41972
+ sig { returns(Duration) }
41973
+ def duration; end
41974
+ # Attribute for field end_behavior
41975
+ sig { returns(EndBehavior) }
41976
+ def end_behavior; end
41977
+ # Unique identifier for the object.
41978
+ sig { returns(String) }
41979
+ def id; end
41980
+ # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
41981
+ sig { returns(T::Boolean) }
41982
+ def livemode; end
41983
+ # String representing the object's type. Objects of the same type share the same value.
41984
+ sig { returns(String) }
41985
+ def object; end
41986
+ # The price during the trial offer.
41987
+ sig { returns(T.any(String, ::Stripe::Price)) }
41988
+ def price; end
41989
+ # Creates a trial offer.
41990
+ sig {
41991
+ params(params: T.any(::Stripe::ProductCatalog::TrialOfferCreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::ProductCatalog::TrialOffer)
41992
+ }
41993
+ def self.create(params = {}, opts = {}); end
41994
+ end
41995
+ end
41996
+ end
41997
+ # typed: true
41888
41998
  module Stripe
41889
41999
  # Products describe the specific goods or services you offer to your customers.
41890
42000
  # For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.
@@ -68938,6 +69048,57 @@ module Stripe
68938
69048
  class Event < APIResource
68939
69049
  class Reason < ::Stripe::StripeObject
68940
69050
  class Request < ::Stripe::StripeObject
69051
+ class Client < ::Stripe::StripeObject
69052
+ class ApiKey < ::Stripe::StripeObject
69053
+ # The ID of the API key.
69054
+ sig { returns(String) }
69055
+ def id; end
69056
+ def self.inner_class_types
69057
+ @inner_class_types = {}
69058
+ end
69059
+ def self.field_remappings
69060
+ @field_remappings = {}
69061
+ end
69062
+ end
69063
+ class DashboardUser < ::Stripe::StripeObject
69064
+ # The email of the dashboard user.
69065
+ sig { returns(String) }
69066
+ def email; end
69067
+ # The IP address of the user.
69068
+ sig { returns(String) }
69069
+ def ip_address; end
69070
+ # The machine identifier of the user.
69071
+ sig { returns(String) }
69072
+ def machine_identifier; end
69073
+ def self.inner_class_types
69074
+ @inner_class_types = {}
69075
+ end
69076
+ def self.field_remappings
69077
+ @field_remappings = {}
69078
+ end
69079
+ end
69080
+ # The type of the client.
69081
+ sig { returns(String) }
69082
+ def type; end
69083
+ # API key that triggered the event.
69084
+ sig { returns(T.nilable(ApiKey)) }
69085
+ def api_key; end
69086
+ # Dashboard user that triggered the event.
69087
+ sig { returns(T.nilable(DashboardUser)) }
69088
+ def dashboard_user; end
69089
+ # Stripe action that triggered the event.
69090
+ sig { returns(T.nilable(T::Hash[String, T.untyped])) }
69091
+ def stripe_action; end
69092
+ def self.inner_class_types
69093
+ @inner_class_types = {api_key: ApiKey, dashboard_user: DashboardUser}
69094
+ end
69095
+ def self.field_remappings
69096
+ @field_remappings = {}
69097
+ end
69098
+ end
69099
+ # The client details that made the request.
69100
+ sig { returns(T.nilable(Client)) }
69101
+ def client; end
68941
69102
  # ID of the API request that caused the event.
68942
69103
  sig { returns(String) }
68943
69104
  def id; end
@@ -68945,7 +69106,7 @@ module Stripe
68945
69106
  sig { returns(String) }
68946
69107
  def idempotency_key; end
68947
69108
  def self.inner_class_types
68948
- @inner_class_types = {}
69109
+ @inner_class_types = {client: Client}
68949
69110
  end
68950
69111
  def self.field_remappings
68951
69112
  @field_remappings = {}
@@ -70992,6 +71153,17 @@ module Stripe
70992
71153
  @field_remappings = {}
70993
71154
  end
70994
71155
  end
71156
+ class StripeBalancePayment < ::Stripe::StripeObject
71157
+ # Statement descriptor for the Stripe Balance Payment.
71158
+ sig { returns(T.nilable(String)) }
71159
+ def statement_descriptor; end
71160
+ def self.inner_class_types
71161
+ @inner_class_types = {}
71162
+ end
71163
+ def self.field_remappings
71164
+ @field_remappings = {}
71165
+ end
71166
+ end
70995
71167
  # The amount and currency of the ReceivedCredit.
70996
71168
  sig { returns(Amount) }
70997
71169
  def amount; end
@@ -71038,6 +71210,9 @@ module Stripe
71038
71210
  # This object stores details about the originating banking transaction that resulted in the ReceivedCredit. Present if `type` field value is `bank_transfer`.
71039
71211
  sig { returns(T.nilable(BankTransfer)) }
71040
71212
  def bank_transfer; end
71213
+ # This object stores details about the stripe balance pay refund that resulted in the ReceivedCredit. Present if `type` field value is `stripe_balance_payment`.
71214
+ sig { returns(T.nilable(StripeBalancePayment)) }
71215
+ def stripe_balance_payment; end
71041
71216
  end
71042
71217
  end
71043
71218
  end
@@ -71119,6 +71294,20 @@ module Stripe
71119
71294
  @field_remappings = {}
71120
71295
  end
71121
71296
  end
71297
+ class BalanceTransfer < ::Stripe::StripeObject
71298
+ # Open Enum. The type of balance transfer that originated the ReceivedDebit.
71299
+ sig { returns(String) }
71300
+ def type; end
71301
+ # The ID of the topup object that originated the ReceivedDebit.
71302
+ sig { returns(T.nilable(String)) }
71303
+ def topup; end
71304
+ def self.inner_class_types
71305
+ @inner_class_types = {}
71306
+ end
71307
+ def self.field_remappings
71308
+ @field_remappings = {}
71309
+ end
71310
+ end
71122
71311
  class BankTransfer < ::Stripe::StripeObject
71123
71312
  class UsBankAccount < ::Stripe::StripeObject
71124
71313
  # The name of the bank the debit originated from.
@@ -71159,6 +71348,20 @@ module Stripe
71159
71348
  @field_remappings = {}
71160
71349
  end
71161
71350
  end
71351
+ class StripeBalancePayment < ::Stripe::StripeObject
71352
+ # ID of the debit agreement associated with this payment.
71353
+ sig { returns(T.nilable(String)) }
71354
+ def debit_agreement; end
71355
+ # Statement descriptor for the Stripe Balance Payment.
71356
+ sig { returns(T.nilable(String)) }
71357
+ def statement_descriptor; end
71358
+ def self.inner_class_types
71359
+ @inner_class_types = {}
71360
+ end
71361
+ def self.field_remappings
71362
+ @field_remappings = {}
71363
+ end
71364
+ end
71162
71365
  # Amount and currency of the ReceivedDebit.
71163
71366
  sig { returns(Amount) }
71164
71367
  def amount; end
@@ -71193,15 +71396,21 @@ module Stripe
71193
71396
  # The time at which the ReceivedDebit transitioned to a particular status.
71194
71397
  sig { returns(T.nilable(StatusTransitions)) }
71195
71398
  def status_transitions; end
71196
- # Open Enum. The type of the ReceivedDebit.
71399
+ # Open enum, the type of the received debit.
71197
71400
  sig { returns(String) }
71198
71401
  def type; end
71199
71402
  # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
71200
71403
  sig { returns(T::Boolean) }
71201
71404
  def livemode; end
71405
+ # This object stores details about the balance transfer object that resulted in the ReceivedDebit.
71406
+ sig { returns(T.nilable(BalanceTransfer)) }
71407
+ def balance_transfer; end
71202
71408
  # This object stores details about the originating banking transaction that resulted in the ReceivedDebit. Present if `type` field value is `bank_transfer`.
71203
71409
  sig { returns(T.nilable(BankTransfer)) }
71204
71410
  def bank_transfer; end
71411
+ # This object stores details about the Stripe Balance Payment that resulted in the ReceivedDebit.
71412
+ sig { returns(T.nilable(StripeBalancePayment)) }
71413
+ def stripe_balance_payment; end
71205
71414
  end
71206
71415
  end
71207
71416
  end
@@ -72070,6 +72279,7 @@ module Stripe
72070
72279
  attr_reader :prices
72071
72280
  attr_reader :privacy
72072
72281
  attr_reader :products
72282
+ attr_reader :product_catalog
72073
72283
  attr_reader :promotion_codes
72074
72284
  attr_reader :quotes
72075
72285
  attr_reader :radar
@@ -75388,6 +75598,24 @@ module Stripe
75388
75598
  end
75389
75599
  end
75390
75600
  # typed: true
75601
+ module Stripe
75602
+ class ProductCatalogService < StripeService
75603
+ attr_reader :trial_offers
75604
+ end
75605
+ end
75606
+ # typed: true
75607
+ module Stripe
75608
+ module ProductCatalog
75609
+ class TrialOfferService < StripeService
75610
+ # Creates a trial offer.
75611
+ sig {
75612
+ params(params: T.any(::Stripe::ProductCatalog::TrialOfferCreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(::Stripe::ProductCatalog::TrialOffer)
75613
+ }
75614
+ def create(params = {}, opts = {}); end
75615
+ end
75616
+ end
75617
+ end
75618
+ # typed: true
75391
75619
  module Stripe
75392
75620
  class PromotionCodeService < StripeService
75393
75621
  # A promotion code points to an underlying promotion. You can optionally restrict the code to a specific customer, redemption limit, and expiration date.
@@ -83232,12 +83460,12 @@ module Stripe
83232
83460
  ); end
83233
83461
  end
83234
83462
  class SelfReportedIncome < ::Stripe::RequestParams
83235
- # Attribute for param field amount
83463
+ # The amount in the minor currency unit (for example, cents for USD).
83236
83464
  sig { returns(Integer) }
83237
83465
  def amount; end
83238
83466
  sig { params(_amount: Integer).returns(Integer) }
83239
83467
  def amount=(_amount); end
83240
- # Attribute for param field currency
83468
+ # 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).
83241
83469
  sig { returns(String) }
83242
83470
  def currency; end
83243
83471
  sig { params(_currency: String).returns(String) }
@@ -83246,12 +83474,12 @@ module Stripe
83246
83474
  def initialize(amount: nil, currency: nil); end
83247
83475
  end
83248
83476
  class SelfReportedMonthlyHousingPayment < ::Stripe::RequestParams
83249
- # Attribute for param field amount
83477
+ # The amount in the minor currency unit (for example, cents for USD).
83250
83478
  sig { returns(Integer) }
83251
83479
  def amount; end
83252
83480
  sig { params(_amount: Integer).returns(Integer) }
83253
83481
  def amount=(_amount); end
83254
- # Attribute for param field currency
83482
+ # 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).
83255
83483
  sig { returns(String) }
83256
83484
  def currency; end
83257
83485
  sig { params(_currency: String).returns(String) }
@@ -86733,12 +86961,12 @@ module Stripe
86733
86961
  ); end
86734
86962
  end
86735
86963
  class SelfReportedIncome < ::Stripe::RequestParams
86736
- # Attribute for param field amount
86964
+ # The amount in the minor currency unit (for example, cents for USD).
86737
86965
  sig { returns(Integer) }
86738
86966
  def amount; end
86739
86967
  sig { params(_amount: Integer).returns(Integer) }
86740
86968
  def amount=(_amount); end
86741
- # Attribute for param field currency
86969
+ # 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).
86742
86970
  sig { returns(String) }
86743
86971
  def currency; end
86744
86972
  sig { params(_currency: String).returns(String) }
@@ -86747,12 +86975,12 @@ module Stripe
86747
86975
  def initialize(amount: nil, currency: nil); end
86748
86976
  end
86749
86977
  class SelfReportedMonthlyHousingPayment < ::Stripe::RequestParams
86750
- # Attribute for param field amount
86978
+ # The amount in the minor currency unit (for example, cents for USD).
86751
86979
  sig { returns(Integer) }
86752
86980
  def amount; end
86753
86981
  sig { params(_amount: Integer).returns(Integer) }
86754
86982
  def amount=(_amount); end
86755
- # Attribute for param field currency
86983
+ # 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).
86756
86984
  sig { returns(String) }
86757
86985
  def currency; end
86758
86986
  sig { params(_currency: String).returns(String) }
@@ -105104,7 +105332,7 @@ module Stripe
105104
105332
  def postal_code; end
105105
105333
  sig { params(_postal_code: String).returns(String) }
105106
105334
  def postal_code=(_postal_code); end
105107
- # State, county, province, or region.
105335
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
105108
105336
  sig { returns(String) }
105109
105337
  def state; end
105110
105338
  sig { params(_state: String).returns(String) }
@@ -105236,7 +105464,7 @@ module Stripe
105236
105464
  def postal_code; end
105237
105465
  sig { params(_postal_code: String).returns(String) }
105238
105466
  def postal_code=(_postal_code); end
105239
- # State, county, province, or region.
105467
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
105240
105468
  sig { returns(String) }
105241
105469
  def state; end
105242
105470
  sig { params(_state: String).returns(String) }
@@ -105431,7 +105659,7 @@ module Stripe
105431
105659
  def postal_code; end
105432
105660
  sig { params(_postal_code: String).returns(String) }
105433
105661
  def postal_code=(_postal_code); end
105434
- # State, county, province, or region.
105662
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
105435
105663
  sig { returns(String) }
105436
105664
  def state; end
105437
105665
  sig { params(_state: String).returns(String) }
@@ -105519,7 +105747,7 @@ module Stripe
105519
105747
  def postal_code; end
105520
105748
  sig { params(_postal_code: String).returns(String) }
105521
105749
  def postal_code=(_postal_code); end
105522
- # State, county, province, or region.
105750
+ # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
105523
105751
  sig { returns(String) }
105524
105752
  def state; end
105525
105753
  sig { params(_state: String).returns(String) }
@@ -137383,6 +137611,15 @@ module Stripe
137383
137611
  zip: nil
137384
137612
  ); end
137385
137613
  end
137614
+ class PaymentsOrchestration < ::Stripe::RequestParams
137615
+ # Whether this feature is enabled.
137616
+ sig { returns(T::Boolean) }
137617
+ def enabled; end
137618
+ sig { params(_enabled: T::Boolean).returns(T::Boolean) }
137619
+ def enabled=(_enabled); end
137620
+ sig { params(enabled: T::Boolean).void }
137621
+ def initialize(enabled: nil); end
137622
+ end
137386
137623
  class RadarOptions < ::Stripe::RequestParams
137387
137624
  # A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
137388
137625
  sig { returns(T.nilable(String)) }
@@ -137746,8 +137983,15 @@ module Stripe
137746
137983
  def use_stripe_sdk; end
137747
137984
  sig { params(_use_stripe_sdk: T.nilable(T::Boolean)).returns(T.nilable(T::Boolean)) }
137748
137985
  def use_stripe_sdk=(_use_stripe_sdk); end
137986
+ # When you enable this parameter, this PaymentIntent will route your payment to processors that you configure in the dashboard.
137987
+ sig { returns(T.nilable(PaymentIntentCreateParams::PaymentsOrchestration)) }
137988
+ def payments_orchestration; end
137749
137989
  sig {
137750
- params(allocated_funds: T.nilable(PaymentIntentCreateParams::AllocatedFunds), amount: Integer, amount_details: T.nilable(PaymentIntentCreateParams::AmountDetails), application_fee_amount: T.nilable(Integer), automatic_payment_methods: T.nilable(PaymentIntentCreateParams::AutomaticPaymentMethods), capture_method: T.nilable(String), confirm: T.nilable(T::Boolean), confirmation_method: T.nilable(String), confirmation_token: T.nilable(String), currency: String, customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), error_on_requires_action: T.nilable(T::Boolean), excluded_payment_method_types: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), hooks: T.nilable(PaymentIntentCreateParams::Hooks), mandate: T.nilable(String), mandate_data: T.nilable(T.any(String, PaymentIntentCreateParams::MandateData)), metadata: T.nilable(T::Hash[String, String]), off_session: T.nilable(T.any(T::Boolean, String)), on_behalf_of: T.nilable(String), payment_details: T.nilable(PaymentIntentCreateParams::PaymentDetails), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(PaymentIntentCreateParams::PaymentMethodData), payment_method_options: T.nilable(PaymentIntentCreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), radar_options: T.nilable(PaymentIntentCreateParams::RadarOptions), receipt_email: T.nilable(String), return_url: T.nilable(String), secret_key_confirmation: T.nilable(String), setup_future_usage: T.nilable(String), shipping: T.nilable(PaymentIntentCreateParams::Shipping), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(PaymentIntentCreateParams::TransferData), transfer_group: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean)).void
137990
+ params(_payments_orchestration: T.nilable(PaymentIntentCreateParams::PaymentsOrchestration)).returns(T.nilable(PaymentIntentCreateParams::PaymentsOrchestration))
137991
+ }
137992
+ def payments_orchestration=(_payments_orchestration); end
137993
+ sig {
137994
+ params(allocated_funds: T.nilable(PaymentIntentCreateParams::AllocatedFunds), amount: Integer, amount_details: T.nilable(PaymentIntentCreateParams::AmountDetails), application_fee_amount: T.nilable(Integer), automatic_payment_methods: T.nilable(PaymentIntentCreateParams::AutomaticPaymentMethods), capture_method: T.nilable(String), confirm: T.nilable(T::Boolean), confirmation_method: T.nilable(String), confirmation_token: T.nilable(String), currency: String, customer: T.nilable(String), customer_account: T.nilable(String), description: T.nilable(String), error_on_requires_action: T.nilable(T::Boolean), excluded_payment_method_types: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), fx_quote: T.nilable(String), hooks: T.nilable(PaymentIntentCreateParams::Hooks), mandate: T.nilable(String), mandate_data: T.nilable(T.any(String, PaymentIntentCreateParams::MandateData)), metadata: T.nilable(T::Hash[String, String]), off_session: T.nilable(T.any(T::Boolean, String)), on_behalf_of: T.nilable(String), payment_details: T.nilable(PaymentIntentCreateParams::PaymentDetails), payment_method: T.nilable(String), payment_method_configuration: T.nilable(String), payment_method_data: T.nilable(PaymentIntentCreateParams::PaymentMethodData), payment_method_options: T.nilable(PaymentIntentCreateParams::PaymentMethodOptions), payment_method_types: T.nilable(T::Array[String]), radar_options: T.nilable(PaymentIntentCreateParams::RadarOptions), receipt_email: T.nilable(String), return_url: T.nilable(String), secret_key_confirmation: T.nilable(String), setup_future_usage: T.nilable(String), shipping: T.nilable(PaymentIntentCreateParams::Shipping), statement_descriptor: T.nilable(String), statement_descriptor_suffix: T.nilable(String), transfer_data: T.nilable(PaymentIntentCreateParams::TransferData), transfer_group: T.nilable(String), use_stripe_sdk: T.nilable(T::Boolean), payments_orchestration: T.nilable(PaymentIntentCreateParams::PaymentsOrchestration)).void
137751
137995
  }
137752
137996
  def initialize(
137753
137997
  allocated_funds: nil,
@@ -137789,7 +138033,8 @@ module Stripe
137789
138033
  statement_descriptor_suffix: nil,
137790
138034
  transfer_data: nil,
137791
138035
  transfer_group: nil,
137792
- use_stripe_sdk: nil
138036
+ use_stripe_sdk: nil,
138037
+ payments_orchestration: nil
137793
138038
  ); end
137794
138039
  end
137795
138040
  end
@@ -168642,6 +168887,90 @@ module Stripe
168642
168887
  end
168643
168888
  end
168644
168889
  # typed: true
168890
+ module Stripe
168891
+ module ProductCatalog
168892
+ class TrialOfferCreateParams < ::Stripe::RequestParams
168893
+ class Duration < ::Stripe::RequestParams
168894
+ class Relative < ::Stripe::RequestParams
168895
+ # The number of recurring price's interval to apply for the trial period.
168896
+ sig { returns(Integer) }
168897
+ def iterations; end
168898
+ sig { params(_iterations: Integer).returns(Integer) }
168899
+ def iterations=(_iterations); end
168900
+ sig { params(iterations: Integer).void }
168901
+ def initialize(iterations: nil); end
168902
+ end
168903
+ # The relative duration of the trial period computed as the number of recurring price intervals.
168904
+ sig { returns(T.nilable(ProductCatalog::TrialOfferCreateParams::Duration::Relative)) }
168905
+ def relative; end
168906
+ sig {
168907
+ params(_relative: T.nilable(ProductCatalog::TrialOfferCreateParams::Duration::Relative)).returns(T.nilable(ProductCatalog::TrialOfferCreateParams::Duration::Relative))
168908
+ }
168909
+ def relative=(_relative); end
168910
+ # Specifies how the trial offer duration is determined.
168911
+ sig { returns(String) }
168912
+ def type; end
168913
+ sig { params(_type: String).returns(String) }
168914
+ def type=(_type); end
168915
+ sig {
168916
+ params(relative: T.nilable(ProductCatalog::TrialOfferCreateParams::Duration::Relative), type: String).void
168917
+ }
168918
+ def initialize(relative: nil, type: nil); end
168919
+ end
168920
+ class EndBehavior < ::Stripe::RequestParams
168921
+ class Transition < ::Stripe::RequestParams
168922
+ # The price to transition the recurring item to when the trial offer ends.
168923
+ sig { returns(String) }
168924
+ def price; end
168925
+ sig { params(_price: String).returns(String) }
168926
+ def price=(_price); end
168927
+ sig { params(price: String).void }
168928
+ def initialize(price: nil); end
168929
+ end
168930
+ # The transition to apply when the trial offer ends.
168931
+ sig { returns(ProductCatalog::TrialOfferCreateParams::EndBehavior::Transition) }
168932
+ def transition; end
168933
+ sig {
168934
+ params(_transition: ProductCatalog::TrialOfferCreateParams::EndBehavior::Transition).returns(ProductCatalog::TrialOfferCreateParams::EndBehavior::Transition)
168935
+ }
168936
+ def transition=(_transition); end
168937
+ sig {
168938
+ params(transition: ProductCatalog::TrialOfferCreateParams::EndBehavior::Transition).void
168939
+ }
168940
+ def initialize(transition: nil); end
168941
+ end
168942
+ # Duration of one service period of the trial.
168943
+ sig { returns(ProductCatalog::TrialOfferCreateParams::Duration) }
168944
+ def duration; end
168945
+ sig {
168946
+ params(_duration: ProductCatalog::TrialOfferCreateParams::Duration).returns(ProductCatalog::TrialOfferCreateParams::Duration)
168947
+ }
168948
+ def duration=(_duration); end
168949
+ # Define behavior that occurs at the end of the trial.
168950
+ sig { returns(ProductCatalog::TrialOfferCreateParams::EndBehavior) }
168951
+ def end_behavior; end
168952
+ sig {
168953
+ params(_end_behavior: ProductCatalog::TrialOfferCreateParams::EndBehavior).returns(ProductCatalog::TrialOfferCreateParams::EndBehavior)
168954
+ }
168955
+ def end_behavior=(_end_behavior); end
168956
+ # Specifies which fields in the response should be expanded.
168957
+ sig { returns(T.nilable(T::Array[String])) }
168958
+ def expand; end
168959
+ sig { params(_expand: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
168960
+ def expand=(_expand); end
168961
+ # Price configuration during the trial period (amount, billing scheme, etc).
168962
+ sig { returns(String) }
168963
+ def price; end
168964
+ sig { params(_price: String).returns(String) }
168965
+ def price=(_price); end
168966
+ sig {
168967
+ params(duration: ProductCatalog::TrialOfferCreateParams::Duration, end_behavior: ProductCatalog::TrialOfferCreateParams::EndBehavior, expand: T.nilable(T::Array[String]), price: String).void
168968
+ }
168969
+ def initialize(duration: nil, end_behavior: nil, expand: nil, price: nil); end
168970
+ end
168971
+ end
168972
+ end
168973
+ # typed: true
168645
168974
  module Stripe
168646
168975
  class ProductDeleteParams < ::Stripe::RequestParams; end
168647
168976
  end
@@ -198213,12 +198542,12 @@ module Stripe
198213
198542
  ); end
198214
198543
  end
198215
198544
  class SelfReportedIncome < ::Stripe::RequestParams
198216
- # Attribute for param field amount
198545
+ # The amount in the minor currency unit (for example, cents for USD).
198217
198546
  sig { returns(Integer) }
198218
198547
  def amount; end
198219
198548
  sig { params(_amount: Integer).returns(Integer) }
198220
198549
  def amount=(_amount); end
198221
- # Attribute for param field currency
198550
+ # 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).
198222
198551
  sig { returns(String) }
198223
198552
  def currency; end
198224
198553
  sig { params(_currency: String).returns(String) }
@@ -198227,12 +198556,12 @@ module Stripe
198227
198556
  def initialize(amount: nil, currency: nil); end
198228
198557
  end
198229
198558
  class SelfReportedMonthlyHousingPayment < ::Stripe::RequestParams
198230
- # Attribute for param field amount
198559
+ # The amount in the minor currency unit (for example, cents for USD).
198231
198560
  sig { returns(Integer) }
198232
198561
  def amount; end
198233
198562
  sig { params(_amount: Integer).returns(Integer) }
198234
198563
  def amount=(_amount); end
198235
- # Attribute for param field currency
198564
+ # 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).
198236
198565
  sig { returns(String) }
198237
198566
  def currency; end
198238
198567
  sig { params(_currency: String).returns(String) }
@@ -199014,12 +199343,12 @@ module Stripe
199014
199343
  ); end
199015
199344
  end
199016
199345
  class SelfReportedIncome < ::Stripe::RequestParams
199017
- # Attribute for param field amount
199346
+ # The amount in the minor currency unit (for example, cents for USD).
199018
199347
  sig { returns(Integer) }
199019
199348
  def amount; end
199020
199349
  sig { params(_amount: Integer).returns(Integer) }
199021
199350
  def amount=(_amount); end
199022
- # Attribute for param field currency
199351
+ # 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).
199023
199352
  sig { returns(String) }
199024
199353
  def currency; end
199025
199354
  sig { params(_currency: String).returns(String) }
@@ -199028,12 +199357,12 @@ module Stripe
199028
199357
  def initialize(amount: nil, currency: nil); end
199029
199358
  end
199030
199359
  class SelfReportedMonthlyHousingPayment < ::Stripe::RequestParams
199031
- # Attribute for param field amount
199360
+ # The amount in the minor currency unit (for example, cents for USD).
199032
199361
  sig { returns(Integer) }
199033
199362
  def amount; end
199034
199363
  sig { params(_amount: Integer).returns(Integer) }
199035
199364
  def amount=(_amount); end
199036
- # Attribute for param field currency
199365
+ # 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).
199037
199366
  sig { returns(String) }
199038
199367
  def currency; end
199039
199368
  sig { params(_currency: String).returns(String) }
@@ -203708,12 +204037,12 @@ module Stripe
203708
204037
  ); end
203709
204038
  end
203710
204039
  class SelfReportedIncome < ::Stripe::RequestParams
203711
- # Attribute for param field amount
204040
+ # The amount in the minor currency unit (for example, cents for USD).
203712
204041
  sig { returns(Integer) }
203713
204042
  def amount; end
203714
204043
  sig { params(_amount: Integer).returns(Integer) }
203715
204044
  def amount=(_amount); end
203716
- # Attribute for param field currency
204045
+ # 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).
203717
204046
  sig { returns(String) }
203718
204047
  def currency; end
203719
204048
  sig { params(_currency: String).returns(String) }
@@ -203722,12 +204051,12 @@ module Stripe
203722
204051
  def initialize(amount: nil, currency: nil); end
203723
204052
  end
203724
204053
  class SelfReportedMonthlyHousingPayment < ::Stripe::RequestParams
203725
- # Attribute for param field amount
204054
+ # The amount in the minor currency unit (for example, cents for USD).
203726
204055
  sig { returns(Integer) }
203727
204056
  def amount; end
203728
204057
  sig { params(_amount: Integer).returns(Integer) }
203729
204058
  def amount=(_amount); end
203730
- # Attribute for param field currency
204059
+ # 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).
203731
204060
  sig { returns(String) }
203732
204061
  def currency; end
203733
204062
  sig { params(_currency: String).returns(String) }
@@ -204496,12 +204825,12 @@ module Stripe
204496
204825
  ); end
204497
204826
  end
204498
204827
  class SelfReportedIncome < ::Stripe::RequestParams
204499
- # Attribute for param field amount
204828
+ # The amount in the minor currency unit (for example, cents for USD).
204500
204829
  sig { returns(Integer) }
204501
204830
  def amount; end
204502
204831
  sig { params(_amount: Integer).returns(Integer) }
204503
204832
  def amount=(_amount); end
204504
- # Attribute for param field currency
204833
+ # 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).
204505
204834
  sig { returns(String) }
204506
204835
  def currency; end
204507
204836
  sig { params(_currency: String).returns(String) }
@@ -204510,12 +204839,12 @@ module Stripe
204510
204839
  def initialize(amount: nil, currency: nil); end
204511
204840
  end
204512
204841
  class SelfReportedMonthlyHousingPayment < ::Stripe::RequestParams
204513
- # Attribute for param field amount
204842
+ # The amount in the minor currency unit (for example, cents for USD).
204514
204843
  sig { returns(Integer) }
204515
204844
  def amount; end
204516
204845
  sig { params(_amount: Integer).returns(Integer) }
204517
204846
  def amount=(_amount); end
204518
- # Attribute for param field currency
204847
+ # 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).
204519
204848
  sig { returns(String) }
204520
204849
  def currency; end
204521
204850
  sig { params(_currency: String).returns(String) }
@@ -232779,6 +233108,11 @@ module Stripe
232779
233108
  params(_created: T.nilable(V2::Core::EventListParams::Created)).returns(T.nilable(V2::Core::EventListParams::Created))
232780
233109
  }
232781
233110
  def created=(_created); end
233111
+ # Additional fields to include in the response.
233112
+ sig { returns(T.nilable(T::Array[String])) }
233113
+ def include; end
233114
+ sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
233115
+ def include=(_include); end
232782
233116
  # The page size.
232783
233117
  sig { returns(T.nilable(Integer)) }
232784
233118
  def limit; end
@@ -232797,9 +233131,9 @@ module Stripe
232797
233131
  sig { params(_types: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
232798
233132
  def types=(_types); end
232799
233133
  sig {
232800
- params(created: T.nilable(V2::Core::EventListParams::Created), limit: T.nilable(Integer), object_id_: T.nilable(String), types: T.nilable(T::Array[String])).void
233134
+ params(created: T.nilable(V2::Core::EventListParams::Created), include: T.nilable(T::Array[String]), limit: T.nilable(Integer), object_id_: T.nilable(String), types: T.nilable(T::Array[String])).void
232801
233135
  }
232802
- def initialize(created: nil, limit: nil, object_id_: nil, types: nil); end
233136
+ def initialize(created: nil, include: nil, limit: nil, object_id_: nil, types: nil); end
232803
233137
  end
232804
233138
  end
232805
233139
  end
@@ -232808,7 +233142,15 @@ end
232808
233142
  module Stripe
232809
233143
  module V2
232810
233144
  module Core
232811
- class EventRetrieveParams < ::Stripe::RequestParams; end
233145
+ class EventRetrieveParams < ::Stripe::RequestParams
233146
+ # Additional fields to include in the response.
233147
+ sig { returns(T.nilable(T::Array[String])) }
233148
+ def include; end
233149
+ sig { params(_include: T.nilable(T::Array[String])).returns(T.nilable(T::Array[String])) }
233150
+ def include=(_include); end
233151
+ sig { params(include: T.nilable(T::Array[String])).void }
233152
+ def initialize(include: nil); end
233153
+ end
232812
233154
  end
232813
233155
  end
232814
233156
  end