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

data/lib/stripe/params/quote_create_params.rb

@@ -198,7 +198,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
@@ -208,6 +208,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,
@@ -215,7 +217,8 @@ module Stripe
             price: nil,
             quantity: nil,
             tax_rates: nil,
-            trial: nil
+            trial: nil,
+            trial_offer: nil
           )
             @discounts = discounts
             @metadata = metadata
@@ -223,6 +226,7 @@ module Stripe
             @quantity = quantity
             @tax_rates = tax_rates
             @trial = trial
+            @trial_offer = trial_offer
           end
         end
 
@@ -332,6 +336,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,
@@ -339,7 +345,8 @@ module Stripe
             price: nil,
             quantity: nil,
             tax_rates: nil,
-            trial: nil
+            trial: nil,
+            trial_offer: nil
           )
             @discounts = discounts
             @metadata = metadata
@@ -347,6 +354,7 @@ module Stripe
             @quantity = quantity
             @tax_rates = tax_rates
             @trial = trial
+            @trial_offer = trial_offer
           end
         end
         # Details for the `add_discount` type.
@@ -542,6 +550,8 @@ module Stripe
       attr_accessor :billing_cycle_anchor
       # A point-in-time operation that cancels an existing subscription schedule at the line's starts_at timestamp. Currently only compatible with `quote_acceptance_date` for `starts_at`. When using cancel_subscription_schedule, the subscription schedule on the quote remains unalterable, except for modifications to the metadata, collection_method or invoice_settings.
       attr_accessor :cancel_subscription_schedule
+      # 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
       # Details to identify the end of the time range modified by the proposed change. If not supplied, the quote line is considered a point-in-time operation that only affects the exact timestamp at `starts_at`, and a restricted set of attributes is supported on the quote line.
       attr_accessor :ends_at
       # Changes to how Stripe handles prorations during the quote line's time span. Affects if and how prorations are created when a future phase starts.
@@ -560,6 +570,7 @@ module Stripe
         applies_to: nil,
         billing_cycle_anchor: nil,
         cancel_subscription_schedule: nil,
+        effective_at: nil,
         ends_at: nil,
         proration_behavior: nil,
         set_pause_collection: nil,
@@ -571,6 +582,7 @@ module Stripe
         @applies_to = applies_to
         @billing_cycle_anchor = billing_cycle_anchor
         @cancel_subscription_schedule = cancel_subscription_schedule
+        @effective_at = effective_at
         @ends_at = ends_at
         @proration_behavior = proration_behavior
         @set_pause_collection = set_pause_collection
@@ -642,7 +654,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
@@ -669,7 +681,7 @@ module Stripe
       attr_accessor :discounts
       # 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
       # The quantity of the line item.
       attr_accessor :quantity
@@ -784,6 +796,102 @@ 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 BillFrom < ::Stripe::RequestParams
+          class LineStartsAt < ::Stripe::RequestParams
+            # The ID of a quote line.
+            attr_accessor :id
+            # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
+            attr_accessor :index
+
+            def initialize(id: nil, index: nil)
+              @id = id
+              @index = index
+            end
+          end
+          # Details of a Quote line to start the bill period from.
+          attr_accessor :line_starts_at
+          # A precise Unix timestamp.
+          attr_accessor :timestamp
+          # The type of method to specify the `bill_from` time.
+          attr_accessor :type
+
+          def initialize(line_starts_at: nil, timestamp: nil, type: nil)
+            @line_starts_at = line_starts_at
+            @timestamp = timestamp
+            @type = type
+          end
+        end
+
+        class BillUntil < ::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
+
+          class LineEndsAt < ::Stripe::RequestParams
+            # The ID of a quote line.
+            attr_accessor :id
+            # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
+            attr_accessor :index
+
+            def initialize(id: nil, index: nil)
+              @id = id
+              @index = index
+            end
+          end
+          # Details of the duration over which to bill.
+          attr_accessor :duration
+          # Details of a Quote line item from which to bill until.
+          attr_accessor :line_ends_at
+          # A precise Unix timestamp.
+          attr_accessor :timestamp
+          # The type of method to specify the `bill_until` time.
+          attr_accessor :type
+
+          def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil)
+            @duration = duration
+            @line_ends_at = line_ends_at
+            @timestamp = timestamp
+            @type = type
+          end
+        end
+        # Configure billing schedule differently for individual subscription items.
+        attr_accessor :applies_to
+        # The start of the period to bill from when the Quote is accepted.
+        attr_accessor :bill_from
+        # The end of the period to bill until when the Quote is accepted.
+        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_from: nil, bill_until: nil, key: nil)
+          @applies_to = applies_to
+          @bill_from = bill_from
+          @bill_until = bill_until
+          @key = key
+        end
+      end
+
       class Prebilling < ::Stripe::RequestParams
         # This is used to determine the number of billing cycles to prebill.
         attr_accessor :iterations
