stripe 15.3.0 → 15.4.0

data/lib/stripe/services/invoice_service.rb

@@ -143,7 +143,7 @@ module Stripe
                 @plan = plan
               end
             end
-            # Installment configuration for payments attempted on this invoice (Mexico Only).
+            # Installment configuration for payments attempted on this invoice.
             #
             # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
             attr_accessor :installments
@@ -468,7 +468,7 @@ module Stripe
       attr_accessor :auto_advance
       # Settings for automatic tax lookup for this invoice.
       attr_accessor :automatic_tax
-      # The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state. To turn off automatic finalization, set `auto_advance` to false.
+      # The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state. To turn off automatic finalization, set `auto_advance` to false.
       attr_accessor :automatically_finalizes_at
       # Either `charge_automatically` or `send_invoice`. This field can be updated only on `draft` invoices.
       attr_accessor :collection_method
@@ -790,7 +790,7 @@ module Stripe
                 @plan = plan
               end
             end
-            # Installment configuration for payments attempted on this invoice (Mexico Only).
+            # Installment configuration for payments attempted on this invoice.
             #
             # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
             attr_accessor :installments
@@ -1111,11 +1111,11 @@ module Stripe
       attr_accessor :account_tax_ids
       # A fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](https://stripe.com/docs/billing/invoices/connect#collecting-fees).
       attr_accessor :application_fee_amount
-      # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
+      # Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action. Defaults to false.
       attr_accessor :auto_advance
       # Settings for automatic tax lookup for this invoice.
       attr_accessor :automatic_tax
-      # The time when this invoice should be scheduled to finalize. The invoice will be finalized at this time if it is still in draft state.
+      # The time when this invoice should be scheduled to finalize (up to 5 years in the future). The invoice is finalized at this time if it's still in draft state.
       attr_accessor :automatically_finalizes_at
       # Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.
       attr_accessor :collection_method
@@ -2111,7 +2111,7 @@ module Stripe
 
       class ScheduleDetails < Stripe::RequestParams
         class BillingMode < Stripe::RequestParams
-          # Attribute for param field type
+          # Controls the calculation and orchestration of prorations and invoices for subscriptions.
           attr_accessor :type
 
           def initialize(type: nil)
@@ -2238,6 +2238,18 @@ module Stripe
             end
           end
 
+          class Duration < Stripe::RequestParams
+            # Specifies phase duration. Either `day`, `week`, `month` or `year`.
+            attr_accessor :interval
+            # The multiplier applied to the interval.
+            attr_accessor :interval_count
+
+            def initialize(interval: nil, interval_count: nil)
+              @interval = interval
+              @interval_count = interval_count
+            end
+          end
+
           class InvoiceSettings < Stripe::RequestParams
             class Issuer < Stripe::RequestParams
               # The connected account being referenced when `type` is `account`.
@@ -2401,13 +2413,15 @@ module Stripe
           attr_accessor :description
           # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
           attr_accessor :discounts
+          # The number of intervals the phase should last. If set, `end_date` must not be set.
+          attr_accessor :duration
           # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
           attr_accessor :end_date
           # All invoices will be billed using the specified settings.
           attr_accessor :invoice_settings
           # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
           attr_accessor :items
-          # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
+          # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. This parameter is deprecated and will be removed in a future version. Use `duration` instead.
           attr_accessor :iterations
           # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
           attr_accessor :metadata
@@ -2436,6 +2450,7 @@ module Stripe
             default_tax_rates: nil,
             description: nil,
             discounts: nil,
+            duration: nil,
             end_date: nil,
             invoice_settings: nil,
             items: nil,
@@ -2459,6 +2474,7 @@ module Stripe
             @default_tax_rates = default_tax_rates
             @description = description
             @discounts = discounts
+            @duration = duration
             @end_date = end_date
             @invoice_settings = invoice_settings
             @items = items
@@ -2491,7 +2507,7 @@ module Stripe
 
       class SubscriptionDetails < Stripe::RequestParams
         class BillingMode < Stripe::RequestParams
-          # Attribute for param field type
+          # Controls the calculation and orchestration of prorations and invoices for subscriptions.
           attr_accessor :type
 
           def initialize(type: nil)

data/lib/stripe/services/payment_intent_service.rb

@@ -1067,7 +1067,7 @@ module Stripe
           attr_accessor :capture_method
           # A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
           attr_accessor :cvc_token
-          # Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
+          # Installment configuration for payments attempted on this PaymentIntent.
           #
           # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
           attr_accessor :installments
