stripe 18.1.0.pre.alpha.4 → 18.2.0.pre.alpha.1

data/lib/stripe/params/treasury/received_debit_create_params.rb

@@ -61,7 +61,7 @@ module Stripe
       attr_accessor :financial_account
       # Initiating payment method details for the object.
       attr_accessor :initiating_payment_method_details
-      # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
+      # Specifies the network rails to be used. If not set, will default to the PaymentMethod's preferred network. See the [docs](https://docs.stripe.com/treasury/money-movement/timelines) to learn more about money movement timelines for each network type.
       attr_accessor :network
       # Details about the network used for the ReceivedDebit.
       attr_accessor :network_details

data/lib/stripe/params/v2/billing/intent_create_params.rb

@@ -52,15 +52,6 @@ module Stripe
           end
 
           class Deactivate < ::Stripe::RequestParams
-            class BillingDetails < ::Stripe::RequestParams
-              # This controls the proration adjustment for the partial servicing period.
-              attr_accessor :proration_behavior
-
-              def initialize(proration_behavior: nil)
-                @proration_behavior = proration_behavior
-              end
-            end
-
             class EffectiveAt < ::Stripe::RequestParams
               # The timestamp at which the deactivate action will take effect. Only present if type is timestamp.
               attr_accessor :timestamp
@@ -74,15 +65,45 @@ module Stripe
             end
 
             class PricingPlanSubscriptionDetails < ::Stripe::RequestParams
+              class Overrides < ::Stripe::RequestParams
+                class PartialPeriodBehavior < ::Stripe::RequestParams
+                  class LicenseFee < ::Stripe::RequestParams
+                    # The proration behavior for the partial servicing period. Defines how we prorate the license fee when the user is deactivating.
+                    attr_accessor :credit_proration_behavior
+
+                    def initialize(credit_proration_behavior: nil)
+                      @credit_proration_behavior = credit_proration_behavior
+                    end
+                  end
+                  # Type of the partial period behavior override.
+                  attr_accessor :type
+                  # Override for the license fee.
+                  attr_accessor :license_fee
+
+                  def initialize(type: nil, license_fee: nil)
+                    @type = type
+                    @license_fee = license_fee
+                  end
+                end
+                # Override for the partial period behavior.
+                attr_accessor :partial_period_behaviors
+
+                def initialize(partial_period_behaviors: nil)
+                  @partial_period_behaviors = partial_period_behaviors
+                end
+              end
+              # Allows users to override the partial period behavior.
+              attr_accessor :overrides
               # ID of the pricing plan subscription to deactivate.
               attr_accessor :pricing_plan_subscription
 
-              def initialize(pricing_plan_subscription: nil)
+              def initialize(overrides: nil, pricing_plan_subscription: nil)
+                @overrides = overrides
                 @pricing_plan_subscription = pricing_plan_subscription
               end
             end
-            # Configuration for the billing details.
-            attr_accessor :billing_details
+            # Allows users to override the collect at behavior.
+            attr_accessor :collect_at
             # When the deactivate action will take effect. If not specified, the default behavior is on_reserve.
             attr_accessor :effective_at
             # Details for deactivating a pricing plan subscription.
@@ -91,12 +112,12 @@ module Stripe
             attr_accessor :type
 
             def initialize(
-              billing_details: nil,
+              collect_at: nil,
               effective_at: nil,
               pricing_plan_subscription_details: nil,
               type: nil
             )
-              @billing_details = billing_details
+              @collect_at = collect_at
               @effective_at = effective_at
               @pricing_plan_subscription_details = pricing_plan_subscription_details
               @type = type
@@ -104,15 +125,6 @@ module Stripe
           end
 
           class Modify < ::Stripe::RequestParams
-            class BillingDetails < ::Stripe::RequestParams
-              # This controls the proration adjustment for the partial servicing period.
-              attr_accessor :proration_behavior
-
-              def initialize(proration_behavior: nil)
-                @proration_behavior = proration_behavior
-              end
-            end
-
             class EffectiveAt < ::Stripe::RequestParams
               # The timestamp at which the modify action will take effect. Only present if type is timestamp.
               attr_accessor :timestamp
@@ -140,12 +152,45 @@ module Stripe
                   @pricing_plan_component = pricing_plan_component
                 end
               end
