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

data/lib/stripe/resources/quote.rb

@@ -588,6 +588,118 @@ module Stripe
         end
       end
 
+      class BillingSchedule < ::Stripe::StripeObject
+        class AppliesTo < ::Stripe::StripeObject
+          # The billing schedule will apply to the subscription item with the given price ID.
+          attr_reader :price
+          # Controls which subscription items the billing schedule applies to.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        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 time the billing schedule applies from.
+          attr_reader :computed_timestamp
+          # Lets you bill the period starting from a particular Quote line.
+          attr_reader :line_starts_at
+          # Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
+          attr_reader :timestamp
+          # Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
+          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 billing duration. Either `day`, `week`, `month` or `year`.
+            attr_reader :interval
+            # The multiplier applied to the interval.
+            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 timestamp the billing schedule will apply until.
+          attr_reader :computed_timestamp
+          # Specifies the billing period.
+          attr_reader :duration
+          # Lets you bill the period ending at a particular Quote line.
+          attr_reader :line_ends_at
+          # If specified, the billing schedule will apply until the specified timestamp.
+          attr_reader :timestamp
+          # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+          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
+        # Specifies which subscription items the billing schedule applies to.
+        attr_reader :applies_to
+        # Specifies the start of the billing period.
+        attr_reader :bill_from
+        # Attribute for field bill_until
+        attr_reader :bill_until
+        # Unique identifier for the billing schedule.
+        attr_reader :key
+
+        def self.inner_class_types
+          @inner_class_types = { applies_to: AppliesTo, bill_from: BillFrom, bill_until: BillUntil }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class Prebilling < ::Stripe::StripeObject
         # Attribute for field iterations
         attr_reader :iterations
@@ -608,6 +720,8 @@ module Stripe
       attr_reader :billing_cycle_anchor
       # The billing mode of the quote.
       attr_reader :billing_mode
+      # Billing schedules that will be applied to the subscription or subscription schedule created from this quote.
+      attr_reader :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_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.
@@ -618,6 +732,8 @@ module Stripe
       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
+      # Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
+      attr_reader :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_reader :prebilling
       # Determines how to handle [prorations](https://docs.stripe.com/subscriptions/billing-cycle#prorations) when the quote is accepted.
@@ -629,6 +745,7 @@ module Stripe
         @inner_class_types = {
           bill_on_acceptance: BillOnAcceptance,
           billing_mode: BillingMode,
+          billing_schedules: BillingSchedule,
           prebilling: Prebilling,
         }
       end
@@ -748,23 +865,143 @@ module Stripe
           @field_remappings = {}
         end
       end