@@ -3464,7 +3464,7 @@ module Stripe
           attr_accessor :capture_method
           # A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
           attr_accessor :cvc_token
-          # Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
+          # Installment configuration for payments attempted on this PaymentIntent.
           #
           # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
           attr_accessor :installments
@@ -5913,7 +5913,7 @@ module Stripe
           attr_accessor :capture_method
           # A single-use `cvc_update` Token that represents a card CVC value. When provided, the CVC value will be verified during the card payment attempt. This parameter can only be provided during confirmation.
           attr_accessor :cvc_token
-          # Installment configuration for payments attempted on this PaymentIntent (Mexico Only).
+          # Installment configuration for payments attempted on this PaymentIntent.
           #
           # For more information, see the [installments integration guide](https://stripe.com/docs/payments/installments).
           attr_accessor :installments
@@ -7351,6 +7351,7 @@ module Stripe
     # Confirm that your customer intends to pay with current or provided
     # payment method. Upon confirmation, the PaymentIntent will attempt to initiate
     # a payment.
+    #
     # If the selected payment method requires additional authentication steps, the
     # PaymentIntent will transition to the requires_action status and
     # suggest additional actions via next_action. If payment fails,
@@ -7358,18 +7359,22 @@ module Stripe
     # canceled status if the confirmation limit is reached. If
     # payment succeeds, the PaymentIntent will transition to the succeeded
     # status (or requires_capture, if capture_method is set to manual).
+    #
     # If the confirmation_method is automatic, payment may be attempted
     # using our [client SDKs](https://docs.stripe.com/docs/stripe-js/reference#stripe-handle-card-payment)
     # and the PaymentIntent's [client_secret](https://docs.stripe.com/api#payment_intent_object-client_secret).
     # After next_actions are handled by the client, no additional
     # confirmation is required to complete the payment.
+    #
     # If the confirmation_method is manual, all payment attempts must be
     # initiated using a secret key.
+    #
     # If any actions are required for the payment, the PaymentIntent will
     # return to the requires_confirmation state
     # after those actions are completed. Your server needs to then
     # explicitly re-confirm the PaymentIntent to initiate the next payment
     # attempt.
+    #
     # There is a variable upper limit on how many times a PaymentIntent can be confirmed.
     # After this limit is reached, any further calls to this endpoint will
     # transition the PaymentIntent to the canceled state.

data/lib/stripe/services/payment_link_service.rb

@@ -302,9 +302,12 @@ module Stripe
           class RenderingOptions < 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.
             attr_accessor :amount_tax_display
+            # ID of the invoice rendering template to use for this invoice.
+            attr_accessor :template
 
-            def initialize(amount_tax_display: nil)
+            def initialize(amount_tax_display: nil, template: nil)
               @amount_tax_display = amount_tax_display
+              @template = template
             end
           end
           # The account tax IDs associated with the invoice.
@@ -355,7 +358,7 @@ module Stripe
         class AdjustableQuantity < Stripe::RequestParams
           # Set to true if the quantity can be adjusted to any non-negative Integer.
           attr_accessor :enabled
-          # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
+          # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
           attr_accessor :maximum
           # The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
           attr_accessor :minimum
@@ -366,16 +369,86 @@ module Stripe
             @minimum = minimum
           end
         end
+
+        class PriceData < Stripe::RequestParams
+          class ProductData < Stripe::RequestParams
+            # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
+            attr_accessor :description
+            # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
+            attr_accessor :images
+            # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+            attr_accessor :metadata
+            # The product's name, meant to be displayable to the customer.
+            attr_accessor :name
+            # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+            attr_accessor :tax_code
+
+            def initialize(description: nil, images: nil, metadata: nil, name: nil, tax_code: nil)
+              @description = description
+              @images = images
+              @metadata = metadata
+              @name = name
+              @tax_code = tax_code
+            end
+          end
+
+          class Recurring < Stripe::RequestParams
+            # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
+            attr_accessor :interval
+            # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
+            attr_accessor :interval_count
+
+            def initialize(interval: nil, interval_count: nil)
+              @interval = interval
+              @interval_count = interval_count
+            end
+          end
+          # 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
+          # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to. One of `product` or `product_data` is required.
+          attr_accessor :product
+          # Data used to generate a new [Product](https://docs.stripe.com/api/products) object inline. One of `product` or `product_data` is required.
+          attr_accessor :product_data
+          # The recurring components of a price such as `interval` and `interval_count`.
+          attr_accessor :recurring
+          # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+          attr_accessor :tax_behavior
+          # A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.
+          attr_accessor :unit_amount
+          # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+          attr_accessor :unit_amount_decimal
+
+          def initialize(
+            currency: nil,
+            product: nil,
+            product_data: nil,
+            recurring: nil,
+            tax_behavior: nil,
+            unit_amount: nil,
+            unit_amount_decimal: nil
+          )
+            @currency = currency
+            @product = product
+            @product_data = product_data
+            @recurring = recurring
+            @tax_behavior = tax_behavior
+            @unit_amount = unit_amount
+            @unit_amount_decimal = unit_amount_decimal
+          end
+        end
         # When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.
         attr_accessor :adjustable_quantity
         # The ID of the [Price](https://stripe.com/docs/api/prices) or [Plan](https://stripe.com/docs/api/plans) object.
         attr_accessor :price
