stripe 19.4.0.pre.alpha.2 → 19.4.0.pre.alpha.4

data/lib/stripe/params/checkout/session_create_params.rb

@@ -2859,7 +2859,7 @@ module Stripe
         end
         # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
         attr_accessor :application_fee_percent
-        # A future timestamp to anchor the subscription's billing cycle for new subscriptions. You can't set this parameter if `ui_mode` is `elements`.
+        # A future timestamp to anchor the subscription's billing cycle for new subscriptions.
         attr_accessor :billing_cycle_anchor
         # Configures when the subscription schedule's billing cycle anchors to a specific day of the week or month.
         attr_accessor :billing_cycle_anchor_config

data/lib/stripe/params/invoice_create_preview_params.rb

@@ -1812,7 +1812,7 @@ module Stripe
         attr_accessor :pause_collection
         # Controls whether the subscription schedule should create [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when transitioning to this phase if there is a difference in billing configuration. It's different from the request-level [proration_behavior](https://docs.stripe.com/api/subscription_schedules/update#update_subscription_schedule-proration_behavior) parameter which controls what happens if the update request affects the billing configuration (item price, quantity, etc.) of the current phase.
         attr_accessor :proration_behavior
-        # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
+        # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase. Prefer to specify `now` over an explicit timestamp when appropriate to avoid unexpected behavior due to request delays or clock skew resulting in the phase being slightly backdated or postdated.
         attr_accessor :start_date
         # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
         attr_accessor :transfer_data
@@ -1820,7 +1820,7 @@ module Stripe
         attr_accessor :trial
         # Specify trial behavior when crossing phase boundaries
         attr_accessor :trial_continuation
-        # Sets the phase to trialing from the start date to this date. Must be before the phase end date, can not be combined with `trial`
+        # Sets the phase to trialing from the start date to this date. Must be within the phase. When previewing an update, if combined with `trial=true`, it must match the phase end date.
         attr_accessor :trial_end
         # Settings related to subscription trials.
         attr_accessor :trial_settings

data/lib/stripe/params/issuing/authorization_capture_params.rb

@@ -44,7 +44,7 @@ module Stripe
 
           class ReportedBreakdown < ::Stripe::RequestParams
             class Fuel < ::Stripe::RequestParams
-              # Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+              # Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.
               attr_accessor :gross_amount_decimal
 
               def initialize(gross_amount_decimal: nil)

data/lib/stripe/params/issuing/authorization_create_params.rb

@@ -46,7 +46,7 @@ module Stripe
 
         class ReportedBreakdown < ::Stripe::RequestParams
           class Fuel < ::Stripe::RequestParams
-            # Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+            # Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.
             attr_accessor :gross_amount_decimal
 
             def initialize(gross_amount_decimal: nil)

data/lib/stripe/params/issuing/authorization_finalize_amount_params.rb

@@ -34,7 +34,7 @@ module Stripe
 
         class ReportedBreakdown < ::Stripe::RequestParams
           class Fuel < ::Stripe::RequestParams
-            # Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+            # Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.
             attr_accessor :gross_amount_decimal
 
             def initialize(gross_amount_decimal: nil)

data/lib/stripe/params/issuing/transaction_create_force_capture_params.rb

@@ -95,7 +95,7 @@ module Stripe
 
           class ReportedBreakdown < ::Stripe::RequestParams
             class Fuel < ::Stripe::RequestParams
-              # Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+              # Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.
               attr_accessor :gross_amount_decimal
 
               def initialize(gross_amount_decimal: nil)

data/lib/stripe/params/issuing/transaction_create_unlinked_refund_params.rb

@@ -86,7 +86,7 @@ module Stripe
 
           class ReportedBreakdown < ::Stripe::RequestParams
             class Fuel < ::Stripe::RequestParams
-              # Gross fuel amount that should equal Fuel Volume multipled by Fuel Unit Cost, inclusive of taxes.
+              # Gross fuel amount that should equal Fuel Volume multiplied by Fuel Unit Cost, inclusive of taxes.
               attr_accessor :gross_amount_decimal
 
               def initialize(gross_amount_decimal: nil)

data/lib/stripe/params/payment_intent_confirm_params.rb

@@ -5377,9 +5377,18 @@ module Stripe
         #
         # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
         attr_accessor :capture_method
+        # Indicates that you intend to make future payments with this PaymentIntent's payment method.
+        #
+        # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
+        #
+        # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
+        #
+        # 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).
+        attr_accessor :setup_future_usage
 
-        def initialize(capture_method: nil)
+        def initialize(capture_method: nil, setup_future_usage: nil)
           @capture_method = capture_method