+
+              class Overrides < ::Stripe::RequestParams
+                class PartialPeriodBehavior < ::Stripe::RequestParams
+                  class LicenseFee < ::Stripe::RequestParams
+                    # The proration behavior for the partial servicing period. Defines how we prorate the license fee when the user is upgrading.
+                    attr_accessor :credit_proration_behavior
+                    # The proration behavior for the partial servicing period. Defines how we prorate the license fee when the user is downgrading.
+                    attr_accessor :debit_proration_behavior
+
+                    def initialize(credit_proration_behavior: nil, debit_proration_behavior: nil)
+                      @credit_proration_behavior = credit_proration_behavior
+                      @debit_proration_behavior = debit_proration_behavior
+                    end
+                  end
+                  # Type of the partial period behavior override.
+                  attr_accessor :type
+                  # Override for the license fee.
+                  attr_accessor :license_fee
+
+                  def initialize(type: nil, license_fee: nil)
+                    @type = type
+                    @license_fee = license_fee
+                  end
+                end
+                # Override for the partial period behavior.
+                attr_accessor :partial_period_behaviors
+
+                def initialize(partial_period_behaviors: nil)
+                  @partial_period_behaviors = partial_period_behaviors
+                end
+              end
               # New configurations for the components of the pricing plan.
               attr_accessor :component_configurations
               # The ID of the new Pricing Plan, if changing plans.
               attr_accessor :new_pricing_plan
               # The ID of the new Pricing Plan Version to use.
               attr_accessor :new_pricing_plan_version
+              # Allows users to override the partial period behavior.
+              attr_accessor :overrides
               # The ID of the Pricing Plan Subscription to modify.
               attr_accessor :pricing_plan_subscription
 
@@ -153,16 +198,18 @@ module Stripe
                 component_configurations: nil,
                 new_pricing_plan: nil,
                 new_pricing_plan_version: nil,
+                overrides: nil,
                 pricing_plan_subscription: nil
               )
                 @component_configurations = component_configurations
                 @new_pricing_plan = new_pricing_plan
                 @new_pricing_plan_version = new_pricing_plan_version
+                @overrides = overrides
                 @pricing_plan_subscription = pricing_plan_subscription
               end
             end
-            # Configuration for the billing details.
-            attr_accessor :billing_details
+            # Allows users to override the collect at behavior.
+            attr_accessor :collect_at
             # When the modify action will take effect. If not specified, the default behavior is on_reserve.
             attr_accessor :effective_at
             # Details for modifying a pricing plan subscription.
@@ -171,12 +218,12 @@ module Stripe
             attr_accessor :type
 
             def initialize(
-              billing_details: nil,
+              collect_at: nil,
               effective_at: nil,
               pricing_plan_subscription_details: nil,
               type: nil
             )
-              @billing_details = billing_details
+              @collect_at = collect_at
               @effective_at = effective_at
               @pricing_plan_subscription_details = pricing_plan_subscription_details
               @type = type
@@ -196,15 +243,6 @@ module Stripe
           end
 
           class Subscribe < ::Stripe::RequestParams
-            class BillingDetails < ::Stripe::RequestParams
-              # This controls the proration adjustment for the partial servicing period.
-              attr_accessor :proration_behavior
-
-              def initialize(proration_behavior: nil)
-                @proration_behavior = proration_behavior
-              end
-            end
-
             class EffectiveAt < ::Stripe::RequestParams
               # The timestamp at which the subscribe action will take effect. Only present if type is timestamp.
               attr_accessor :timestamp
@@ -232,10 +270,40 @@ module Stripe
                   @pricing_plan_component = pricing_plan_component
                 end
               end
+
+              class Overrides < ::Stripe::RequestParams
+                class PartialPeriodBehavior < ::Stripe::RequestParams
+                  class LicenseFee < ::Stripe::RequestParams
+                    # The proration behavior for the partial servicing period. Defines how we prorate the license fee when the user is subscribing.
+                    attr_accessor :debit_proration_behavior
+
+                    def initialize(debit_proration_behavior: nil)
+                      @debit_proration_behavior = debit_proration_behavior
+                    end
+                  end
+                  # Type of the partial period behavior override.
+                  attr_accessor :type
+                  # Override for the license fee.
+                  attr_accessor :license_fee
+
+                  def initialize(type: nil, license_fee: nil)
+                    @type = type
+                    @license_fee = license_fee
+                  end
+                end
+                # Override for the partial period behavior.
+                attr_accessor :partial_period_behaviors
+
+                def initialize(partial_period_behaviors: nil)
+                  @partial_period_behaviors = partial_period_behaviors
+                end
+              end
               # Configurations for the components of the pricing plan.
               attr_accessor :component_configurations
               # Set of [key-value pairs](/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.
               attr_accessor :metadata
