stripe 17.0.0 → 17.1.0.pre.alpha.1

data/lib/stripe/params/subscription_schedule_update_params.rb

@@ -2,10 +2,10 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionScheduleUpdateParams < Stripe::RequestParams
-    class DefaultSettings < Stripe::RequestParams
-      class AutomaticTax < Stripe::RequestParams
-        class Liability < Stripe::RequestParams
+  class SubscriptionScheduleUpdateParams < ::Stripe::RequestParams
+    class DefaultSettings < ::Stripe::RequestParams
+      class AutomaticTax < ::Stripe::RequestParams
+        class Liability < ::Stripe::RequestParams
           # The connected account being referenced when `type` is `account`.
           attr_accessor :account
           # Type of the account referenced in the request.
@@ -27,7 +27,7 @@ module Stripe
         end
       end
 
-      class BillingThresholds < Stripe::RequestParams
+      class BillingThresholds < ::Stripe::RequestParams
         # Monetary threshold that triggers the subscription to advance to a new billing period
         attr_accessor :amount_gte
         # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
@@ -39,8 +39,8 @@ module Stripe
         end
       end
 
-      class InvoiceSettings < Stripe::RequestParams
-        class Issuer < Stripe::RequestParams
+      class InvoiceSettings < ::Stripe::RequestParams
+        class Issuer < ::Stripe::RequestParams
           # The connected account being referenced when `type` is `account`.
           attr_accessor :account
           # Type of the account referenced in the request.
@@ -65,7 +65,7 @@ module Stripe
         end
       end
 
-      class TransferData < Stripe::RequestParams
+      class TransferData < ::Stripe::RequestParams
         # 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 destination account. By default, the entire amount is transferred to the destination.
         attr_accessor :amount_percent
         # ID of an existing, connected Stripe account.
@@ -122,25 +122,53 @@ module Stripe
       end
     end
 
-    class Phase < Stripe::RequestParams
-      class AddInvoiceItem < Stripe::RequestParams
-        class Discount < Stripe::RequestParams
+    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
 
-        class Period < Stripe::RequestParams
-          class End < Stripe::RequestParams
+        class Period < ::Stripe::RequestParams
+          class End < ::Stripe::RequestParams
             # A precise Unix timestamp for the end of the invoice item period. Must be greater than or equal to `period.start`.
             attr_accessor :timestamp
             # Select how to calculate the end of the invoice item period.
@@ -152,7 +180,7 @@ module Stripe
             end
           end
 
-          class Start < Stripe::RequestParams
+          class Start < ::Stripe::RequestParams
             # A precise Unix timestamp for the start of the invoice item period. Must be less than or equal to `period.end`.
             attr_accessor :timestamp
             # Select how to calculate the start of the invoice item period.
@@ -174,7 +202,7 @@ module Stripe
           end
         end
 
-        class PriceData < Stripe::RequestParams
+        class PriceData < ::Stripe::RequestParams
           # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
           attr_accessor :currency
           # The ID of the [Product](https://docs.stripe.com/api/products) that this [Price](https://docs.stripe.com/api/prices) will belong to.
@@ -234,8 +262,8 @@ module Stripe
         end
       end
 
-      class AutomaticTax < Stripe::RequestParams
-        class Liability < Stripe::RequestParams
+      class AutomaticTax < ::Stripe::RequestParams
+        class Liability < ::Stripe::RequestParams
           # The connected account being referenced when `type` is `account`.
           attr_accessor :account
           # Type of the account referenced in the request.
@@ -257,7 +285,7 @@ module Stripe
         end
       end
 
-      class BillingThresholds < Stripe::RequestParams
+      class BillingThresholds < ::Stripe::RequestParams
         # Monetary threshold that triggers the subscription to advance to a new billing period
         attr_accessor :amount_gte
         # Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
@@ -269,22 +297,50 @@ module Stripe
         end
       end
 
-      class Discount < 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
 
-      class Duration < Stripe::RequestParams
+      class Duration < ::Stripe::RequestParams
         # Specifies phase duration. Either `day`, `week`, `month` or `year`.
         attr_accessor :interval
         # The multiplier applied to the interval.
@@ -296,8 +352,8 @@ module Stripe
         end
       end
 
-      class InvoiceSettings < Stripe::RequestParams
-        class Issuer < Stripe::RequestParams
+      class InvoiceSettings < ::Stripe::RequestParams
+        class Issuer < ::Stripe::RequestParams
           # The connected account being referenced when `type` is `account`.
           attr_accessor :account
           # Type of the account referenced in the request.
@@ -322,8 +378,8 @@ module Stripe
         end
       end
 
-      class Item < Stripe::RequestParams
-        class BillingThresholds < Stripe::RequestParams
+      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))
           attr_accessor :usage_gte
 
@@ -332,23 +388,51 @@ module Stripe
           end
         end
 
-        class Discount < 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
 
-        class PriceData < Stripe::RequestParams
-          class Recurring < Stripe::RequestParams
+        class PriceData < ::Stripe::RequestParams
+          class Recurring < ::Stripe::RequestParams
             # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
             attr_accessor :interval
             # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
@@ -388,6 +472,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 +500,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 +511,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,10 +522,20 @@ module Stripe
           @price_data = price_data
           @quantity = quantity
           @tax_rates = tax_rates
+          @trial = trial
         end
       end
 
-      class TransferData < Stripe::RequestParams
+      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
+
+      class TransferData < ::Stripe::RequestParams
         # 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 destination account. By default, the entire amount is transferred to the destination.
         attr_accessor :amount_percent
         # ID of an existing, connected Stripe account.
@@ -437,6 +546,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 +597,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 +607,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 +632,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 +658,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,22 +692,28 @@ 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
 
     def initialize(
+      billing_behavior: nil,
       default_settings: nil,
       end_behavior: nil,
       expand: nil,
       metadata: nil,
       phases: nil,
+      prebilling: nil,
       proration_behavior: 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
     end
   end

data/lib/stripe/params/subscription_search_params.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 module Stripe
-  class SubscriptionSearchParams < Stripe::RequestParams
+  class SubscriptionSearchParams < ::Stripe::RequestParams
     # Specifies which fields in the response should be expanded.
     attr_accessor :expand
     # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.