@@ -800,6 +908,8 @@ module Stripe
       attr_accessor :billing_cycle_anchor
       # Controls how prorations and invoices for subscriptions are calculated and orchestrated.
       attr_accessor :billing_mode
+      # Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
+      attr_accessor :billing_schedules
       # The subscription's 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
       # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted.
@@ -808,15 +918,17 @@ module Stripe
       attr_accessor :end_behavior
       # The id of a subscription that the quote will update. By default, the quote will contain the state of the subscription (such as line items, collection method and billing thresholds) unless overridden.
       attr_accessor :from_subscription
-      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
+      # Set of [key-value pairs](https://docs.stripe.com/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.
       attr_accessor :metadata
+      # Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. 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
       # If specified, the invoicing for the given billing cycle iterations will be processed when the quote is accepted. Cannot be used with `effective_date`.
       attr_accessor :prebilling
-      # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
+      # Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
       #
       # When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
       #
-      # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
+      # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
       #
       # Prorations can be disabled by passing `none`.
       attr_accessor :proration_behavior
@@ -828,11 +940,13 @@ module Stripe
         billing_behavior: nil,
         billing_cycle_anchor: nil,
         billing_mode: nil,
+        billing_schedules: nil,
         description: nil,
         effective_date: nil,
         end_behavior: nil,
         from_subscription: nil,
         metadata: nil,
+        phase_effective_at: nil,
         prebilling: nil,
         proration_behavior: nil,
         trial_period_days: nil
@@ -841,11 +955,13 @@ module Stripe
         @billing_behavior = billing_behavior
         @billing_cycle_anchor = billing_cycle_anchor
         @billing_mode = billing_mode
+        @billing_schedules = billing_schedules
         @description = description
         @effective_date = effective_date
         @end_behavior = end_behavior
         @from_subscription = from_subscription
         @metadata = metadata
+        @phase_effective_at = phase_effective_at
         @prebilling = prebilling
         @proration_behavior = proration_behavior
         @trial_period_days = trial_period_days
@@ -945,23 +1061,123 @@ module Stripe
           @bill_until = bill_until
         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 BillFrom < ::Stripe::RequestParams