+              # Allows users to override the partial period behavior.
+              attr_accessor :overrides
               # ID of the Pricing Plan to subscribe to.
               attr_accessor :pricing_plan
               # Version of the Pricing Plan to use.
@@ -244,11 +312,13 @@ module Stripe
               def initialize(
                 component_configurations: nil,
                 metadata: nil,
+                overrides: nil,
                 pricing_plan: nil,
                 pricing_plan_version: nil
               )
                 @component_configurations = component_configurations
                 @metadata = metadata
+                @overrides = overrides
                 @pricing_plan = pricing_plan
                 @pricing_plan_version = pricing_plan_version
               end
@@ -283,8 +353,8 @@ module Stripe
                 @metadata = metadata
               end
             end
-            # Configuration for the billing details. If not specified, see the default behavior for individual attributes.
-            attr_accessor :billing_details
+            # Allows users to override the collect at behavior.
+            attr_accessor :collect_at
             # When the subscribe action will take effect. If not specified, the default behavior is on_reserve.
             attr_accessor :effective_at
             # Type of the action details.
@@ -295,13 +365,13 @@ module Stripe
             attr_accessor :v1_subscription_details
 
             def initialize(
-              billing_details: nil,
+              collect_at: nil,
               effective_at: nil,
               type: nil,
               pricing_plan_subscription_details: nil,
               v1_subscription_details: nil
             )
-              @billing_details = billing_details
+              @collect_at = collect_at
               @effective_at = effective_at
               @type = type
               @pricing_plan_subscription_details = pricing_plan_subscription_details

data/lib/stripe/params/v2/core/account_create_params.rb

@@ -174,7 +174,7 @@ module Stripe
                 end
 
                 class Rendering < ::Stripe::RequestParams
-                  # How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of exclude_tax or include_inclusive_tax. include_inclusive_tax will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. exclude_tax will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.
+                  # Indicates whether displayed line item prices and amounts on invoice PDFs include inclusive tax amounts. Must be either `include_inclusive_tax` or `exclude_tax`.
                   attr_accessor :amount_tax_display
                   # ID of the invoice rendering template to use for future invoices.
                   attr_accessor :template
@@ -186,13 +186,13 @@ module Stripe
                 end
                 # The list of up to 4 default custom fields to be displayed on invoices for this customer.
                 attr_accessor :custom_fields
-                # Default footer to be displayed on invoices for this customer.
+                # Default invoice footer.
                 attr_accessor :footer
-                # The sequence to be used on the customer's next invoice. Defaults to 1.
+                # Sequence number to use on the customer account's next invoice. Defaults to 1.
                 attr_accessor :next_sequence
-                # The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
+                # Prefix used to generate unique invoice numbers. Must be 3-12 uppercase letters or numbers.
                 attr_accessor :prefix