+        # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
+        attr_accessor :price_data
         # The quantity of the line item being purchased.
         attr_accessor :quantity
 
-        def initialize(adjustable_quantity: nil, price: nil, quantity: nil)
+        def initialize(adjustable_quantity: nil, price: nil, price_data: nil, quantity: nil)
           @adjustable_quantity = adjustable_quantity
           @price = price
+          @price_data = price_data
           @quantity = quantity
         end
       end
@@ -973,9 +1046,12 @@ module Stripe
           class RenderingOptions < 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.
             attr_accessor :amount_tax_display
+            # ID of the invoice rendering template to use for this invoice.
+            attr_accessor :template
 
-            def initialize(amount_tax_display: nil)
+            def initialize(amount_tax_display: nil, template: nil)
               @amount_tax_display = amount_tax_display
+              @template = template
             end
           end
           # The account tax IDs associated with the invoice.
@@ -1026,7 +1102,7 @@ module Stripe
         class AdjustableQuantity < Stripe::RequestParams
           # Set to true if the quantity can be adjusted to any non-negative Integer.
           attr_accessor :enabled
-          # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999.
+          # The maximum quantity the customer can purchase. By default this value is 99. You can specify a value up to 999999.
           attr_accessor :maximum
           # The minimum quantity the customer can purchase. By default this value is 0. If there is only one item in the cart then that item's quantity cannot go down to 0.
           attr_accessor :minimum

data/lib/stripe/services/payment_method_service.rb

@@ -834,7 +834,7 @@ module Stripe
       )
     end
 
