stripe 18.1.0 → 18.2.0.pre.beta.1

data/lib/stripe/resources/quote.rb

@@ -7,6 +7,7 @@ module Stripe
   class Quote < APIResource
     extend Stripe::APIOperations::Create
     extend Stripe::APIOperations::List
+    extend Stripe::APIOperations::NestedResource
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "quote"
@@ -14,6 +15,9 @@ module Stripe
       "quote"
     end
 
+    nested_resource_class_methods :preview_invoice, operations: %i[list]
+    nested_resource_class_methods :preview_subscription_schedule, operations: %i[list]
+
     class AutomaticTax < ::Stripe::StripeObject
       class Liability < ::Stripe::StripeObject
         # The connected account being referenced when `type` is `account`.
@@ -48,6 +52,37 @@ module Stripe
     end
 
     class Computed < ::Stripe::StripeObject
+      class LastReestimationDetails < ::Stripe::StripeObject
+        class Failed < ::Stripe::StripeObject
+          # The failure `code` is more granular than the `reason` provided and may correspond to a Stripe error code. For automation errors, this field is one of: `reverse_api_failure`, `reverse_api_deadline_exceeeded`, or `reverse_api_response_validation_error`, which are Stripe error codes and map to the error `message` field.
+          attr_reader :failure_code
+          # Information derived from the `failure_code` or a freeform message that explains the error as a human-readable English string. For example, "margin ID is not a valid ID".
+          attr_reader :message
+          # The reason the reestimation failed.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # When `status` is `failed`, provides details about the quote reestimation failure.
+        attr_reader :failed
+        # Latest status of the reestimation.
+        attr_reader :status
+
+        def self.inner_class_types
+          @inner_class_types = { failed: Failed }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Recurring < ::Stripe::StripeObject
         class TotalDetails < ::Stripe::StripeObject
           class Breakdown < ::Stripe::StripeObject
@@ -227,13 +262,21 @@ module Stripe
           @field_remappings = {}
         end
       end
+      # Details of the most recent reestimate of the quote's preview schedules and upcoming invoices, including the status of Stripe's calculation.
+      attr_reader :last_reestimation_details
       # The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices.
       attr_reader :recurring
+      # The time at which the quote's estimated schedules and upcoming invoices were generated.
+      attr_reader :updated_at
       # Attribute for field upfront
       attr_reader :upfront
 
       def self.inner_class_types
-        @inner_class_types = { recurring: Recurring, upfront: Upfront }
+        @inner_class_types = {
+          last_reestimation_details: LastReestimationDetails,
+          recurring: Recurring,
+          upfront: Upfront,
+        }
       end
 
       def self.field_remappings
@@ -285,6 +328,128 @@ module Stripe
       end
     end
 
