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

data/lib/stripe/params/invoice_create_preview_params.rb

@@ -15,7 +15,7 @@ module Stripe
           @type = type
         end
       end
-      # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
+      # Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.stripe.com/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
       attr_accessor :enabled
       # The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
       attr_accessor :liability
@@ -38,7 +38,7 @@ module Stripe
         attr_accessor :line2
         # ZIP or postal code.
         attr_accessor :postal_code
-        # State, county, province, or region.
+        # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
         attr_accessor :state
 
         def initialize(
@@ -70,7 +70,7 @@ module Stripe
           attr_accessor :line2
           # ZIP or postal code.
           attr_accessor :postal_code
-          # State, county, province, or region.
+          # State, county, province, or region ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).
           attr_accessor :state
 
           def initialize(
@@ -123,7 +123,7 @@ module Stripe
           @value = value
         end
       end
-      # The customer's address.
+      # The customer's address. Learn about [country-specific requirements for calculating tax](/invoicing/taxes?dashboard-or-api=dashboard#set-up-customer).
       attr_accessor :address
       # The customer's shipping information. Appears on invoices emailed to this customer.
       attr_accessor :shipping
@@ -247,7 +247,7 @@ module Stripe
         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.
         attr_accessor :product
-        # 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.
+        # Only required if a [default tax behavior](https://docs.stripe.com/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 positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
         attr_accessor :unit_amount
@@ -280,19 +280,19 @@ module Stripe
       attr_accessor :discounts
       # The ID of the invoice item to update in preview. If not specified, a new invoice item will be added to the preview of the upcoming invoice.
       attr_accessor :invoiceitem
-      # 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`.
+      # 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
-      # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
+      # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
       attr_accessor :period
       # The ID of the price object. One of `price` or `price_data` is required.
       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.
+      # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
       attr_accessor :price_data
       # Non-negative integer. The quantity of units for the invoice item.
       attr_accessor :quantity
-      # 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.
+      # Only required if a [default tax behavior](https://docs.stripe.com/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 [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+      # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
       attr_accessor :tax_code
       # The tax rates that apply to the item. When set, any `default_tax_rates` do not apply to this item.
       attr_accessor :tax_rates
@@ -425,6 +425,29 @@ module Stripe
           end
         end
 
+        class BillingSchedulesAction < ::Stripe::RequestParams
+          class AppliesTo < ::Stripe::RequestParams
+            # The ID of the price object.
+            attr_accessor :price
+            # Controls which subscription items the billing schedule applies to.
+            attr_accessor :type
+
+            def initialize(price: nil, type: nil)
+              @price = price
+              @type = type
+            end
+          end
+          # Specify which subscription items the billing schedule applies to.
+          attr_accessor :applies_to
+          # Select the action.
+          attr_accessor :type
+
+          def initialize(applies_to: nil, type: nil)
+            @applies_to = applies_to
+            @type = type
+          end
+        end
+
         class DiscountAction < ::Stripe::RequestParams
           class Add < ::Stripe::RequestParams
             class DiscountEnd < ::Stripe::RequestParams
@@ -565,7 +588,7 @@ module Stripe
             end
             # The discounts applied to the item. Subscription item discounts are applied before subscription discounts.
             attr_accessor :discounts
-            # 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`.
+            # 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
             # The ID of the price object.
             attr_accessor :price
@@ -575,6 +598,8 @@ module Stripe
             attr_accessor :tax_rates
             # Options that configure the trial on the subscription item.
             attr_accessor :trial
+            # The ID of the trial offer to apply to the configuration item.
+            attr_accessor :trial_offer
 
             def initialize(
               discounts: nil,
@@ -582,7 +607,8 @@ module Stripe
               price: nil,
               quantity: nil,
               tax_rates: nil,
-              trial: nil
+              trial: nil,
+              trial_offer: nil
             )
               @discounts = discounts
               @metadata = metadata
@@ -590,6 +616,7 @@ module Stripe
               @quantity = quantity
               @tax_rates = tax_rates
               @trial = trial
+              @trial_offer = trial_offer
             end
           end
 
@@ -669,6 +696,8 @@ module Stripe
             attr_accessor :tax_rates
             # If an item with the `price` already exists, passing this will override the `trial` configuration on the subscription item that matches that price. Otherwise, the `items` array is cleared and a single new item is added with the supplied `trial`.
             attr_accessor :trial
+            # The ID of the trial offer to apply to the configuration item.
+            attr_accessor :trial_offer
 
             def initialize(
               discounts: nil,
@@ -676,7 +705,8 @@ module Stripe
               price: nil,
               quantity: nil,
               tax_rates: nil,
-              trial: nil
+              trial: nil,
+              trial_offer: nil
             )
               @discounts = discounts
               @metadata = metadata
@@ -684,6 +714,7 @@ module Stripe
               @quantity = quantity
               @tax_rates = tax_rates
               @trial = trial
+              @trial_offer = trial_offer
             end
           end
           # Details of the subscription item to add. If an item with the same `price` exists, it will be replaced by this new item. Otherwise, it adds the new item.
@@ -763,8 +794,12 @@ module Stripe
         attr_accessor :amendment_start
         # For point-in-time amendments (having no `amendment_end`), this attribute lets you set or remove whether the subscription's billing cycle anchor is reset at the `amendment_start` timestamp.For time-span based amendments (having both `amendment_start` and `amendment_end`), the only value valid is `automatic`, which removes any previously configured billing cycle anchor resets scheduled to occur during the window of time spanned by the amendment.
         attr_accessor :billing_cycle_anchor
+        # Actions to apply to the billing schedules.
+        attr_accessor :billing_schedules_actions
         # Changes to the coupons being redeemed or discounts being applied during the amendment time span.
         attr_accessor :discount_actions
+        # Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
+        attr_accessor :effective_at
         # Changes to the subscription items during the amendment time span.
         attr_accessor :item_actions
         # Instructions for how to modify phase metadata
@@ -782,7 +817,9 @@ module Stripe
           amendment_end: nil,
           amendment_start: nil,
           billing_cycle_anchor: nil,
+          billing_schedules_actions: nil,
           discount_actions: nil,
+          effective_at: nil,
           item_actions: nil,
           metadata_actions: nil,
           proration_behavior: nil,
@@ -793,7 +830,9 @@ module Stripe
           @amendment_end = amendment_end
           @amendment_start = amendment_start
           @billing_cycle_anchor = billing_cycle_anchor
+          @billing_schedules_actions = billing_schedules_actions
           @discount_actions = discount_actions
+          @effective_at = effective_at
           @item_actions = item_actions
           @metadata_actions = metadata_actions
           @proration_behavior = proration_behavior
@@ -823,6 +862,58 @@ module Stripe
         end
       end
 
+      class BillingSchedule < ::Stripe::RequestParams
+        class AppliesTo < ::Stripe::RequestParams
+          # The ID of the price object.
+          attr_accessor :price
+          # Controls which subscription items the billing schedule applies to.
+          attr_accessor :type
+
+          def initialize(price: nil, type: nil)
+            @price = price
+            @type = type
+          end
+        end
+
+        class BillUntil < ::Stripe::RequestParams
+          class Duration < ::Stripe::RequestParams
+            # Specifies billing 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
+          # Specifies the billing period.
+          attr_accessor :duration
+          # The end date of the billing schedule.
+          attr_accessor :timestamp
+          # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+          attr_accessor :type
+
+          def initialize(duration: nil, timestamp: nil, type: nil)
+            @duration = duration
+            @timestamp = timestamp
+            @type = type
+          end
+        end
+        # Configure billing schedule differently for individual subscription items.
+        attr_accessor :applies_to
+        # The end date for the billing schedule.
+        attr_accessor :bill_until
+        # Specify a key for the billing schedule. Must be unique to this field, alphanumeric, and up to 200 characters. If not provided, a unique key will be generated.
+        attr_accessor :key
+
+        def initialize(applies_to: nil, bill_until: nil, key: nil)
+          @applies_to = applies_to
+          @bill_until = bill_until
+          @key = key
+        end
+      end
+
       class Phase < ::Stripe::RequestParams
         class AddInvoiceItem < ::Stripe::RequestParams
           class Discount < ::Stripe::RequestParams
@@ -908,7 +999,7 @@ module Stripe
             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.
             attr_accessor :product
-            # 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.
+            # Only required if a [default tax behavior](https://docs.stripe.com/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 positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
             attr_accessor :unit_amount
@@ -931,13 +1022,13 @@ module Stripe
           end
           # The coupons to redeem into discounts for the item.
           attr_accessor :discounts
-          # 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`.
+          # 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
           # The period associated with this invoice item. If not set, `period.start.type` defaults to `max_item_period_start` and `period.end.type` defaults to `min_item_period_end`.
           attr_accessor :period
           # The ID of the price object. One of `price` or `price_data` is required.
           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.
+          # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
           attr_accessor :price_data
           # Quantity for this item. Defaults to 1.
           attr_accessor :quantity
@@ -1081,7 +1172,7 @@ module Stripe
 
         class Item < ::Stripe::RequestParams
           class BillingThresholds < ::Stripe::RequestParams
-            # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
+            # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
             attr_accessor :usage_gte
 
             def initialize(usage_gte: nil)
@@ -1150,7 +1241,7 @@ module Stripe
             attr_accessor :product
             # 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.
+            # Only required if a [default tax behavior](https://docs.stripe.com/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 positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
             attr_accessor :unit_amount
@@ -1189,20 +1280,22 @@ module Stripe
           attr_accessor :billing_thresholds
           # The coupons to redeem into discounts for the subscription item.
           attr_accessor :discounts
-          # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
+          # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a configuration item. Metadata on a configuration item will update the underlying subscription item's `metadata` when the phase is entered, adding new keys and replacing existing keys. Individual keys in the subscription item's `metadata` can be unset by posting an empty value to them in the configuration item's `metadata`. To unset all keys in the subscription item's `metadata`, update the subscription item directly or unset every key individually from the configuration item's `metadata`.
           attr_accessor :metadata
           # The plan ID to subscribe to. You may specify the same ID in `plan` and `price`.
           attr_accessor :plan
           # The ID of the price object.
           attr_accessor :price
-          # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
+          # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
           attr_accessor :price_data
           # Quantity for the given price. Can be set only if the price's `usage_type` is `licensed` and not `metered`.
           attr_accessor :quantity
-          # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
+          # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
           attr_accessor :tax_rates
           # Options that configure the trial on the subscription item.
           attr_accessor :trial
+          # The ID of the trial offer to apply to the configuration item.
+          attr_accessor :trial_offer
 
           def initialize(
             billing_thresholds: nil,
@@ -1213,7 +1306,8 @@ module Stripe
             price_data: nil,
             quantity: nil,
             tax_rates: nil,
-            trial: nil
+            trial: nil,
+            trial_offer: nil
           )
             @billing_thresholds = billing_thresholds
             @discounts = discounts
@@ -1224,6 +1318,7 @@ module Stripe
             @quantity = quantity
             @tax_rates = tax_rates
             @trial = trial
+            @trial_offer = trial_offer
           end
         end
 
@@ -1270,7 +1365,7 @@ module Stripe
         attr_accessor :application_fee_percent
         # Automatic tax settings for this phase.
         attr_accessor :automatic_tax
-        # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
+        # Can be set to `phase_start` to set the anchor to the start of the phase or `automatic` to automatically change it if needed. Cannot be set to `phase_start` if this phase specifies a trial. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
         attr_accessor :billing_cycle_anchor
         # Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
         attr_accessor :billing_thresholds
@@ -1280,7 +1375,7 @@ module Stripe
         attr_accessor :currency
         # ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings.
         attr_accessor :default_payment_method
-        # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
+        # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://docs.stripe.com/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase.
         attr_accessor :default_tax_rates
         # Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
         attr_accessor :description
@@ -1288,19 +1383,21 @@ module Stripe
         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.
+        # Configures how the subscription schedule handles billing for phase transitions. Possible values are `phase_start` (default) or `billing_period_start`. `phase_start` bills based on the current state of the subscription, ignoring changes scheduled in future phases. `billing_period_start` bills predictively for upcoming phase transitions within the current billing cycle, including pricing changes and service period adjustments that will occur before the next invoice.
+        attr_accessor :effective_at
+        # The date at which this phase of the subscription schedule ends. If set, `duration` 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
-        # 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`.
+        # Set of [key-value pairs](https://docs.stripe.com/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
         # The account on behalf of which to charge, for each of the associated subscription's invoices.
         attr_accessor :on_behalf_of
-        # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
+        # If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://docs.stripe.com/billing/subscriptions/pause-payment).
         attr_accessor :pause_collection
-        # Controls whether the subscription schedule should create [prorations](https://stripe.com/docs/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://stripe.com/docs/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.
+        # 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.
         attr_accessor :start_date
@@ -1328,6 +1425,7 @@ module Stripe
           description: nil,
           discounts: nil,
           duration: nil,
+          effective_at: nil,
           end_date: nil,
           invoice_settings: nil,
           items: nil,
@@ -1354,6 +1452,7 @@ module Stripe
           @description = description
           @discounts = discounts
           @duration = duration
+          @effective_at = effective_at
           @end_date = end_date
           @invoice_settings = invoice_settings
           @items = items
@@ -1424,6 +1523,8 @@ module Stripe
       attr_accessor :billing_behavior
       # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
       attr_accessor :billing_mode
+      # Sets the billing schedules for the subscription schedule.
+      attr_accessor :billing_schedules
       # Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription.
       attr_accessor :end_behavior
       # 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.
@@ -1437,6 +1538,7 @@ module Stripe
         amendments: nil,
         billing_behavior: nil,
         billing_mode: nil,
+        billing_schedules: nil,
         end_behavior: nil,
         phases: nil,
         prebilling: nil,
@@ -1445,6 +1547,7 @@ module Stripe
         @amendments = amendments
         @billing_behavior = billing_behavior
         @billing_mode = billing_mode
+        @billing_schedules = billing_schedules
         @end_behavior = end_behavior
         @phases = phases
         @prebilling = prebilling
@@ -1527,7 +1630,7 @@ module Stripe
 
       class Item < ::Stripe::RequestParams
         class BillingThresholds < ::Stripe::RequestParams
-          # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
+          # Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://docs.stripe.com/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
           attr_accessor :usage_gte
 
           def initialize(usage_gte: nil)
@@ -1535,6 +1638,18 @@ module Stripe
           end
         end
 
+        class CurrentTrial < ::Stripe::RequestParams
+          # Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
+          attr_accessor :trial_end
+          # The ID of the trial offer to apply to the subscription item.
+          attr_accessor :trial_offer
+
+          def initialize(trial_end: nil, trial_offer: nil)
+            @trial_end = trial_end
+            @trial_offer = trial_offer
+          end
+        end
+
         class Discount < ::Stripe::RequestParams
           class DiscountEnd < ::Stripe::RequestParams
             class Duration < ::Stripe::RequestParams
@@ -1596,7 +1711,7 @@ module Stripe
           attr_accessor :product
           # 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.
+          # Only required if a [default tax behavior](https://docs.stripe.com/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 positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
           attr_accessor :unit_amount
@@ -1623,28 +1738,31 @@ module Stripe
         attr_accessor :billing_thresholds
         # Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
         attr_accessor :clear_usage
+        # The trial offer to apply to this subscription item.
+        attr_accessor :current_trial
         # A flag that, if set to `true`, will delete the specified item.
         attr_accessor :deleted
         # The coupons to redeem into discounts for the subscription item.
         attr_accessor :discounts
         # Subscription item to update.
         attr_accessor :id
-        # 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`.
+        # 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
         # Plan ID for this item, as a string.
         attr_accessor :plan
         # The ID of the price object. One of `price` or `price_data` is required. When changing a subscription item's price, `quantity` is set to 1 unless a `quantity` parameter is provided.
         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.
+        # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline. One of `price` or `price_data` is required.
         attr_accessor :price_data
         # Quantity for this item.
         attr_accessor :quantity
-        # A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
+        # A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
         attr_accessor :tax_rates
 
         def initialize(
           billing_thresholds: nil,
           clear_usage: nil,
+          current_trial: nil,
           deleted: nil,
           discounts: nil,
           id: nil,
@@ -1657,6 +1775,7 @@ module Stripe
         )
           @billing_thresholds = billing_thresholds
           @clear_usage = clear_usage
+          @current_trial = current_trial
           @deleted = deleted
           @discounts = discounts
           @id = id
@@ -1677,7 +1796,7 @@ module Stripe
           @iterations = iterations
         end
       end
-      # For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
+      # For new subscriptions, a future timestamp to anchor the subscription's [billing cycle](https://docs.stripe.com/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. For existing subscriptions, the value can only be set to `now` or `unchanged`.
       attr_accessor :billing_cycle_anchor
       # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
       attr_accessor :billing_mode
@@ -1695,7 +1814,7 @@ module Stripe
       attr_accessor :items
       # The pre-billing to apply to the subscription as a preview.
       attr_accessor :prebilling
-      # Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
+      # Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
       attr_accessor :proration_behavior
       # If previewing an update to a subscription, and doing proration, `subscription_details.proration_date` forces the proration to be calculated as though the update was done at the specified time. The time given must be within the current subscription period and within the current phase of the schedule backing this subscription, if the schedule exists. If set, `subscription`, and one of `subscription_details.items`, or `subscription_details.trial_end` are required. Also, `subscription_details.proration_behavior` cannot be set to 'none'.
       attr_accessor :proration_date
@@ -1740,13 +1859,13 @@ module Stripe
     end
     # Settings for automatic tax lookup for this invoice preview.
     attr_accessor :automatic_tax
-    # The identifier of the billing cadence for which you’d like to retrieve the upcoming invoice.Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
+    # The identifier of the billing cadence for which you’d like to retrieve the upcoming invoice. Cannot be provided when `subscription`, `schedule`, `subscription_details` or `schedule_details` are provided.
     attr_accessor :billing_cadence
     # The currency to preview this invoice in. Defaults to that of `customer` if not specified.
     attr_accessor :currency
-    # The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
+    # The identifier of the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
     attr_accessor :customer
-    # The identifier of the account whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.
+    # The identifier of the account representing the customer whose upcoming invoice you're retrieving. If `automatic_tax` is enabled then one of `customer`, `customer_account`, `customer_details`, `subscription`, or `schedule` must be set.
     attr_accessor :customer_account
     # Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.
     attr_accessor :customer_details
@@ -1758,7 +1877,7 @@ module Stripe
     attr_accessor :invoice_items
     # The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
     attr_accessor :issuer
-    # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details.
+    # The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.stripe.com/billing/invoices/connect) documentation for details.
     attr_accessor :on_behalf_of
     # Customizes the types of values to include when calculating the invoice. Defaults to `next` if unspecified.
     attr_accessor :preview_mode

data/lib/stripe/params/invoice_finalize_invoice_params.rb

@@ -3,7 +3,7 @@
 
 module Stripe
   class InvoiceFinalizeInvoiceParams < ::Stripe::RequestParams
-    # 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://docs.stripe.com/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
     attr_accessor :auto_advance
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand

data/lib/stripe/params/invoice_item_create_params.rb

@@ -63,7 +63,7 @@ module Stripe
       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.
       attr_accessor :product
-      # 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.
+      # Only required if a [default tax behavior](https://docs.stripe.com/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 positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
       attr_accessor :unit_amount
@@ -97,9 +97,9 @@ module Stripe
     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
-    # The ID of the customer who will be billed when this invoice item is billed.
+    # The ID of the customer to bill for this invoice item.
     attr_accessor :customer
-    # The ID of the account who will be billed when this invoice item is billed.
+    # The ID of the account representing the customer to bill for this invoice item.
     attr_accessor :customer_account
     # An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
     attr_accessor :description
@@ -113,11 +113,11 @@ module Stripe
     attr_accessor :invoice
     # The ids of the margins to apply to the invoice item. When set, the `default_margins` on the invoice do not apply to this invoice item.
     attr_accessor :margins
-    # 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`.
+    # 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
-    # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
+    # The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://docs.stripe.com/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://docs.stripe.com/revenue-recognition/methodology/subscriptions-and-invoicing) for details.
     attr_accessor :period
-    # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
+    # Data used to generate a new [Price](https://docs.stripe.com/api/prices) object inline.
     attr_accessor :price_data
     # The pricing information for the invoice item.
     attr_accessor :pricing
@@ -125,9 +125,9 @@ module Stripe
     attr_accessor :quantity
     # The ID of a subscription to add this invoice item to. When left blank, the invoice item is added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.
     attr_accessor :subscription
-    # 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.
+    # Only required if a [default tax behavior](https://docs.stripe.com/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 [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+    # A [tax code](https://docs.stripe.com/tax/tax-categories) ID.
     attr_accessor :tax_code
     # The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item.
     attr_accessor :tax_rates

data/lib/stripe/params/invoice_item_list_params.rb

@@ -22,9 +22,9 @@ module Stripe
     end
     # Only return invoice items that were created during the given date interval.
     attr_accessor :created
-    # The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.
+    # The identifier of the customer whose invoice items to return. If none is provided, returns all invoice items.
     attr_accessor :customer
-    # The identifier of the account whose invoice items to return. If none is provided, all invoice items will be returned.
+    # The identifier of the account representing the customer whose invoice items to return. If none is provided, returns all invoice items.
     attr_accessor :customer_account
     # A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
     attr_accessor :ending_before