stripe 17.2.0 → 17.3.0.pre.alpha.2

data/lib/stripe/params/subscription_schedule_update_params.rb

@@ -3,6 +3,58 @@
 
 module Stripe
   class SubscriptionScheduleUpdateParams < ::Stripe::RequestParams
+    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 DefaultSettings < ::Stripe::RequestParams
       class AutomaticTax < ::Stripe::RequestParams
         class Liability < ::Stripe::RequestParams
@@ -96,6 +148,8 @@ module Stripe
       attr_accessor :on_behalf_of
       # The data with which to automatically create a Transfer for each of the associated subscription's invoices.
       attr_accessor :transfer_data
+      # 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 :phase_effective_at
 
       def initialize(
         application_fee_percent: nil,
@@ -107,7 +161,8 @@ module Stripe
         description: nil,
         invoice_settings: nil,
         on_behalf_of: nil,
-        transfer_data: nil
+        transfer_data: nil,
+        phase_effective_at: nil
       )
         @application_fee_percent = application_fee_percent
         @automatic_tax = automatic_tax
@@ -119,22 +174,51 @@ module Stripe
         @invoice_settings = invoice_settings
         @on_behalf_of = on_behalf_of
         @transfer_data = transfer_data
+        @phase_effective_at = phase_effective_at
       end
     end
 
     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, promotion_code: nil)
+          def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
             @coupon = coupon
             @discount = discount
+            @discount_end = discount_end
             @promotion_code = promotion_code
           end
         end
@@ -270,16 +354,44 @@ 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, promotion_code: nil)
+        def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
           @coupon = coupon
           @discount = discount
+          @discount_end = discount_end
           @promotion_code = promotion_code
         end
       end
@@ -333,16 +445,44 @@ 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, promotion_code: nil)
+          def initialize(coupon: nil, discount: nil, discount_end: nil, promotion_code: nil)
             @coupon = coupon
             @discount = discount
+            @discount_end = discount_end
             @promotion_code = promotion_code
           end
         end
@@ -388,6 +528,18 @@ 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.
@@ -404,6 +556,8 @@ module Stripe
         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.
         attr_accessor :tax_rates
+        # Options that configure the trial on the subscription item.
+        attr_accessor :trial
 
         def initialize(
           billing_thresholds: nil,
@@ -413,7 +567,8 @@ module Stripe
           price: nil,
           price_data: nil,
           quantity: nil,
-          tax_rates: nil
+          tax_rates: nil,
+          trial: nil
         )
           @billing_thresholds = billing_thresholds
           @discounts = discounts
@@ -423,6 +578,16 @@ 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
 
@@ -437,6 +602,23 @@ 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).
@@ -471,6 +653,8 @@ module Stripe
       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.
       attr_accessor :proration_behavior
       # The date at which this phase of the subscription schedule starts or `now`. Must be set on the first phase.
@@ -479,8 +663,12 @@ module Stripe
       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,
@@ -500,11 +688,14 @@ module Stripe
         items: nil,
         metadata: nil,
         on_behalf_of: nil,
+        pause_collection: nil,
         proration_behavior: nil,
         start_date: nil,
         transfer_data: nil,
         trial: nil,
-        trial_end: nil
+        trial_continuation: nil,
+        trial_end: nil,
+        trial_settings: nil
       )
         @add_invoice_items = add_invoice_items
         @application_fee_percent = application_fee_percent
@@ -523,13 +714,30 @@ module Stripe
         @items = items
         @metadata = metadata
         @on_behalf_of = on_behalf_of
+        @pause_collection = pause_collection
         @proration_behavior = proration_behavior
         @start_date = start_date
         @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
     # Object representing the subscription schedule's default settings.
     attr_accessor :default_settings
     # 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.
@@ -540,23 +748,33 @@ module Stripe
     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. Note that past phases can be omitted.
     attr_accessor :phases
+    # If specified, the invoicing for the given billing cycle iterations will be processed now.
+    attr_accessor :prebilling
     # If the update changes the billing configuration (item price, quantity, etc.) of the current phase, indicates how prorations from this change should be handled. The default value is `create_prorations`.
     attr_accessor :proration_behavior
+    # Sets the billing schedules for the subscription schedule.
+    attr_accessor :billing_schedules
 
     def initialize(
+      billing_behavior: nil,
       default_settings: nil,
       end_behavior: nil,
       expand: nil,
       metadata: nil,
       phases: nil,
-      proration_behavior: nil
+      prebilling: nil,
+      proration_behavior: nil,
+      billing_schedules: nil
     )
+      @billing_behavior = billing_behavior
       @default_settings = default_settings
       @end_behavior = end_behavior
       @expand = expand
       @metadata = metadata
       @phases = phases
+      @prebilling = prebilling
       @proration_behavior = proration_behavior
+      @billing_schedules = billing_schedules
     end
   end
 end