+    class StatusDetails < ::Stripe::StripeObject
+      class Canceled < ::Stripe::StripeObject
+        # The reason this quote was marked as canceled.
+        attr_reader :reason
+        # Time at which the quote was marked as canceled. Measured in seconds since the Unix epoch.
+        attr_reader :transitioned_at
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Stale < ::Stripe::StripeObject
+        class LastReason < ::Stripe::StripeObject
+          class LinesInvalid < ::Stripe::StripeObject
+            # The timestamp at which the lines were marked as invalid.
+            attr_reader :invalid_at
+            # The list of lines that became invalid at the given timestamp.
+            attr_reader :lines
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class SubscriptionChanged < ::Stripe::StripeObject
+            # The subscription's state before the quote was marked as stale.
+            attr_reader :previous_subscription
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class SubscriptionScheduleChanged < ::Stripe::StripeObject
+            # The subscription schedule's state before the quote was marked as stale.
+            attr_reader :previous_subscription_schedule
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The ID of the line that is invalid if the stale reason type is `line_invalid`.
+          attr_reader :line_invalid
+          # The IDs of the lines that are invalid if the stale reason type is `lines_invalid`.
+          attr_reader :lines_invalid
+          # The user supplied mark stale reason.
+          attr_reader :marked_stale
+          # The ID of the subscription that was canceled.
+          attr_reader :subscription_canceled
+          # Attribute for field subscription_changed
+          attr_reader :subscription_changed
+          # The ID of the subscription that was expired.
+          attr_reader :subscription_expired
+          # The ID of the subscription schedule that was canceled.
+          attr_reader :subscription_schedule_canceled
+          # Attribute for field subscription_schedule_changed
+          attr_reader :subscription_schedule_changed
+          # The ID of the subscription schedule that was released.
+          attr_reader :subscription_schedule_released
+          # The reason the quote was marked as stale.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {
+              lines_invalid: LinesInvalid,
+              subscription_changed: SubscriptionChanged,
+              subscription_schedule_changed: SubscriptionScheduleChanged,
+            }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Time at which the quote expires. Measured in seconds since the Unix epoch.
+        attr_reader :expires_at
+        # The most recent reason this quote was marked as stale.
+        attr_reader :last_reason
+        # Time at which the stale reason was updated. Measured in seconds since the Unix epoch.
+        attr_reader :last_updated_at
+        # Time at which the quote was marked as stale. Measured in seconds since the Unix epoch.
+        attr_reader :transitioned_at
+
+        def self.inner_class_types
+          @inner_class_types = { last_reason: LastReason }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field canceled
+      attr_reader :canceled
+      # Attribute for field stale
+      attr_reader :stale
+
+      def self.inner_class_types
+        @inner_class_types = { canceled: Canceled, stale: Stale }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class StatusTransitions < ::Stripe::StripeObject
       # The time that the quote was accepted. Measured in seconds since Unix epoch.
       attr_reader :accepted_at
@@ -303,6 +468,99 @@ module Stripe
     end
 
     class SubscriptionData < ::Stripe::StripeObject
+      class BillOnAcceptance < ::Stripe::StripeObject
+        class BillFrom < ::Stripe::StripeObject
+          class LineStartsAt < ::Stripe::StripeObject
+            # Unique identifier for the object.
+            attr_reader :id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The materialized time.
+          attr_reader :computed
+          # The timestamp the given line starts at.
+          attr_reader :line_starts_at
+          # A precise Unix timestamp.
+          attr_reader :timestamp
+          # The type of method to specify the `bill_from` time.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { line_starts_at: LineStartsAt }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class BillUntil < ::Stripe::StripeObject
+          class Duration < ::Stripe::StripeObject
+            # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+            attr_reader :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_reader :interval_count
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class LineEndsAt < ::Stripe::StripeObject
+            # Unique identifier for the object.
+            attr_reader :id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The materialized time.
+          attr_reader :computed
+          # Time span for the quote line starting from the `starts_at` date.
+          attr_reader :duration
+          # The timestamp the given line ends at.
+          attr_reader :line_ends_at
+          # A precise Unix timestamp.
+          attr_reader :timestamp
+          # The type of method to specify the `bill_until` time.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { duration: Duration, line_ends_at: LineEndsAt }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The start of the period to bill from when the Quote is accepted.
+        attr_reader :bill_from
+        # The end of the period to bill until when the Quote is accepted.
+        attr_reader :bill_until
+
+        def self.inner_class_types
+          @inner_class_types = { bill_from: BillFrom, bill_until: BillUntil }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class BillingMode < ::Stripe::StripeObject
         class Flexible < ::Stripe::StripeObject
           # Controls how invoices and invoice items display proration amounts and discount amounts.
@@ -329,19 +587,215 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class Prebilling < ::Stripe::StripeObject
+        # Attribute for field iterations
+        attr_reader :iterations
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Describes the period to bill for upon accepting the quote.
+      attr_reader :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_reader :billing_behavior
+      # Whether the subscription will always start a new billing period when the quote is accepted.
+      attr_reader :billing_cycle_anchor
       # The billing mode of the quote.
       attr_reader :billing_mode
       # 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_reader :description
       # When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch.
       attr_reader :effective_date