-                # Default options for invoice PDF rendering for this customer.
+                # Default invoice PDF rendering options.
                 attr_accessor :rendering
 
                 def initialize(
@@ -209,7 +209,7 @@ module Stripe
                   @rendering = rendering
                 end
               end
-              # Default settings used on invoices for this customer.
+              # Default invoice settings for the customer account.
               attr_accessor :invoice
 
               def initialize(invoice: nil)
@@ -306,7 +306,7 @@ module Stripe
 
           class Merchant < ::Stripe::RequestParams
             class BacsDebitPayments < ::Stripe::RequestParams
-              # Display name for Bacs debit payments.
+              # Display name for Bacs Direct Debit payments.
               attr_accessor :display_name
 
               def initialize(display_name: nil)
@@ -1025,7 +1025,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(
@@ -1072,7 +1072,7 @@ module Stripe
             attr_accessor :card_payments
             # Settings specific to Konbini payments on the account.
             attr_accessor :konbini_payments
-            # The merchant category code for the Merchant Configuration. MCCs are used to classify businesses based on the goods or services they provide.
+            # The Merchant Category Code (MCC) for the Merchant Configuration. MCCs classify businesses based on the goods or services they provide.
             attr_accessor :mcc
             # Settings for the default text that appears on statements for language variations.
             attr_accessor :script_statement_descriptor
@@ -1107,6 +1107,15 @@ module Stripe
           class Recipient < ::Stripe::RequestParams
             class Capabilities < ::Stripe::RequestParams
               class BankAccounts < ::Stripe::RequestParams
+                class Instant < ::Stripe::RequestParams
+                  # To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
+                  attr_accessor :requested
+
+                  def initialize(requested: nil)
+                    @requested = requested
+                  end
+                end
+
                 class Local < ::Stripe::RequestParams
                   # To request a new Capability for an account, pass true. There can be a delay before the requested Capability becomes active.
                   attr_accessor :requested
@@ -1124,12 +1133,15 @@ module Stripe
                     @requested = requested
                   end
                 end
+                # Enables this Account to receive OutboundPayments to linked bank accounts over real time rails.
+                attr_accessor :instant
                 # Enables this Account to receive OutboundPayments to linked bank accounts over local networks.
                 attr_accessor :local
                 # Enables this Account to receive OutboundPayments to linked bank accounts over wire.
                 attr_accessor :wire
 
-                def initialize(local: nil, wire: nil)
+                def initialize(instant: nil, local: nil, wire: nil)
+                  @instant = instant
                   @local = local
                   @wire = wire
                 end
@@ -1162,7 +1174,7 @@ module Stripe
                     @requested = requested
                   end
                 end
-                # Allows the account to receive /v1/transfers into their Stripe Balance (/v1/balance).
+                # Enables this Account to receive /v1/transfers into their Stripe Balance (/v1/balance).
                 attr_accessor :stripe_transfers
 
                 def initialize(stripe_transfers: nil)
@@ -1449,13 +1461,13 @@ module Stripe
             attr_accessor :capabilities
             # List of high-risk activities the business is involved in.
             attr_accessor :high_risk_activities
-            # An explanation of the high risk activities that the business performs.
+            # Description of the high-risk activities the business offers.
             attr_accessor :high_risk_activities_description
             # Description of the money services offered by the business.
             attr_accessor :money_services_description
-            # Does the business operate in any prohibited countries.
+            # Indicates whether the business operates in any prohibited countries.
             attr_accessor :operates_in_prohibited_countries
-            # Does the business participate in any regulated activity.
+            # Indicates whether the business participates in any regulated activity.
             attr_accessor :participates_in_regulated_activity
             # Primary purpose of the stored funds.
             attr_accessor :purpose_of_funds
@@ -1498,9 +1510,9 @@ module Stripe
           attr_accessor :card_creator
           # The Customer Configuration allows the Account to be used in inbound payment flows.
           attr_accessor :customer
-          # The Merchant configuration allows the Account to act as a connected account and collect payments facilitated by a Connect platform. You can add this configuration to your connected accounts only if you’ve completed onboarding as a Connect platform.
+          # Enables the Account to act as a connected account and collect payments facilitated by a Connect platform. You must onboard your platform to Connect before you can add this configuration to your connected accounts. Utilize this configuration when the Account will be the Merchant of Record, like with Direct charges or Destination Charges with on_behalf_of set.
           attr_accessor :merchant
-          # The Recipient Configuration allows the Account to receive funds.
+          # The Recipient Configuration allows the Account to receive funds. Utilize this configuration if the Account will not be the Merchant of Record, like with Separate Charges & Transfers, or Destination Charges without on_behalf_of set.
           attr_accessor :recipient
           # The Storer Configuration allows the Account to store and move funds using stored-value FinancialAccounts.
           attr_accessor :storer
@@ -2124,7 +2136,7 @@ module Stripe
               attr_accessor :postal_code
               # State, county, province, or region.
               attr_accessor :state
-              # Town or cho-me.
+              # Town or district.
               attr_accessor :town
 
               def initialize(
@@ -2395,7 +2407,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(
@@ -2430,7 +2442,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(
@@ -2498,7 +2510,7 @@ module Stripe
             attr_accessor :compliance_screening_description
             # A document verifying the business.
             attr_accessor :documents
-            # An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
+            # Estimated maximum number of workers currently engaged by the business (including employees, contractors, and vendors).
             attr_accessor :estimated_worker_count
             # The ID numbers of a business entity.
             attr_accessor :id_numbers
@@ -2560,7 +2572,7 @@ module Stripe
               attr_accessor :purpose
               # State, county, province, or region.
               attr_accessor :state
-              # Town or cho-me.
+              # Town or district.
               attr_accessor :town
 
               def initialize(
@@ -2615,7 +2627,7 @@ module Stripe
               attr_accessor :postal_code
               # State, county, province, or region.
               attr_accessor :state
-              # Town or cho-me.
+              # Town or district.
               attr_accessor :town
 
               def initialize(
@@ -2813,7 +2825,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(
@@ -2848,7 +2860,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(

data/lib/stripe/params/v2/core/account_link_create_params.rb

@@ -42,7 +42,7 @@ module Stripe
 
           class AccountUpdate < ::Stripe::RequestParams
             class CollectionOptions < ::Stripe::RequestParams
-              # Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don’t specify collection_options, the default value is currently_due.
+              # Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). The default value is `currently_due`.
               attr_accessor :fields
               # Specifies whether the platform collects future_requirements in addition to requirements in Connect Onboarding. The default value is `omit`.
               attr_accessor :future_requirements
@@ -56,7 +56,7 @@ module Stripe
             attr_accessor :collection_options
             # Open Enum. A v2/account can be configured to enable certain functionality. The configuration param targets the v2/account_link to collect information for the specified v2/account configuration/s.
             attr_accessor :configurations
-            # The URL the user will be redirected to if the AccountLink is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new AccountLink with the same parameters used to create the original AccountLink, then redirect the user to the new AccountLink’s URL so they can continue the flow. If a new AccountLink cannot be generated or the redirect fails you should display a useful error to the user. Please make sure to implement authentication before redirecting the user in case this URL is leaked to a third party.
+            # The URL the user will be redirected to if the Account Link is expired, has been used, or is otherwise invalid. The URL you specify should attempt to generate a new Account Link with the same parameters used to create the original Account Link, then redirect the user to the new Account Link URL so they can continue the flow. Make sure to authenticate the user before redirecting to the new Account Link, in case the URL leaks to a third party. If a new Account Link can't be generated, or if the redirect fails, you should display a useful error to the user.
             attr_accessor :refresh_url
             # The URL that the user will be redirected to upon completing the linked flow.
             attr_accessor :return_url
@@ -73,11 +73,11 @@ module Stripe
               @return_url = return_url
             end
           end
-          # Open Enum. The type of AccountLink the user is requesting.
+          # Open Enum. The type of Account Link the user is requesting.
           attr_accessor :type
-          # Indicates that the AccountLink provided should onboard an account.
+          # Hash containing configuration options for an Account Link object that onboards a new account.
           attr_accessor :account_onboarding
-          # Indicates that the AccountLink provided should update a previously onboarded account.
+          # Hash containing configuration options for an Account Link that updates an existing account.
           attr_accessor :account_update
 
           def initialize(type: nil, account_onboarding: nil, account_update: nil)

data/lib/stripe/params/v2/core/account_token_create_params.rb

@@ -357,7 +357,7 @@ module Stripe
               attr_accessor :postal_code
               # State, county, province, or region.
               attr_accessor :state
-              # Town or cho-me.
+              # Town or district.
               attr_accessor :town
 
               def initialize(
@@ -628,7 +628,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(
@@ -663,7 +663,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(
@@ -731,7 +731,7 @@ module Stripe
             attr_accessor :compliance_screening_description
             # A document verifying the business.
             attr_accessor :documents
-            # An estimated upper bound of employees, contractors, vendors, etc. currently working for the business.
+            # Estimated maximum number of workers currently engaged by the business (including employees, contractors, and vendors).
             attr_accessor :estimated_worker_count
             # The ID numbers of a business entity.
             attr_accessor :id_numbers
@@ -793,7 +793,7 @@ module Stripe
               attr_accessor :purpose
               # State, county, province, or region.
               attr_accessor :state
-              # Town or cho-me.
+              # Town or district.
               attr_accessor :town
 
               def initialize(
@@ -848,7 +848,7 @@ module Stripe
               attr_accessor :postal_code
               # State, county, province, or region.
               attr_accessor :state
-              # Town or cho-me.
+              # Town or district.
               attr_accessor :town
 
               def initialize(
@@ -1046,7 +1046,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(
@@ -1081,7 +1081,7 @@ module Stripe
                 attr_accessor :postal_code
                 # State, county, province, or region.
                 attr_accessor :state
-                # Town or cho-me.
+                # Town or district.
                 attr_accessor :town
 
                 def initialize(