stripe 18.1.0.pre.beta.1 → 18.1.0

data/lib/stripe/params/subscription_schedule_create_params.rb

@@ -100,7 +100,7 @@ module Stripe
       attr_accessor :application_fee_percent
       # Default settings for automatic tax computation.
       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
@@ -145,44 +145,16 @@ module Stripe
     class Phase < ::Stripe::RequestParams
       class AddInvoiceItem < ::Stripe::RequestParams
         class Discount < ::Stripe::RequestParams
-          class DiscountEnd < ::Stripe::RequestParams
-            class Duration < ::Stripe::RequestParams
-              # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-              attr_accessor :interval
-              # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-              attr_accessor :interval_count
-
-              def initialize(interval: nil, interval_count: nil)
-                @interval = interval
-                @interval_count = interval_count
-              end
-            end
-            # Time span for the redeemed discount.
-            attr_accessor :duration
-            # A precise Unix timestamp for the discount to end. Must be in the future.
-            attr_accessor :timestamp
-            # The type of calculation made to determine when the discount ends.
-            attr_accessor :type
-
-            def initialize(duration: nil, timestamp: nil, type: nil)
-              @duration = duration
-              @timestamp = timestamp
-              @type = type
-            end
-          end
           # ID of the coupon to create a new discount for.
           attr_accessor :coupon
           # ID of an existing discount on the object (or one of its ancestors) to reuse.
           attr_accessor :discount
-          # Details to determine how long the discount should be applied for.
-          attr_accessor :discount_end
           # ID of the promotion code to create a new discount for.
           attr_accessor :promotion_code
 
-          def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
+          def initialize(coupon: nil, discount: nil, promotion_code: nil)
             @coupon = coupon
             @discount = discount
-            @discount_end = discount_end
             @promotion_code = promotion_code
           end
         end
@@ -227,7 +199,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
@@ -250,13 +222,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
@@ -318,44 +290,16 @@ module Stripe
       end
 
       class Discount < ::Stripe::RequestParams
-        class DiscountEnd < ::Stripe::RequestParams
-          class Duration < ::Stripe::RequestParams
-            # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-            attr_accessor :interval
-            # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-            attr_accessor :interval_count
-
-            def initialize(interval: nil, interval_count: nil)
-              @interval = interval
-              @interval_count = interval_count
-            end
-          end
-          # Time span for the redeemed discount.
-          attr_accessor :duration
-          # A precise Unix timestamp for the discount to end. Must be in the future.
-          attr_accessor :timestamp
-          # The type of calculation made to determine when the discount ends.
-          attr_accessor :type
-
-          def initialize(duration: nil, timestamp: nil, type: nil)
-            @duration = duration
-            @timestamp = timestamp
-            @type = type
-          end
-        end
         # ID of the coupon to create a new discount for.
         attr_accessor :coupon
         # ID of an existing discount on the object (or one of its ancestors) to reuse.
         attr_accessor :discount
-        # Details to determine how long the discount should be applied for.
-        attr_accessor :discount_end
         # ID of the promotion code to create a new discount for.
         attr_accessor :promotion_code
 
-        def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
+        def initialize(coupon: nil, discount: nil, promotion_code: nil)
           @coupon = coupon
           @discount = discount
-          @discount_end = discount_end
           @promotion_code = promotion_code
         end
       end
@@ -400,7 +344,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)
@@ -409,44 +353,16 @@ module Stripe
         end
 
         class Discount < ::Stripe::RequestParams
-          class DiscountEnd < ::Stripe::RequestParams
-            class Duration < ::Stripe::RequestParams
-              # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-              attr_accessor :interval
-              # The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-              attr_accessor :interval_count
-
-              def initialize(interval: nil, interval_count: nil)
-                @interval = interval
-                @interval_count = interval_count
-              end
-            end
-            # Time span for the redeemed discount.
-            attr_accessor :duration
-            # A precise Unix timestamp for the discount to end. Must be in the future.
-            attr_accessor :timestamp
-            # The type of calculation made to determine when the discount ends.
-            attr_accessor :type
-
-            def initialize(duration: nil, timestamp: nil, type: nil)
-              @duration = duration
-              @timestamp = timestamp
-              @type = type
-            end
-          end
           # ID of the coupon to create a new discount for.
           attr_accessor :coupon
           # ID of an existing discount on the object (or one of its ancestors) to reuse.
           attr_accessor :discount
-          # Details to determine how long the discount should be applied for.
-          attr_accessor :discount_end
           # ID of the promotion code to create a new discount for.
           attr_accessor :promotion_code
 
-          def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
+          def initialize(coupon: nil, discount: nil, promotion_code: nil)
             @coupon = coupon
             @discount = discount
-            @discount_end = discount_end
             @promotion_code = promotion_code
           end
         end
@@ -469,7 +385,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
@@ -492,36 +408,22 @@ module Stripe
             @unit_amount_decimal = unit_amount_decimal
           end
         end
