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

data/lib/stripe/params/subscription_schedule_update_params.rb

@@ -178,6 +178,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
@@ -488,7 +620,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
@@ -791,7 +923,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
@@ -799,7 +931,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 combined with `trial=true`, it must match the phase end date.
       attr_accessor :trial_end
       # Settings related to subscription trials.
       attr_accessor :trial_settings
@@ -903,6 +1035,8 @@ module Stripe
     attr_accessor :expand
     # 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. Include a `key` to update an existing entry or omit it to add a new one. Pass `""` to clear all entries or `[]` to leave them unchanged.
+    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. Note that past phases can be omitted.
     attr_accessor :phases
     # If specified, the invoicing for the given billing cycle iterations will be processed now.
@@ -917,6 +1051,7 @@ module Stripe
       end_behavior: nil,
       expand: nil,
       metadata: nil,
+      pause_schedules: nil,
       phases: nil,
       prebilling: nil,
       proration_behavior: nil
@@ -927,6 +1062,7 @@ module Stripe
       @end_behavior = end_behavior
       @expand = expand
       @metadata = metadata
+      @pause_schedules = pause_schedules
       @phases = phases
       @prebilling = prebilling
       @proration_behavior = proration_behavior

data/lib/stripe/params/terminal/reader_activate_gift_card_params.rb

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderActivateGiftCardParams < ::Stripe::RequestParams
+      class Balance < ::Stripe::RequestParams
+        # The initial balance amount to be loaded when activating the gift card, in the smallest currency unit
+        attr_accessor :amount
+        # 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
+
+        def initialize(amount: nil, currency: nil)
+          @amount = amount
+          @currency = currency
+        end
+      end
+      # The initial balance to set on the gift card.
+      attr_accessor :balance
+      # The brand of the gift card.
+      attr_accessor :brand
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The Stripe account ID to process the gift card operation on behalf of.
+      attr_accessor :on_behalf_of
+
+      def initialize(balance: nil, brand: nil, expand: nil, on_behalf_of: nil)
+        @balance = balance
+        @brand = brand
+        @expand = expand
+        @on_behalf_of = on_behalf_of
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/reader_cashout_gift_card_params.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCashoutGiftCardParams < ::Stripe::RequestParams
+      # The brand of the gift card.
+      attr_accessor :brand
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The Stripe account ID to process the gift card operation on behalf of.
+      attr_accessor :on_behalf_of
+
+      def initialize(brand: nil, expand: nil, on_behalf_of: nil)
+        @brand = brand
+        @expand = expand
+        @on_behalf_of = on_behalf_of
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/reader_check_gift_card_balance_params.rb

@@ -0,0 +1,21 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderCheckGiftCardBalanceParams < ::Stripe::RequestParams
+      # The brand of the gift card.
+      attr_accessor :brand
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The Stripe account ID to process the gift card operation on behalf of.
+      attr_accessor :on_behalf_of
+
+      def initialize(brand: nil, expand: nil, on_behalf_of: nil)
+        @brand = brand
+        @expand = expand
+        @on_behalf_of = on_behalf_of
+      end
+    end
+  end
+end

data/lib/stripe/params/terminal/reader_collect_payment_method_params.rb

@@ -17,6 +17,8 @@ module Stripe
         attr_accessor :allow_redisplay
         # Enables cancel button on transaction screens.
         attr_accessor :enable_customer_cancellation
+        # The gift card brand to use in the transaction.
+        attr_accessor :gift_card_brand
         # Override showing a tipping selection screen on this transaction.
         attr_accessor :skip_tipping
         # Tipping configuration for this transaction.
@@ -25,11 +27,13 @@ module Stripe
         def initialize(
           allow_redisplay: nil,
           enable_customer_cancellation: nil,
+          gift_card_brand: nil,
           skip_tipping: nil,
           tipping: nil
         )
           @allow_redisplay = allow_redisplay
           @enable_customer_cancellation = enable_customer_cancellation