-    # Updates a PaymentMethod object. A PaymentMethod must be attached a customer to be updated.
+    # Updates a PaymentMethod object. A PaymentMethod must be attached to a customer to be updated.
     def update(payment_method, params = {}, opts = {})
       request(
         method: :post,

data/lib/stripe/services/quote_service.rb

@@ -199,7 +199,7 @@ module Stripe
 
       class SubscriptionData < Stripe::RequestParams
         class BillingMode < Stripe::RequestParams
-          # Attribute for param field type
+          # Controls the calculation and orchestration of prorations and invoices for subscriptions.
           attr_accessor :type
 
           def initialize(type: nil)

data/lib/stripe/services/radar/value_list_service.rb

@@ -90,7 +90,7 @@ module Stripe
         attr_accessor :alias
         # Specifies which fields in the response should be expanded.
         attr_accessor :expand
-        # Type of the items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed.
+        # Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`. Use `string` if the item type is unknown or mixed.
         attr_accessor :item_type
         # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         attr_accessor :metadata

data/lib/stripe/services/subscription_item_service.rb

@@ -109,7 +109,7 @@ module Stripe
       #
       # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
       #
-      # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
+      # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
       attr_accessor :payment_behavior
       # The identifier of the new plan for this subscription item.
       attr_accessor :plan
@@ -264,7 +264,7 @@ module Stripe
       #
       # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
       #
-      # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
+      # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
       attr_accessor :payment_behavior
       # The identifier of the plan to add to the subscription.
       attr_accessor :plan

data/lib/stripe/services/subscription_schedule_service.rb

@@ -123,7 +123,7 @@ module Stripe
 
     class CreateParams < Stripe::RequestParams
       class BillingMode < Stripe::RequestParams
-        # Attribute for param field type
+        # Controls the calculation and orchestration of prorations and invoices for subscriptions.
         attr_accessor :type
 
         def initialize(type: nil)
@@ -363,6 +363,18 @@ module Stripe
           end
         end
 
+        class Duration < Stripe::RequestParams
+          # Specifies phase duration. Either `day`, `week`, `month` or `year`.
+          attr_accessor :interval
+          # The multiplier applied to the interval.
+          attr_accessor :interval_count
+
+          def initialize(interval: nil, interval_count: nil)
+            @interval = interval
+            @interval_count = interval_count
+          end
+        end
+
         class InvoiceSettings < Stripe::RequestParams
           class Issuer < Stripe::RequestParams
             # The connected account being referenced when `type` is `account`.
@@ -526,13 +538,15 @@ module Stripe
         attr_accessor :description
         # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
         attr_accessor :discounts
+        # The number of intervals the phase should last. If set, `end_date` must not be set.
+        attr_accessor :duration
         # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
         attr_accessor :end_date
         # All invoices will be billed using the specified settings.
         attr_accessor :invoice_settings
         # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
         attr_accessor :items
-        # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
+        # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. This parameter is deprecated and will be removed in a future version. Use `duration` instead.
         attr_accessor :iterations
         # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
         attr_accessor :metadata
@@ -559,6 +573,7 @@ module Stripe
           default_tax_rates: nil,
           description: nil,
           discounts: nil,
+          duration: nil,
           end_date: nil,
           invoice_settings: nil,
           items: nil,
@@ -581,6 +596,7 @@ module Stripe
           @default_tax_rates = default_tax_rates
           @description = description
           @discounts = discounts
+          @duration = duration
           @end_date = end_date
           @invoice_settings = invoice_settings
           @items = items
@@ -877,6 +893,18 @@ module Stripe
           end
         end
 
+        class Duration < Stripe::RequestParams
+          # Specifies phase duration. Either `day`, `week`, `month` or `year`.
+          attr_accessor :interval
+          # The multiplier applied to the interval.
+          attr_accessor :interval_count
+
+          def initialize(interval: nil, interval_count: nil)
+            @interval = interval
+            @interval_count = interval_count
+          end
+        end
+
         class InvoiceSettings < Stripe::RequestParams
           class Issuer < Stripe::RequestParams
             # The connected account being referenced when `type` is `account`.
@@ -1040,13 +1068,15 @@ module Stripe
         attr_accessor :description
         # The coupons to redeem into discounts for the schedule phase. If not specified, inherits the discount from the subscription's customer. Pass an empty string to avoid inheriting any discounts.
         attr_accessor :discounts
+        # The number of intervals the phase should last. If set, `end_date` must not be set.
+        attr_accessor :duration
         # The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.
         attr_accessor :end_date
         # All invoices will be billed using the specified settings.
         attr_accessor :invoice_settings
         # List of configuration items, each with an attached price, to apply during this phase of the subscription schedule.
         attr_accessor :items
-        # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set.
+        # Integer representing the multiplier applied to the price interval. For example, `iterations=2` applied to a price with `interval=month` and `interval_count=3` results in a phase of duration `2 * 3 months = 6 months`. If set, `end_date` must not be set. This parameter is deprecated and will be removed in a future version. Use `duration` instead.
         attr_accessor :iterations
         # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered, adding new keys and replacing existing keys in the subscription's `metadata`. Individual keys in the subscription's `metadata` can be unset by posting an empty value to them in the phase's `metadata`. To unset all keys in the subscription's `metadata`, update the subscription directly or unset every key individually from the phase's `metadata`.
         attr_accessor :metadata
@@ -1075,6 +1105,7 @@ module Stripe
           default_tax_rates: nil,
           description: nil,
           discounts: nil,
+          duration: nil,
           end_date: nil,
           invoice_settings: nil,
           items: nil,
@@ -1098,6 +1129,7 @@ module Stripe
           @default_tax_rates = default_tax_rates
           @description = description
           @discounts = discounts
+          @duration = duration
           @end_date = end_date
           @invoice_settings = invoice_settings
           @items = items

data/lib/stripe/services/subscription_service.rb

@@ -585,7 +585,7 @@ module Stripe
       #
       # Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
       #
-      # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
+      # Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://docs.stripe.com/changelog/2019-03-14) to learn more.
       attr_accessor :payment_behavior
       # Payment settings to pass to invoices created by the subscription.
       attr_accessor :payment_settings
@@ -906,7 +906,7 @@ module Stripe
       end
 
       class BillingMode < Stripe::RequestParams
-        # Attribute for param field type
+        # Controls the calculation and orchestration of prorations and invoices for subscriptions.
         attr_accessor :type
 
         def initialize(type: nil)