+          class LineStartsAt < ::Stripe::RequestParams
+            # The ID of a quote line.
+            attr_accessor :id
+            # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
+            attr_accessor :index
+
+            def initialize(id: nil, index: nil)
+              @id = id
+              @index = index
+            end
+          end
+          # Details of a Quote line to start the bill period from.
+          attr_accessor :line_starts_at
+          # A precise Unix timestamp.
+          attr_accessor :timestamp
+          # The type of method to specify the `bill_from` time.
+          attr_accessor :type
+
+          def initialize(line_starts_at: nil, timestamp: nil, type: nil)
+            @line_starts_at = line_starts_at
+            @timestamp = timestamp
+            @type = type
+          end
+        end
+
+        class BillUntil < ::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
+
+          class LineEndsAt < ::Stripe::RequestParams
+            # The ID of a quote line.
+            attr_accessor :id
+            # The position of the previous quote line in the `lines` array after which this line should begin. Indexes start from 0 and must be less than the index of the current line in the array.
+            attr_accessor :index
+
+            def initialize(id: nil, index: nil)
+              @id = id
+              @index = index
+            end
+          end
+          # Details of the duration over which to bill.
+          attr_accessor :duration
+          # Details of a Quote line item from which to bill until.
+          attr_accessor :line_ends_at
+          # A precise Unix timestamp.
+          attr_accessor :timestamp
+          # The type of method to specify the `bill_until` time.
+          attr_accessor :type
+
+          def initialize(duration: nil, line_ends_at: nil, timestamp: nil, type: nil)
+            @duration = duration
+            @line_ends_at = line_ends_at
+            @timestamp = timestamp
+            @type = type
+          end
+        end
+        # Configure billing schedule differently for individual subscription items.
+        attr_accessor :applies_to
+        # The start of the period to bill from when the Quote is accepted.
+        attr_accessor :bill_from
+        # The end of the period to bill until when the Quote is accepted.
+        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_from: nil, bill_until: nil, key: nil)
+          @applies_to = applies_to
+          @bill_from = bill_from
+          @bill_until = bill_until
+          @key = key
+        end
+      end
       # Whether the override applies to an existing Subscription Schedule or a new Subscription Schedule.
       attr_accessor :applies_to
       # Describes the period to bill for upon accepting the quote.
       attr_accessor :bill_on_acceptance
       # 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
+      # Billing schedules that will be applied to the subscription or subscription schedule created when the quote is accepted.
+      attr_accessor :billing_schedules
       # The customer the Subscription Data override applies to. This is only relevant when `applies_to.type=new_reference`.
       attr_accessor :customer
       # The subscription's 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
       # Behavior of the subscription schedule and underlying subscription when it ends.
       attr_accessor :end_behavior
-      # Determines how to handle [prorations](https://stripe.com/docs/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
+      # Configures how the subscription schedule handles billing for phase transitions when the quote is accepted. 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
+      # Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations). When creating a subscription, valid values are `create_prorations` or `none`.
       #
       # When updating a subscription, valid values are `create_prorations`, `none`, or `always_invoice`.
       #
-      # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://stripe.com/docs/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
+      # Passing `create_prorations` will cause proration invoice items to be created when applicable. These proration items will only be invoiced immediately under [certain conditions](https://docs.stripe.com/subscriptions/upgrading-downgrading#immediate-payment). In order to always invoice immediately for prorations, pass `always_invoice`.
       #
       # Prorations can be disabled by passing `none`.
       attr_accessor :proration_behavior
@@ -970,17 +1186,21 @@ module Stripe
         applies_to: nil,
         bill_on_acceptance: nil,
         billing_behavior: nil,
+        billing_schedules: nil,
         customer: nil,
         description: nil,
         end_behavior: nil,
+        phase_effective_at: nil,
         proration_behavior: nil
       )
         @applies_to = applies_to
         @bill_on_acceptance = bill_on_acceptance
         @billing_behavior = billing_behavior
+        @billing_schedules = billing_schedules
         @customer = customer
         @description = description
         @end_behavior = end_behavior
+        @phase_effective_at = phase_effective_at
         @proration_behavior = proration_behavior
       end
     end
@@ -1035,7 +1255,7 @@ module Stripe
     attr_accessor :line_items
     # A list of [quote lines](https://docs.stripe.com/api/quote_lines) on the quote. These lines describe changes, in the order provided, that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
     attr_accessor :lines
-    # 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 account on behalf of which to charge.
     attr_accessor :on_behalf_of

data/lib/stripe/params/quote_list_params.rb

@@ -3,9 +3,9 @@
 
 module Stripe
   class QuoteListParams < ::Stripe::RequestParams
-    # The ID of the customer whose quotes will be retrieved.
+    # The ID of the customer whose quotes you're retrieving.
     attr_accessor :customer
-    # The ID of the account whose quotes will be retrieved.
+    # The ID of the account representing the customer whose quotes you're retrieving.
     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