+      # Behavior of the subscription schedule and underlying subscription when it ends.
+      attr_reader :end_behavior
+      # The id of the subscription that will be updated when the quote is accepted.
+      attr_reader :from_subscription
       # 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_reader :metadata
+      # 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_reader :prebilling
+      # Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
+      attr_reader :proration_behavior
       # Integer representing the number of trial period days before the customer is charged for the first time.
       attr_reader :trial_period_days
 
       def self.inner_class_types
-        @inner_class_types = { billing_mode: BillingMode }
+        @inner_class_types = {
+          bill_on_acceptance: BillOnAcceptance,
+          billing_mode: BillingMode,
+          prebilling: Prebilling,
+        }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class SubscriptionDataOverride < ::Stripe::StripeObject
+      class AppliesTo < ::Stripe::StripeObject
+        # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
+        attr_reader :new_reference
+        # The ID of the schedule the line applies to.
+        attr_reader :subscription_schedule
+        # Describes whether the quote line is affecting a new schedule or an existing schedule.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class BillOnAcceptance < ::Stripe::StripeObject
+        class BillFrom < ::Stripe::StripeObject
+          class LineStartsAt < ::Stripe::StripeObject
+            # Unique identifier for the object.
+            attr_reader :id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The materialized time.
+          attr_reader :computed
+          # The timestamp the given line starts at.
+          attr_reader :line_starts_at
+          # A precise Unix timestamp.
+          attr_reader :timestamp
+          # The type of method to specify the `bill_from` time.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { line_starts_at: LineStartsAt }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class BillUntil < ::Stripe::StripeObject
+          class Duration < ::Stripe::StripeObject
+            # Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
+            attr_reader :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_reader :interval_count
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+
+          class LineEndsAt < ::Stripe::StripeObject
+            # Unique identifier for the object.
+            attr_reader :id
+
+            def self.inner_class_types
+              @inner_class_types = {}
+            end
+
+            def self.field_remappings
+              @field_remappings = {}
+            end
+          end
+          # The materialized time.
+          attr_reader :computed
+          # Time span for the quote line starting from the `starts_at` date.
+          attr_reader :duration
+          # The timestamp the given line ends at.
+          attr_reader :line_ends_at
+          # A precise Unix timestamp.
+          attr_reader :timestamp
+          # The type of method to specify the `bill_until` time.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = { duration: Duration, line_ends_at: LineEndsAt }
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The start of the period to bill from when the Quote is accepted.
+        attr_reader :bill_from
+        # The end of the period to bill until when the Quote is accepted.
+        attr_reader :bill_until
+
+        def self.inner_class_types
+          @inner_class_types = { bill_from: BillFrom, bill_until: BillUntil }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field applies_to
+      attr_reader :applies_to
+      # Describes the period to bill for upon accepting the quote.
+      attr_reader :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_reader :billing_behavior
+      # The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.
+      attr_reader :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_reader :description
+      # Behavior of the subscription schedule and underlying subscription when it ends.
+      attr_reader :end_behavior
+      # Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
+      attr_reader :proration_behavior
+
+      def self.inner_class_types
+        @inner_class_types = { applies_to: AppliesTo, bill_on_acceptance: BillOnAcceptance }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
+    class SubscriptionSchedule < ::Stripe::StripeObject
+      class AppliesTo < ::Stripe::StripeObject
+        # A custom string that identifies a new subscription schedule being created upon quote acceptance. All quote lines with the same `new_reference` field will be applied to the creation of a new subscription schedule.
+        attr_reader :new_reference
+        # The ID of the schedule the line applies to.
+        attr_reader :subscription_schedule
+        # Describes whether the quote line is affecting a new schedule or an existing schedule.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Attribute for field applies_to
+      attr_reader :applies_to
+      # The subscription schedule that was created or updated from this quote.
+      attr_reader :subscription_schedule
+
+      def self.inner_class_types
+        @inner_class_types = { applies_to: AppliesTo }
       end
 
       def self.field_remappings