-
-        class Trial < ::Stripe::RequestParams
-          # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
-          attr_accessor :converts_to
-          # Determines the type of trial for this item.
-          attr_accessor :type
-
-          def initialize(converts_to: nil, type: nil)
-            @converts_to = converts_to
-            @type = type
-          end
-        end
         # 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
         # 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
 
         def initialize(
           billing_thresholds: nil,
@@ -531,8 +433,7 @@ module Stripe
           price: nil,
           price_data: nil,
           quantity: nil,
-          tax_rates: nil,
-          trial: nil
+          tax_rates: nil
         )
           @billing_thresholds = billing_thresholds
           @discounts = discounts
@@ -542,16 +443,6 @@ module Stripe
           @price_data = price_data
           @quantity = quantity
           @tax_rates = tax_rates
-          @trial = trial
-        end
-      end
-
-      class PauseCollection < ::Stripe::RequestParams
-        # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
-        attr_accessor :behavior
-
-        def initialize(behavior: nil)
-          @behavior = behavior
         end
       end
 
@@ -566,30 +457,13 @@ module Stripe
           @destination = destination
         end
       end
-
-      class TrialSettings < ::Stripe::RequestParams
-        class EndBehavior < ::Stripe::RequestParams
-          # Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
-          attr_accessor :prorate_up_front
-
-          def initialize(prorate_up_front: nil)
-            @prorate_up_front = prorate_up_front
-          end
-        end
-        # Defines how the subscription should behave when a trial ends.
-        attr_accessor :end_behavior
-
-        def initialize(end_behavior: nil)
-          @end_behavior = end_behavior
-        end
-      end
       # A list of prices and quantities that will generate invoice items appended to the next invoice for this phase. You may pass up to 20 items.
       attr_accessor :add_invoice_items
       # A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
       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
@@ -599,7 +473,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
@@ -607,30 +481,24 @@ 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.
+      # 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).
-      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 data with which to automatically create a Transfer for each of the associated subscription's invoices.
       attr_accessor :transfer_data
       # If set to true the entire phase is counted as a trial and the customer will not be charged for any fees.
       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`
       attr_accessor :trial_end
-      # Settings related to subscription trials.
-      attr_accessor :trial_settings
 
       def initialize(
         add_invoice_items: nil,
@@ -650,13 +518,10 @@ module Stripe
         items: nil,
         metadata: nil,
         on_behalf_of: nil,
-        pause_collection: nil,
         proration_behavior: nil,
         transfer_data: nil,
         trial: nil,
-        trial_continuation: nil,
-        trial_end: nil,
-        trial_settings: nil
+        trial_end: nil
       )
         @add_invoice_items = add_invoice_items
         @application_fee_percent = application_fee_percent
@@ -675,29 +540,12 @@ module Stripe
         @items = items
         @metadata = metadata
         @on_behalf_of = on_behalf_of
-        @pause_collection = pause_collection
         @proration_behavior = proration_behavior
         @transfer_data = transfer_data
         @trial = trial
-        @trial_continuation = trial_continuation
         @trial_end = trial_end
-        @trial_settings = trial_settings
-      end
-    end
-
-    class Prebilling < ::Stripe::RequestParams
-      # This is used to determine the number of billing cycles to prebill.
-      attr_accessor :iterations
-      # Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
-      attr_accessor :update_behavior
-
-      def initialize(iterations: nil, update_behavior: nil)
-        @iterations = iterations
-        @update_behavior = update_behavior
       end
     end
-    # Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
-    attr_accessor :billing_behavior
     # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
     attr_accessor :billing_mode
     # The identifier of the customer to create the subscription schedule for.
@@ -712,17 +560,14 @@ module Stripe
     attr_accessor :expand
     # Migrate an existing subscription to be managed by a subscription schedule. If this parameter is set, a subscription schedule will be created using the subscription's item(s), set to auto-renew using the subscription's interval. When using this parameter, other parameters (such as phase values) cannot be set. To create a subscription schedule with other modifications, we recommend making two separate API calls.
     attr_accessor :from_subscription
-    # 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
     # List representing phases of the subscription schedule. Each phase can be customized to have different durations, plans, and coupons. If there are multiple phases, the `end_date` of one phase will always equal the `start_date` of the next phase.
     attr_accessor :phases
-    # If specified, the invoicing for the given billing cycle iterations will be processed now.
-    attr_accessor :prebilling
     # When the subscription schedule starts. We recommend using `now` so that it starts the subscription immediately. You can also use a Unix timestamp to backdate the subscription so that it starts on a past date, or set a future date for the subscription to start on.
     attr_accessor :start_date
 
     def initialize(
-      billing_behavior: nil,
       billing_mode: nil,
       customer: nil,
       customer_account: nil,
@@ -732,10 +577,8 @@ module Stripe
       from_subscription: nil,
       metadata: nil,
       phases: nil,
-      prebilling: nil,
       start_date: nil
     )
-      @billing_behavior = billing_behavior
       @billing_mode = billing_mode
       @customer = customer
       @customer_account = customer_account
@@ -745,7 +588,6 @@ module Stripe
       @from_subscription = from_subscription
       @metadata = metadata
       @phases = phases
-      @prebilling = prebilling
       @start_date = start_date
     end
   end