+          @setup_future_usage = setup_future_usage
         end
       end
 

data/lib/stripe/params/payment_intent_create_params.rb

@@ -5391,9 +5391,18 @@ module Stripe
         #
         # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
         attr_accessor :capture_method
+        # Indicates that you intend to make future payments with this PaymentIntent's payment method.
+        #
+        # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
+        #
+        # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
+        #
+        # 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).
+        attr_accessor :setup_future_usage
 
-        def initialize(capture_method: nil)
+        def initialize(capture_method: nil, setup_future_usage: nil)
           @capture_method = capture_method
+          @setup_future_usage = setup_future_usage
         end
       end
 

data/lib/stripe/params/payment_intent_update_params.rb

@@ -5369,9 +5369,18 @@ module Stripe
         #
         # If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter unsets the stored value for this payment method type.
         attr_accessor :capture_method
+        # Indicates that you intend to make future payments with this PaymentIntent's payment method.
+        #
+        # If you provide a Customer with the PaymentIntent, you can use this parameter to [attach the payment method](/payments/save-during-payment) to the Customer after the PaymentIntent is confirmed and the customer completes any required actions. If you don't provide a Customer, you can still [attach](/api/payment_methods/attach) the payment method to a Customer after the transaction completes.
+        #
+        # If the payment method is `card_present` and isn't a digital wallet, Stripe creates and attaches a [generated_card](/api/charges/object#charge_object-payment_method_details-card_present-generated_card) payment method representing the card to the Customer instead.
+        #
+        # 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).
+        attr_accessor :setup_future_usage
 
-        def initialize(capture_method: nil)
+        def initialize(capture_method: nil, setup_future_usage: nil)
           @capture_method = capture_method
+          @setup_future_usage = setup_future_usage
         end
       end
 

data/lib/stripe/params/payment_record_create_params.rb

@@ -0,0 +1,109 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class PaymentRecordCreateParams < ::Stripe::RequestParams
+    class Amount < ::Stripe::RequestParams
+      # 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).
+      attr_accessor :currency
+      # A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+      attr_accessor :value
+
+      def initialize(currency: nil, value: nil)
+        @currency = currency
+        @value = value
+      end
+    end
+
+    class Closed < ::Stripe::RequestParams
+      # When the dispute was closed. Measured in seconds since the Unix epoch.
+      attr_accessor :closed_at
+
+      def initialize(closed_at: nil)
+        @closed_at = closed_at
+      end
+    end
+
+    class Funded < ::Stripe::RequestParams
+      class Amount < ::Stripe::RequestParams
+        # 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).
+        attr_accessor :currency
+        # A positive integer representing the amount in the currency's [minor unit](https://docs.stripe.com/currencies#zero-decimal). For example, `100` can represent 1 USD or 100 JPY.
+        attr_accessor :value
+
+        def initialize(currency: nil, value: nil)
+          @currency = currency
+          @value = value
+        end
+      end
+      # The amount that has been lost to the customer due to disputes on this payment.
+      attr_accessor :amount
+      # When the dispute funding event occurred. Measured in seconds since the Unix epoch.
+      attr_accessor :funded_at
+      # The type of dispute funding event.
+      attr_accessor :type
+
+      def initialize(amount: nil, funded_at: nil, type: nil)
+        @amount = amount
+        @funded_at = funded_at
+        @type = type
+      end
+    end
+
+    class ProcessorDetails < ::Stripe::RequestParams
+      class Custom < ::Stripe::RequestParams
+        # A reference to the external dispute. This field must be unique across all disputes.
+        attr_accessor :dispute_reference
+
+        def initialize(dispute_reference: nil)
+          @dispute_reference = dispute_reference
+        end
+      end
+      # Information about the custom processor used to make this payment.
+      attr_accessor :custom
+      # The type of the processor details. An additional hash is included on processor_details with a name matching this value. It contains additional information specific to the processor.
+      attr_accessor :type
+
+      def initialize(custom: nil, type: nil)
+        @custom = custom
+        @type = type
+      end
+    end
+    # The amount that has been lost to the customer due to disputes on this payment.
+    attr_accessor :amount
+    # Information about the dispute closing.
+    attr_accessor :closed
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+    # Information about the dispute funding event.
+    attr_accessor :funded
+    # When the reported payment was initiated. Measured in seconds since the Unix epoch.
+    attr_accessor :initiated_at
+    # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+    attr_accessor :metadata
+    # Processor information for this payment.
+    attr_accessor :processor_details
+    # The reason the payment was disputed.
+    attr_accessor :reason
+
+    def initialize(
+      amount: nil,
+      closed: nil,
+      expand: nil,
+      funded: nil,
+      initiated_at: nil,
+      metadata: nil,
+      processor_details: nil,
+      reason: nil
+    )
+      @amount = amount
+      @closed = closed
+      @expand = expand
+      @funded = funded
+      @initiated_at = initiated_at
+      @metadata = metadata
+      @processor_details = processor_details
+      @reason = reason
+    end
+  end
+end