+
+      class BillingSchedule < ::Stripe::StripeObject
+        class AppliesTo < ::Stripe::StripeObject
+          # The billing schedule will apply to the subscription item with the given price ID.
+          attr_reader :price
+          # Controls which subscription items the billing schedule applies to.
+          attr_reader :type
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        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 time the billing schedule applies from.
+          attr_reader :computed_timestamp
+          # Lets you bill the period starting from a particular Quote line.
+          attr_reader :line_starts_at
+          # Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
+          attr_reader :timestamp
+          # Describes how the billing schedule determines the start date. Possible values are `timestamp`, `relative`, `amendment_start`, `now`, `quote_acceptance_date`, `line_starts_at`, or `pause_collection_start`.
+          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 billing duration. Either `day`, `week`, `month` or `year`.
+            attr_reader :interval
+            # The multiplier applied to the interval.
+            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 timestamp the billing schedule will apply until.
+          attr_reader :computed_timestamp
+          # Specifies the billing period.
+          attr_reader :duration
+          # Lets you bill the period ending at a particular Quote line.
+          attr_reader :line_ends_at
+          # If specified, the billing schedule will apply until the specified timestamp.
+          attr_reader :timestamp
+          # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+          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
+        # Specifies which subscription items the billing schedule applies to.
+        attr_reader :applies_to
+        # Specifies the start of the billing period.
+        attr_reader :bill_from
+        # Attribute for field bill_until
+        attr_reader :bill_until
+        # Unique identifier for the billing schedule.
+        attr_reader :key
+
+        def self.inner_class_types
+          @inner_class_types = { applies_to: AppliesTo, 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
+      # Billing schedules that will be applied to the subscription or subscription schedule created from this quote.
+      attr_reader :billing_schedules
       # 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
+      # Configures how the subscription schedule handles billing for phase transitions when the quote is accepted.
+      attr_reader :phase_effective_at
       # 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 }
+        @inner_class_types = {
+          applies_to: AppliesTo,
+          bill_on_acceptance: BillOnAcceptance,
+          billing_schedules: BillingSchedule,
+        }
       end
 
       def self.field_remappings

data/lib/stripe/resources/quote_line.rb

@@ -103,6 +103,8 @@ module Stripe
         attr_reader :tax_rates
         # Options that configure the trial on the subscription item.
         attr_reader :trial
+        # The ID of the trial offer to apply to the configuration item.
+        attr_reader :trial_offer
 
         def self.inner_class_types
           @inner_class_types = { discounts: Discount, trial: Trial }
@@ -252,6 +254,8 @@ module Stripe
         attr_reader :tax_rates
         # Options that configure the trial on the subscription item.
         attr_reader :trial
+        # The ID of the trial offer to apply to the configuration item.
+        attr_reader :trial_offer
 
         def self.inner_class_types
           @inner_class_types = { discounts: Discount, trial: Trial }
@@ -485,6 +489,8 @@ module Stripe
     attr_reader :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_reader :cancel_subscription_schedule
+    # Configures how the subscription schedule handles billing for phase transitions.
+    attr_reader :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_reader :ends_at
     # Unique identifier for the object.

data/lib/stripe/resources/quote_preview_invoice.rb

@@ -364,6 +364,21 @@ module Stripe
         end
       end
 
+      class ScheduleDetails < ::Stripe::StripeObject
+        # The schedule that generated this invoice
+        attr_reader :schedule
+        # The subscription associated with this schedule
+        attr_reader :subscription
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
       class SubscriptionDetails < ::Stripe::StripeObject
         class PauseCollection < ::Stripe::StripeObject
           # The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
@@ -401,6 +416,8 @@ module Stripe
       attr_reader :billing_cadence_details
       # Details about the quote that generated this invoice
       attr_reader :quote_details
+      # Details about the schedule that generated this invoice
+      attr_reader :schedule_details
       # Details about the subscription that generated this invoice
       attr_reader :subscription_details
       # The type of parent that generated this invoice
@@ -410,6 +427,7 @@ module Stripe
         @inner_class_types = {
           billing_cadence_details: BillingCadenceDetails,
           quote_details: QuoteDetails,
+          schedule_details: ScheduleDetails,
           subscription_details: SubscriptionDetails,
         }
       end

data/lib/stripe/resources/quote_preview_subscription_schedule.rb

@@ -54,6 +54,89 @@ module Stripe
       end
     end
 
+    class BillingSchedule < ::Stripe::StripeObject
+      class AppliesTo < ::Stripe::StripeObject
+        # The billing schedule will apply to the subscription item with the given price ID.
+        attr_reader :price
+        # Controls which subscription items the billing schedule applies to.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class BillFrom < ::Stripe::StripeObject
+        # The time the billing schedule applies from.
+        attr_reader :computed_timestamp
+        # Use a precise Unix timestamp for prebilling to start. Must be earlier than `bill_until`.
+        attr_reader :timestamp
+        # Describes how the billing schedule determines the start date. Possible values are `timestamp`.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = {}
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class BillUntil < ::Stripe::StripeObject
+        class Duration < ::Stripe::StripeObject
+          # Specifies billing duration. Either `day`, `week`, `month` or `year`.
+          attr_reader :interval
+          # The multiplier applied to the interval.
+          attr_reader :interval_count
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # The timestamp the billing schedule will apply until.
+        attr_reader :computed_timestamp
+        # Specifies the billing period.
+        attr_reader :duration
+        # If specified, the billing schedule will apply until the specified timestamp.
+        attr_reader :timestamp
+        # Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+        attr_reader :type
+
+        def self.inner_class_types
+          @inner_class_types = { duration: Duration }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Specifies which subscription items the billing schedule applies to.
+      attr_reader :applies_to
+      # Specifies the start of the billing period.
+      attr_reader :bill_from
+      # Specifies the end of billing period.
+      attr_reader :bill_until
+      # Unique identifier for the billing schedule.
+      attr_reader :key
+
+      def self.inner_class_types
+        @inner_class_types = { applies_to: AppliesTo, bill_from: BillFrom, bill_until: BillUntil }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+
     class CurrentPhase < ::Stripe::StripeObject
       # The end of this phase of the subscription schedule.
       attr_reader :end_date
@@ -179,6 +262,8 @@ module Stripe
       attr_reader :invoice_settings
       # The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details.
       attr_reader :on_behalf_of
+      # 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_reader :phase_effective_at
       # The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices.
       attr_reader :transfer_data
 
@@ -514,6 +599,8 @@ module Stripe
         attr_reader :tax_rates
         # Options that configure the trial on the subscription item.
         attr_reader :trial
+        # The ID of the trial offer to apply to the configuration item.
+        attr_reader :trial_offer
 
         def self.inner_class_types
           @inner_class_types = {
@@ -602,6 +689,8 @@ module Stripe
       attr_reader :description
       # The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts.
       attr_reader :discounts
+      # 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_reader :effective_at
       # The end of this phase of the subscription schedule.
       attr_reader :end_date
       # The invoice settings applicable during this phase.
@@ -672,6 +761,8 @@ module Stripe
     attr_reader :billing_behavior
     # The billing mode of the subscription.
     attr_reader :billing_mode
+    # Billing schedules for this subscription schedule.
+    attr_reader :billing_schedules
     # Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
     attr_reader :canceled_at
     # Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch.
@@ -692,6 +783,8 @@ module Stripe
     attr_reader :id
     # Details of the most recent price migration that failed for the subscription schedule.
     attr_reader :last_price_migration_error
+    # The most recent invoice this subscription schedule has generated.
+    attr_reader :latest_invoice
     # 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.
@@ -717,6 +810,7 @@ module Stripe
       @inner_class_types = {
         applies_to: AppliesTo,
         billing_mode: BillingMode,
+        billing_schedules: BillingSchedule,
         current_phase: CurrentPhase,
         default_settings: DefaultSettings,
         last_price_migration_error: LastPriceMigrationError,

data/lib/stripe/resources/radar/account_evaluation.rb

@@ -0,0 +1,145 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Radar
+    # Account Evaluation resource returned by the Radar Account Evaluations API.
+    class AccountEvaluation < APIResource
+      extend Stripe::APIOperations::Create
+      include Stripe::APIOperations::Save
+
+      OBJECT_NAME = "radar.account_evaluation"
+      def self.object_name
+        "radar.account_evaluation"
+      end
+
+      class Event < ::Stripe::StripeObject
+        class LoginFailed < ::Stripe::StripeObject
+          # The reason why this login failed.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class RegistrationFailed < ::Stripe::StripeObject
+          # The reason why this registration failed.
+          attr_reader :reason
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Time at which the event occurred. Measured in seconds since the Unix epoch.
+        attr_reader :occurred_at
+        # The type of event that occurred.
+        attr_reader :type
+        # Data about a failed login event.
+        attr_reader :login_failed
+        # Data about a failed registration event.
+        attr_reader :registration_failed
+
+        def self.inner_class_types
+          @inner_class_types = { login_failed: LoginFailed, registration_failed: RegistrationFailed }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+
+      class Signals < ::Stripe::StripeObject
+        class AccountSharing < ::Stripe::StripeObject
+          # Score for this signal (float between 0.0-100.0).
+          attr_reader :score
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+
+        class MultiAccounting < ::Stripe::StripeObject
+          # Score for this signal (float between 0.0-100.0).
+          attr_reader :score
+
+          def self.inner_class_types
+            @inner_class_types = {}
+          end
+
+          def self.field_remappings
+            @field_remappings = {}
+          end
+        end
+        # Attribute for field account_sharing
+        attr_reader :account_sharing
+        # Attribute for field multi_accounting
+        attr_reader :multi_accounting
+
+        def self.inner_class_types
+          @inner_class_types = { account_sharing: AccountSharing, multi_accounting: MultiAccounting }
+        end
+
+        def self.field_remappings
+          @field_remappings = {}
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created_at
+      # The ID of the Stripe customer the account evaluation is associated with.
+      attr_reader :customer
+      # The list of events that were reported for this Account Evaluation object via the report API.
+      attr_reader :events
+      # Unique identifier for the object.
+      attr_reader :id
+      # 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
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # A hash of signal objects providing Radar's evaluation for the lifecycle event.
+      attr_reader :signals
+      # The type of evaluation returned, based on the user's request.
+      attr_reader :type
+
+      # Creates a new AccountEvaluation object.
+      def self.create(params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: "/v1/radar/account_evaluations",
+          params: params,
+          opts: opts
+        )
+      end
+
+      # Reports an event on an AccountEvaluation object.
+      def self.update(account_evaluation, params = {}, opts = {})
+        request_stripe_object(
+          method: :post,
+          path: format("/v1/radar/account_evaluations/%<account_evaluation>s/report_event", { account_evaluation: CGI.escape(account_evaluation) }),
+          params: params,
+          opts: opts
+        )
+      end
+
+      def self.inner_class_types
+        @inner_class_types = { events: Event, signals: Signals }
+      end
+
+      def self.field_remappings
+        @field_remappings = {}
+      end
+    end
+  end
+end