+          @gift_card_brand = gift_card_brand
           @skip_tipping = skip_tipping
           @tipping = tipping
         end

data/lib/stripe/params/terminal/reader_process_payment_intent_params.rb

@@ -17,6 +17,8 @@ module Stripe
         attr_accessor :allow_redisplay
         # Enables cancel button on transaction screens.
         attr_accessor :enable_customer_cancellation
+        # The gift card brand to use in the transaction.
+        attr_accessor :gift_card_brand
         # The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.
         attr_accessor :return_url
         # Override showing a tipping selection screen on this transaction.
@@ -27,12 +29,14 @@ module Stripe
         def initialize(
           allow_redisplay: nil,
           enable_customer_cancellation: nil,
+          gift_card_brand: nil,
           return_url: nil,
           skip_tipping: nil,
           tipping: nil
         )
           @allow_redisplay = allow_redisplay
           @enable_customer_cancellation = enable_customer_cancellation
+          @gift_card_brand = gift_card_brand
           @return_url = return_url
           @skip_tipping = skip_tipping
           @tipping = tipping

data/lib/stripe/params/terminal/reader_reload_gift_card_params.rb

@@ -0,0 +1,27 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Terminal
+    class ReaderReloadGiftCardParams < ::Stripe::RequestParams
+      # The amount to add to the gift card balance, in the smallest currency unit.
+      attr_accessor :amount
+      # The brand of the gift card.
+      attr_accessor :brand
+      # 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
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # The Stripe account ID to process the gift card operation on behalf of.
+      attr_accessor :on_behalf_of
+
+      def initialize(amount: nil, brand: nil, currency: nil, expand: nil, on_behalf_of: nil)
+        @amount = amount
+        @brand = brand
+        @currency = currency
+        @expand = expand
+        @on_behalf_of = on_behalf_of
+      end
+    end
+  end
+end

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

@@ -45,7 +45,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/test_helpers/issuing/authorization_create_params.rb

@@ -47,7 +47,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/test_helpers/issuing/authorization_finalize_amount_params.rb

@@ -35,7 +35,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/test_helpers/issuing/transaction_create_force_capture_params.rb

@@ -96,7 +96,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/test_helpers/issuing/transaction_create_unlinked_refund_params.rb

@@ -87,7 +87,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/token_create_params.rb

@@ -226,6 +226,8 @@ module Stripe
         # The category identifying the legal structure of the company or legal entity. See [Business structure](/connect/identity-verification#business-structure) for more details. Pass an empty string to unset this value.
         attr_accessor :structure
         # The business ID number of the company, as appropriate for the company’s country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
+        #
+        # Changing this value requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
         attr_accessor :tax_id
         # The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
         attr_accessor :tax_id_registrar
@@ -1197,8 +1199,12 @@ module Stripe
       # The person's gender (International regulations require either "male" or "female").
       attr_accessor :gender
       # The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
+      #
+      # Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
       attr_accessor :id_number
       # The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://docs.stripe.com/js/tokens/create_token?type=pii).
+      #
+      # Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
       attr_accessor :id_number_secondary
       # The person's last name.
       attr_accessor :last_name
@@ -1225,6 +1231,8 @@ module Stripe
       # The credit applicant's self-reported monthly housing payment in minor units.
       attr_accessor :self_reported_monthly_housing_payment
       # The last four digits of the person's Social Security number (U.S. only).
+      #
+      # Changing this value for the account's representative requires that the account re-accept the [terms of service](/api/accounts/object#account_object-tos_acceptance).
       attr_accessor :ssn_last_4
       # Demographic data related to the person.
       attr_accessor :us_cfpb_data

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

@@ -6,7 +6,7 @@ module Stripe
     module Billing
       class ContractCancelParams < ::Stripe::RequestParams
         class CancelPricingLine < ::Stripe::RequestParams
-          # The ID of the pricing line.
+          # The id of the pricing line.
           attr_accessor :id
           # The lookup key of the pricing line.
           attr_accessor :lookup_key