stripe 15.3.0 → 15.4.0.pre.beta.2

data/lib/stripe/resources/subscription_item.rb

@@ -20,6 +20,13 @@ module Stripe
       attr_reader :usage_gte
     end
 
+    class Trial < Stripe::StripeObject
+      # List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
+      attr_reader :converts_to
+      # Determines the type of trial for this item.
+      attr_reader :type
+    end
+
     class DeleteParams < Stripe::RequestParams
       # Delete all usage for the given subscription item. Allowed only when the current plan's `usage_type` is `metered`.
       attr_accessor :clear_usage
@@ -46,16 +53,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
@@ -203,16 +238,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
@@ -258,6 +321,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.
@@ -290,6 +365,8 @@ module Stripe
       attr_accessor :subscription
       # 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,
@@ -304,7 +381,8 @@ module Stripe
         proration_date: nil,
         quantity: nil,
         subscription: nil,
-        tax_rates: nil
+        tax_rates: nil,
+        trial: nil
       )
         @billing_thresholds = billing_thresholds
         @discounts = discounts
@@ -319,6 +397,7 @@ module Stripe
         @quantity = quantity
         @subscription = subscription
         @tax_rates = tax_rates
+        @trial = trial
       end
     end
     # Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
@@ -359,6 +438,8 @@ module Stripe
     attr_reader :subscription
     # The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
     attr_reader :tax_rates
+    # Options that configure the trial on the subscription item.
+    attr_reader :trial
     # Always true for a deleted object
     attr_reader :deleted