data/lib/stripe/params/promotion_code_create_params.rb

@@ -24,7 +24,7 @@ module Stripe
           @minimum_amount = minimum_amount
         end
       end
-      # Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+      # Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). Each currency must be different from the `minimum_amount_currency` set on the promotion code.
       attr_accessor :currency_options
       # A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices
       attr_accessor :first_time_transaction

data/lib/stripe/params/promotion_code_update_params.rb

@@ -12,7 +12,7 @@ module Stripe
           @minimum_amount = minimum_amount
         end
       end
-      # Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+      # Promotion codes defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies). Each currency must be different from the `minimum_amount_currency` set on the promotion code.
       attr_accessor :currency_options
 
       def initialize(currency_options: nil)

data/lib/stripe/params/refund_create_params.rb

@@ -23,6 +23,8 @@ module Stripe
     attr_accessor :payment_attempt_record
     # The identifier of the PaymentIntent to refund.
     attr_accessor :payment_intent
+    # The identifier of the PaymentRecord to refund.
+    attr_accessor :payment_record
     # String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://docs.stripe.com/radar/lists), and will also help us improve our fraud detection algorithms.
     attr_accessor :reason
     # Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge.
@@ -41,6 +43,7 @@ module Stripe
       origin: nil,
       payment_attempt_record: nil,
       payment_intent: nil,
+      payment_record: nil,
       reason: nil,
       refund_application_fee: nil,
       reverse_transfer: nil
@@ -55,6 +58,7 @@ module Stripe
       @origin = origin
       @payment_attempt_record = payment_attempt_record
       @payment_intent = payment_intent
+      @payment_record = payment_record
       @reason = reason
       @refund_application_fee = refund_application_fee
       @reverse_transfer = reverse_transfer

data/lib/stripe/params/subscription_schedule_create_params.rb

@@ -198,6 +198,138 @@ module Stripe
       end
     end
 