@@ -436,6 +890,8 @@ module Stripe
         @field_remappings = {}
       end
     end
+    # Allow quote lines to have `starts_at` in the past if collection is paused between `starts_at` and now.
+    attr_reader :allow_backdated_lines
     # Total before any discounts or taxes are applied.
     attr_reader :amount_subtotal
     # Total after discounts and taxes are applied.
@@ -482,6 +938,8 @@ module Stripe
     attr_reader :invoice_settings
     # A list of items the customer is being quoted for.
     attr_reader :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_reader :lines
     # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
     attr_reader :livemode
     # 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.
@@ -494,14 +952,20 @@ module Stripe
     attr_reader :on_behalf_of
     # The status of the quote.
     attr_reader :status
+    # Details on when and why a quote has been marked as stale or canceled.
+    attr_reader :status_details
     # Attribute for field status_transitions
     attr_reader :status_transitions
     # The subscription that was created or updated from this quote.
     attr_reader :subscription
     # Attribute for field subscription_data
     attr_reader :subscription_data
+    # List representing overrides for `subscription_data` configurations for specific subscription schedules.
+    attr_reader :subscription_data_overrides
     # The subscription schedule that was created or updated from this quote.
     attr_reader :subscription_schedule
+    # The subscription schedules that were created or updated from this quote.
+    attr_reader :subscription_schedules
     # ID of the test clock this quote belongs to.
     attr_reader :test_clock
     # Attribute for field total_details
@@ -619,6 +1083,86 @@ module Stripe
       )
     end
 
+    # Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
+    def list_lines(params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Retrieves a paginated list of lines for a quote. These lines describe changes that will be used to create new subscription schedules or update existing subscription schedules when the quote is accepted.
+    def self.list_lines(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/lines", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Preview the invoice line items that would be generated by accepting the quote.
+    def list_preview_invoice_lines(preview_invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/preview_invoices/%<preview_invoice>s/lines", { quote: CGI.escape(self["id"]), preview_invoice: CGI.escape(preview_invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Preview the invoice line items that would be generated by accepting the quote.
+    def self.list_preview_invoice_lines(quote, preview_invoice, params = {}, opts = {})
+      request_stripe_object(
+        method: :get,
+        path: format("/v1/quotes/%<quote>s/preview_invoices/%<preview_invoice>s/lines", { quote: CGI.escape(quote), preview_invoice: CGI.escape(preview_invoice) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Converts a stale quote to draft.
+    def mark_draft(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_draft", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Converts a stale quote to draft.
+    def self.mark_draft(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_draft", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Converts a draft or open quote to stale.
+    def mark_stale(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_stale", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Converts a draft or open quote to stale.
+    def self.mark_stale(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/mark_stale", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # Download the PDF for a finalized quote. Explanation for special handling can be found [here](https://docs.stripe.com/quotes/overview#quote_pdf)
     def pdf(params = {}, opts = {}, &read_body_chunk_block)
       opts = { api_base: APIRequestor.active_requestor.config.uploads_base }.merge(opts)
@@ -645,6 +1189,26 @@ module Stripe
       )
     end
 
+    # Recompute the upcoming invoice estimate for the quote.
+    def reestimate(params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Recompute the upcoming invoice estimate for the quote.
+    def self.reestimate(quote, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/quotes/%<quote>s/reestimate", { quote: CGI.escape(quote) }),
+        params: params,
+        opts: opts
+      )
+    end
+
     # A quote models prices and services for a customer.
     def self.update(quote, params = {}, opts = {})
       request_stripe_object(
@@ -661,8 +1225,11 @@ module Stripe
         computed: Computed,
         from_quote: FromQuote,
         invoice_settings: InvoiceSettings,
+        status_details: StatusDetails,
         status_transitions: StatusTransitions,
         subscription_data: SubscriptionData,
+        subscription_data_overrides: SubscriptionDataOverride,
+        subscription_schedules: SubscriptionSchedule,
         total_details: TotalDetails,
         transfer_data: TransferData,
       }