+    class PauseSchedule < ::Stripe::RequestParams
+      class Pause < ::Stripe::RequestParams
+        class PauseAt < ::Stripe::RequestParams
+          # The Unix timestamp at which to pause the subscription. Required when `type` is `timestamp`.
+          attr_accessor :timestamp
+          # When to pause the subscription. Use `now` to pause immediately or `timestamp` to pause at a specific time.
+          attr_accessor :type
+
+          def initialize(timestamp: nil, type: nil)
+            @timestamp = timestamp
+            @type = type
+          end
+        end
+
+        class Settings < ::Stripe::RequestParams
+          class BillFor < ::Stripe::RequestParams
+            class OutstandingUsageThrough < ::Stripe::RequestParams
+              # Determines whether to collect metered usage accrued up to the pause date.
+              attr_accessor :type
+
+              def initialize(type: nil)
+                @type = type
+              end
+            end
+
+            class UnusedTimeFrom < ::Stripe::RequestParams
+              # Determines which point in the billing period unused time is credited from.
+              attr_accessor :type
+
+              def initialize(type: nil)
+                @type = type
+              end
+            end
+            # Controls whether to collect metered usage accrued up to the pause date.
+            attr_accessor :outstanding_usage_through
+            # Controls how unused time on subscription items is credited when pausing.
+            attr_accessor :unused_time_from
+
+            def initialize(outstanding_usage_through: nil, unused_time_from: nil)
+              @outstanding_usage_through = outstanding_usage_through
+              @unused_time_from = unused_time_from
+            end
+          end
+          # Controls what to bill for when pausing the subscription.
+          attr_accessor :bill_for
+          # Determines whether to generate an invoice for outstanding amounts when pausing.
+          attr_accessor :invoicing_behavior
+          # The pause type. Currently only `subscription` is supported.
+          attr_accessor :type
+
+          def initialize(bill_for: nil, invoicing_behavior: nil, type: nil)
+            @bill_for = bill_for
+            @invoicing_behavior = invoicing_behavior
+            @type = type
+          end
+        end
+        # When to pause the subscription.
+        attr_accessor :pause_at
+        # Settings controlling billing behavior during the pause.
+        attr_accessor :settings
+
+        def initialize(pause_at: nil, settings: nil)
+          @pause_at = pause_at
+          @settings = settings
+        end
+      end
+
+      class Resume < ::Stripe::RequestParams
+        class ResumeAt < ::Stripe::RequestParams
+          class Duration < ::Stripe::RequestParams
+            # The time unit for the resume duration. One of `day`, `week`, `month`, or `year`.
+            attr_accessor :interval
+            # The number of intervals after which the subscription resumes.
+            attr_accessor :interval_count
+
+            def initialize(interval: nil, interval_count: nil)
+              @interval = interval
+              @interval_count = interval_count
+            end
+          end
+          # The duration after which to resume the subscription. Required when `type` is `duration`.
+          attr_accessor :duration
+          # The Unix timestamp at which to resume the subscription. Required when `type` is `timestamp`.
+          attr_accessor :timestamp
+          # When to resume the subscription. Use `now` to resume immediately, `duration` to resume after a set duration, or `timestamp` to resume at a specific time.
+          attr_accessor :type
+
+          def initialize(duration: nil, timestamp: nil, type: nil)
+            @duration = duration
+            @timestamp = timestamp
+            @type = type
+          end
+        end
+
+        class Settings < ::Stripe::RequestParams
+          # Controls the billing cycle anchor when the subscription resumes.
+          attr_accessor :billing_cycle_anchor
+          # Controls whether Stripe attempts payment on the resumption invoice and how payment affects the subscription's status. The default is `resume_on_payment_attempt`.
+          attr_accessor :payment_behavior
+          # Determines how to handle prorations when the subscription resumes. The default is `create_prorations`.
+          attr_accessor :proration_behavior
+
+          def initialize(billing_cycle_anchor: nil, payment_behavior: nil, proration_behavior: nil)
+            @billing_cycle_anchor = billing_cycle_anchor
+            @payment_behavior = payment_behavior
+            @proration_behavior = proration_behavior
+          end
+        end
+        # When to resume the subscription.
+        attr_accessor :resume_at
+        # Settings controlling how the subscription resumes.
+        attr_accessor :settings
+
+        def initialize(resume_at: nil, settings: nil)
+          @resume_at = resume_at
+          @settings = settings
+        end
+      end
+      # A unique identifier for this pause schedule entry.
+      attr_accessor :key
+      # Configuration for when and how the subscription pauses.
+      attr_accessor :pause
+      # Configuration for when and how the subscription resumes.
+      attr_accessor :resume
+
+      def initialize(key: nil, pause: nil, resume: nil)
+        @key = key
+        @pause = pause
+        @resume = resume
+      end
+    end
+
     class Phase < ::Stripe::RequestParams
       class AddInvoiceItem < ::Stripe::RequestParams
         class Discount < ::Stripe::RequestParams
@@ -508,7 +640,7 @@ module Stripe
         end
         # The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
         attr_accessor :account_tax_ids
-        # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`.
+        # Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `collection_method=charge_automatically`.
         attr_accessor :days_until_due
         # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
         attr_accessor :issuer
@@ -927,11 +1059,13 @@ module Stripe
     attr_accessor :from_subscription
     # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
     attr_accessor :metadata
+    # Sets the pause schedules for the subscription schedule. Each entry configures when and how the subscription pauses and optionally when and how it resumes.
+    attr_accessor :pause_schedules
     # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
     attr_accessor :phases
     # If specified, the invoicing for the given billing cycle iterations will be processed now.
     attr_accessor :prebilling
-    # When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
+    # When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately, and to avoid unexpected behavior due to request delays or clock skew resulting in a slightly backdated or postdated start. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
     attr_accessor :start_date
 
     def initialize(
@@ -945,6 +1079,7 @@ module Stripe
       expand: nil,
       from_subscription: nil,
       metadata: nil,
+      pause_schedules: nil,
       phases: nil,
       prebilling: nil,
       start_date: nil
@@ -959,6 +1094,7 @@ module Stripe
       @expand = expand
       @from_subscription = from_subscription
       @metadata = metadata
+      @pause_schedules = pause_schedules
       @phases = phases
       @prebilling = prebilling
       @start_date = start_date

data/lib/stripe/params/subscription_schedule_list_params.rb

@@ -80,7 +80,7 @@ module Stripe
     attr_accessor :completed_at
     # Only return subscription schedules that were created during the given date interval.
     attr_accessor :created
-    # Only return subscription schedules for the given customer.
+    # Only return subscription schedules for the given customer. The response will not include subscription schedules for customers with a test clock attached if this parameter is not set.
     attr_accessor :customer
     # Only return subscription schedules for the given account.
     attr_accessor :customer_account