metronome-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

data/lib/metronome_sdk/models/v1/contract_create_response.rb

@@ -7,11 +7,11 @@ module MetronomeSDK
       class ContractCreateResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::ID]
-        required :data, -> { MetronomeSDK::Models::ID }
+        #   @return [MetronomeSDK::ID]
+        required :data, -> { MetronomeSDK::ID }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::ID]
+        #   @param data [MetronomeSDK::ID]
       end
     end
   end

data/lib/metronome_sdk/models/v1/contract_list_balances_params.rb

@@ -83,12 +83,10 @@ module MetronomeSDK
         #   @param include_archived [Boolean] Include archived credits and credits from archived contracts.
         #
         #   @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
-        #   ...
         #
         #   @param include_contract_balances [Boolean] Include balances on the contract level.
         #
         #   @param include_ledgers [Boolean] Include ledgers in the response. Setting this flag may cause the query to be slo
-        #   ...
         #
         #   @param next_page [String] The next page token from a previous response.
         #

data/lib/metronome_sdk/models/v1/contract_list_balances_response.rb

@@ -7,7 +7,7 @@ module MetronomeSDK
       class ContractListBalancesResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [Array<MetronomeSDK::Models::Commit, MetronomeSDK::Models::Credit>]
+        #   @return [Array<MetronomeSDK::Commit, MetronomeSDK::Credit>]
         required :data,
                  -> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::Models::V1::ContractListBalancesResponse::Data] }
 
@@ -17,18 +17,22 @@ module MetronomeSDK
         required :next_page, String, nil?: true
 
         # @!method initialize(data:, next_page:)
-        #   @param data [Array<MetronomeSDK::Models::Commit, MetronomeSDK::Models::Credit>]
+        #   @param data [Array<MetronomeSDK::Commit, MetronomeSDK::Credit>]
         #   @param next_page [String, nil]
 
         module Data
           extend MetronomeSDK::Internal::Type::Union
 
-          variant -> { MetronomeSDK::Models::Commit }
+          variant -> { MetronomeSDK::Commit }
 
-          variant -> { MetronomeSDK::Models::Credit }
+          variant -> { MetronomeSDK::Credit }
 
           # @!method self.variants
-          #   @return [Array(MetronomeSDK::Models::Commit, MetronomeSDK::Models::Credit)]
+          #   @return [Array(MetronomeSDK::Commit, MetronomeSDK::Credit)]
+
+          define_sorbet_constant!(:Variants) do
+            T.type_alias { T.any(MetronomeSDK::Commit, MetronomeSDK::Credit) }
+          end
         end
       end
     end

data/lib/metronome_sdk/models/v1/contract_list_params.rb

@@ -56,18 +56,14 @@ module MetronomeSDK
         #   @param customer_id [String]
         #
         #   @param covering_date [Time] Optional RFC 3339 timestamp. If provided, the response will include only contrac
-        #   ...
         #
         #   @param include_archived [Boolean] Include archived contracts in the response
         #
         #   @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
-        #   ...
         #
         #   @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
-        #   ...
         #
         #   @param starting_at [Time] Optional RFC 3339 timestamp. If provided, the response will include only contrac
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/metronome_sdk/models/v1/contract_list_response.rb

@@ -28,8 +28,8 @@ module MetronomeSDK
 
           # @!attribute current
           #
-          #   @return [MetronomeSDK::Models::ContractWithoutAmendments]
-          required :current, -> { MetronomeSDK::Models::ContractWithoutAmendments }
+          #   @return [MetronomeSDK::ContractWithoutAmendments]
+          required :current, -> { MetronomeSDK::ContractWithoutAmendments }
 
           # @!attribute customer_id
           #
@@ -38,8 +38,8 @@ module MetronomeSDK
 
           # @!attribute initial
           #
-          #   @return [MetronomeSDK::Models::ContractWithoutAmendments]
-          required :initial, -> { MetronomeSDK::Models::ContractWithoutAmendments }
+          #   @return [MetronomeSDK::ContractWithoutAmendments]
+          required :initial, -> { MetronomeSDK::ContractWithoutAmendments }
 
           # @!attribute archived_at
           #   RFC 3339 timestamp indicating when the contract was archived. If not returned,
@@ -60,6 +60,12 @@ module MetronomeSDK
           optional :customer_billing_provider_configuration,
                    -> { MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration }
 
+          # @!attribute prepaid_balance_threshold_configuration
+          #
+          #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration, nil]
+          optional :prepaid_balance_threshold_configuration,
+                   -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration }
+
           # @!attribute scheduled_charges_on_usage_invoices
           #   Determines which scheduled and commit charges to consolidate onto the Contract's
           #   usage invoice. The charge's `timestamp` must match the usage invoice's
@@ -71,6 +77,12 @@ module MetronomeSDK
           optional :scheduled_charges_on_usage_invoices,
                    enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::ScheduledChargesOnUsageInvoices }
 
+          # @!attribute spend_threshold_configuration
+          #
+          #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration, nil]
+          optional :spend_threshold_configuration,
+                   -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration }
+
           # @!attribute uniqueness_key
           #   Prevents the creation of duplicates. If a request to create a record is made
           #   with a previously used uniqueness key, a new record will not be created and the
@@ -79,7 +91,7 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :uniqueness_key, String
 
-          # @!method initialize(id:, amendments:, current:, customer_id:, initial:, archived_at: nil, custom_fields: nil, customer_billing_provider_configuration: nil, scheduled_charges_on_usage_invoices: nil, uniqueness_key: nil)
+          # @!method initialize(id:, amendments:, current:, customer_id:, initial:, archived_at: nil, custom_fields: nil, customer_billing_provider_configuration: nil, prepaid_balance_threshold_configuration: nil, scheduled_charges_on_usage_invoices: nil, spend_threshold_configuration: nil, uniqueness_key: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::ContractListResponse::Data} for more details.
           #
@@ -87,24 +99,25 @@ module MetronomeSDK
           #
           #   @param amendments [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment>]
           #
-          #   @param current [MetronomeSDK::Models::ContractWithoutAmendments]
+          #   @param current [MetronomeSDK::ContractWithoutAmendments]
           #
           #   @param customer_id [String]
           #
-          #   @param initial [MetronomeSDK::Models::ContractWithoutAmendments]
+          #   @param initial [MetronomeSDK::ContractWithoutAmendments]
           #
           #   @param archived_at [Time] RFC 3339 timestamp indicating when the contract was archived. If not returned, t
-          #   ...
           #
           #   @param custom_fields [Hash{Symbol=>String}]
           #
           #   @param customer_billing_provider_configuration [MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration] The billing provider configuration associated with a contract.
           #
+          #   @param prepaid_balance_threshold_configuration [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration]
+          #
           #   @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
-          #   ...
+          #
+          #   @param spend_threshold_configuration [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration]
           #
           #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
-          #   ...
 
           class Amendment < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute id
@@ -114,8 +127,8 @@ module MetronomeSDK
 
             # @!attribute commits
             #
-            #   @return [Array<MetronomeSDK::Models::Commit>]
-            required :commits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Commit] }
+            #   @return [Array<MetronomeSDK::Commit>]
+            required :commits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Commit] }
 
             # @!attribute created_at
             #
@@ -129,14 +142,16 @@ module MetronomeSDK
 
             # @!attribute overrides
             #
-            #   @return [Array<MetronomeSDK::Models::Override>]
-            required :overrides, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Override] }
+            #   @return [Array<MetronomeSDK::Override>]
+            required :overrides, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override] }
 
             # @!attribute scheduled_charges
             #
-            #   @return [Array<MetronomeSDK::Models::ScheduledCharge>]
+            #   @return [Array<MetronomeSDK::ScheduledCharge>]
             required :scheduled_charges,
-                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::ScheduledCharge] }
+                     -> {
+                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduledCharge]
+                     }
 
             # @!attribute starting_at
             #
@@ -145,14 +160,14 @@ module MetronomeSDK
 
             # @!attribute credits
             #
-            #   @return [Array<MetronomeSDK::Models::Credit>, nil]
-            optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Credit] }
+            #   @return [Array<MetronomeSDK::Credit>, nil]
+            optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Credit] }
 
             # @!attribute discounts
             #   This field's availability is dependent on your client's configuration.
             #
-            #   @return [Array<MetronomeSDK::Models::Discount>, nil]
-            optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Discount] }
+            #   @return [Array<MetronomeSDK::Discount>, nil]
+            optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Discount] }
 
             # @!attribute netsuite_sales_order_id
             #   This field's availability is dependent on your client's configuration.
@@ -163,9 +178,11 @@ module MetronomeSDK
             # @!attribute professional_services
             #   This field's availability is dependent on your client's configuration.
             #
-            #   @return [Array<MetronomeSDK::Models::ProService>, nil]
+            #   @return [Array<MetronomeSDK::ProService>, nil]
             optional :professional_services,
-                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::ProService] }
+                     -> {
+                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ProService]
+                     }
 
             # @!attribute reseller_royalties
             #   This field's availability is dependent on your client's configuration.
@@ -183,25 +200,25 @@ module MetronomeSDK
             # @!method initialize(id:, commits:, created_at:, created_by:, overrides:, scheduled_charges:, starting_at:, credits: nil, discounts: nil, netsuite_sales_order_id: nil, professional_services: nil, reseller_royalties: nil, salesforce_opportunity_id: nil)
             #   @param id [String]
             #
-            #   @param commits [Array<MetronomeSDK::Models::Commit>]
+            #   @param commits [Array<MetronomeSDK::Commit>]
             #
             #   @param created_at [Time]
             #
             #   @param created_by [String]
             #
-            #   @param overrides [Array<MetronomeSDK::Models::Override>]
+            #   @param overrides [Array<MetronomeSDK::Override>]
             #
-            #   @param scheduled_charges [Array<MetronomeSDK::Models::ScheduledCharge>]
+            #   @param scheduled_charges [Array<MetronomeSDK::ScheduledCharge>]
             #
             #   @param starting_at [Time]
             #
-            #   @param credits [Array<MetronomeSDK::Models::Credit>]
+            #   @param credits [Array<MetronomeSDK::Credit>]
             #
-            #   @param discounts [Array<MetronomeSDK::Models::Discount>] This field's availability is dependent on your client's configuration.
+            #   @param discounts [Array<MetronomeSDK::Discount>] This field's availability is dependent on your client's configuration.
             #
             #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
             #
-            #   @param professional_services [Array<MetronomeSDK::Models::ProService>] This field's availability is dependent on your client's configuration.
+            #   @param professional_services [Array<MetronomeSDK::ProService>] This field's availability is dependent on your client's configuration.
             #
             #   @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
             #
@@ -333,7 +350,6 @@ module MetronomeSDK
             #   @param id [String]
             #
             #   @param configuration [Hash{Symbol=>Object}] Configuration for the billing provider. The structure of this object is specific
-            #   ...
 
             # @see MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration#billing_provider
             module BillingProvider
@@ -366,6 +382,209 @@ module MetronomeSDK
             end
           end
 
+          # @see MetronomeSDK::Models::V1::ContractListResponse::Data#prepaid_balance_threshold_configuration
+          class PrepaidBalanceThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute commit
+            #
+            #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit]
+            required :commit,
+                     -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit }
+
+            # @!attribute is_enabled
+            #   When set to false, the contract will not be evaluated against the
+            #   threshold_amount. Toggling to true will result an immediate evaluation,
+            #   regardless of prior state.
+            #
+            #   @return [Boolean]
+            required :is_enabled, MetronomeSDK::Internal::Type::Boolean
+
+            # @!attribute payment_gate_config
+            #
+            #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig]
+            required :payment_gate_config,
+                     -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig }
+
+            # @!attribute recharge_to_amount
+            #   Specify the amount the balance should be recharged to.
+            #
+            #   @return [Float]
+            required :recharge_to_amount, Float
+
+            # @!attribute threshold_amount
+            #   Specify the threshold amount for the contract. Each time the contract's prepaid
+            #   balance lowers to this amount, a threshold charge will be initiated.
+            #
+            #   @return [Float]
+            required :threshold_amount, Float
+
+            # @!method initialize(commit:, is_enabled:, payment_gate_config:, recharge_to_amount:, threshold_amount:)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration}
+            #   for more details.
+            #
+            #   @param commit [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit]
+            #
+            #   @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
+            #
+            #   @param payment_gate_config [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig]
+            #
+            #   @param recharge_to_amount [Float] Specify the amount the balance should be recharged to.
+            #
+            #   @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's prepaid
+
+            # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration#commit
+            class Commit < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute product_id
+              #   The commit product that will be used to generate the line item for commit
+              #   payment.
+              #
+              #   @return [String]
+              required :product_id, String
+
+              # @!attribute applicable_product_ids
+              #   Which products the threshold commit applies to. If both applicable_product_ids
+              #   and applicable_product_tags are not provided, the commit applies to all
+              #   products.
+              #
+              #   @return [Array<String>, nil]
+              optional :applicable_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+              # @!attribute applicable_product_tags
+              #   Which tags the threshold commit applies to. If both applicable_product_ids and
+              #   applicable_product_tags are not provided, the commit applies to all products.
+              #
+              #   @return [Array<String>, nil]
+              optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+              # @!attribute description
+              #
+              #   @return [String, nil]
+              optional :description, String
+
+              # @!attribute name
+              #   Specify the name of the line item for the threshold charge. If left blank, it
+              #   will default to the commit product name.
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!method initialize(product_id:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, name: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::Commit}
+              #   for more details.
+              #
+              #   @param product_id [String] The commit product that will be used to generate the line item for commit paymen
+              #
+              #   @param applicable_product_ids [Array<String>] Which products the threshold commit applies to. If both applicable_product_ids a
+              #
+              #   @param applicable_product_tags [Array<String>] Which tags the threshold commit applies to. If both applicable_product_ids and a
+              #
+              #   @param description [String]
+              #
+              #   @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
+            end
+
+            # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration#payment_gate_config
+            class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute payment_gate_type
+              #   Gate access to the commit balance based on successful collection of payment.
+              #   Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+              #   facilitate payment using your own payment integration. Select NONE if you do not
+              #   wish to payment gate the commit balance.
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType]
+              required :payment_gate_type,
+                       enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType }
+
+              # @!attribute stripe_config
+              #   Only applicable if using Stripe as your payment gateway through Metronome.
+              #
+              #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
+              optional :stripe_config,
+                       -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig }
+
+              # @!attribute tax_type
+              #   Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+              #   not wish Metronome to calculate tax on your behalf. Leaving this field blank
+              #   will default to NONE.
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType, nil]
+              optional :tax_type,
+                       enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType }
+
+              # @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig}
+              #   for more details.
+              #
+              #   @param payment_gate_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
+              #
+              #   @param stripe_config [MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
+              #
+              #   @param tax_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
+
+              # Gate access to the commit balance based on successful collection of payment.
+              # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+              # facilitate payment using your own payment integration. Select NONE if you do not
+              # wish to payment gate the commit balance.
+              #
+              # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#payment_gate_type
+              module PaymentGateType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                NONE = :NONE
+                STRIPE = :STRIPE
+                EXTERNAL = :EXTERNAL
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#stripe_config
+              class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute payment_type
+                #   If left blank, will default to INVOICE
+                #
+                #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
+                required :payment_type,
+                         enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
+
+                # @!method initialize(payment_type:)
+                #   Only applicable if using Stripe as your payment gateway through Metronome.
+                #
+                #   @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
+
+                # If left blank, will default to INVOICE
+                #
+                # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
+                module PaymentType
+                  extend MetronomeSDK::Internal::Type::Enum
+
+                  INVOICE = :INVOICE
+                  PAYMENT_INTENT = :PAYMENT_INTENT
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+              # not wish Metronome to calculate tax on your behalf. Leaving this field blank
+              # will default to NONE.
+              #
+              # @see MetronomeSDK::Models::V1::ContractListResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig#tax_type
+              module TaxType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                NONE = :NONE
+                STRIPE = :STRIPE
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+
           # Determines which scheduled and commit charges to consolidate onto the Contract's
           # usage invoice. The charge's `timestamp` must match the usage invoice's
           # `ending_before` date for consolidation to occur. This field cannot be modified
@@ -381,6 +600,182 @@ module MetronomeSDK
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          # @see MetronomeSDK::Models::V1::ContractListResponse::Data#spend_threshold_configuration
+          class SpendThresholdConfiguration < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute commit
+            #
+            #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::Commit]
+            required :commit,
+                     -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::Commit }
+
+            # @!attribute is_enabled
+            #   When set to false, the contract will not be evaluated against the
+            #   threshold_amount. Toggling to true will result an immediate evaluation,
+            #   regardless of prior state.
+            #
+            #   @return [Boolean]
+            required :is_enabled, MetronomeSDK::Internal::Type::Boolean
+
+            # @!attribute payment_gate_config
+            #
+            #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig]
+            required :payment_gate_config,
+                     -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig }
+
+            # @!attribute threshold_amount
+            #   Specify the threshold amount for the contract. Each time the contract's usage
+            #   hits this amount, a threshold charge will be initiated.
+            #
+            #   @return [Float]
+            required :threshold_amount, Float
+
+            # @!method initialize(commit:, is_enabled:, payment_gate_config:, threshold_amount:)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration}
+            #   for more details.
+            #
+            #   @param commit [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::Commit]
+            #
+            #   @param is_enabled [Boolean] When set to false, the contract will not be evaluated against the threshold_amou
+            #
+            #   @param payment_gate_config [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig]
+            #
+            #   @param threshold_amount [Float] Specify the threshold amount for the contract. Each time the contract's usage hi
+
+            # @see MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration#commit
+            class Commit < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute product_id
+              #   The commit product that will be used to generate the line item for commit
+              #   payment.
+              #
+              #   @return [String]
+              required :product_id, String
+
+              # @!attribute description
+              #
+              #   @return [String, nil]
+              optional :description, String
+
+              # @!attribute name
+              #   Specify the name of the line item for the threshold charge. If left blank, it
+              #   will default to the commit product name.
+              #
+              #   @return [String, nil]
+              optional :name, String
+
+              # @!method initialize(product_id:, description: nil, name: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::Commit}
+              #   for more details.
+              #
+              #   @param product_id [String] The commit product that will be used to generate the line item for commit paymen
+              #
+              #   @param description [String]
+              #
+              #   @param name [String] Specify the name of the line item for the threshold charge. If left blank, it wi
+            end
+
+            # @see MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration#payment_gate_config
+            class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute payment_gate_type
+              #   Gate access to the commit balance based on successful collection of payment.
+              #   Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+              #   facilitate payment using your own payment integration. Select NONE if you do not
+              #   wish to payment gate the commit balance.
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType]
+              required :payment_gate_type,
+                       enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType }
+
+              # @!attribute stripe_config
+              #   Only applicable if using Stripe as your payment gateway through Metronome.
+              #
+              #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig, nil]
+              optional :stripe_config,
+                       -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig }
+
+              # @!attribute tax_type
+              #   Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+              #   not wish Metronome to calculate tax on your behalf. Leaving this field blank
+              #   will default to NONE.
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::TaxType, nil]
+              optional :tax_type,
+                       enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::TaxType }
+
+              # @!method initialize(payment_gate_type:, stripe_config: nil, tax_type: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig}
+              #   for more details.
+              #
+              #   @param payment_gate_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType] Gate access to the commit balance based on successful collection of payment. Sel
+              #
+              #   @param stripe_config [MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig] Only applicable if using Stripe as your payment gateway through Metronome.
+              #
+              #   @param tax_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::TaxType] Stripe tax is only supported for Stripe payment gateway. Select NONE if you do n
+
+              # Gate access to the commit balance based on successful collection of payment.
+              # Select STRIPE for Metronome to facilitate payment via Stripe. Select EXTERNAL to
+              # facilitate payment using your own payment integration. Select NONE if you do not
+              # wish to payment gate the commit balance.
+              #
+              # @see MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig#payment_gate_type
+              module PaymentGateType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                NONE = :NONE
+                STRIPE = :STRIPE
+                EXTERNAL = :EXTERNAL
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # @see MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig#stripe_config
+              class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
+                # @!attribute payment_type
+                #   If left blank, will default to INVOICE
+                #
+                #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType]
+                required :payment_type,
+                         enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType }
+
+                # @!method initialize(payment_type:)
+                #   Only applicable if using Stripe as your payment gateway through Metronome.
+                #
+                #   @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
+
+                # If left blank, will default to INVOICE
+                #
+                # @see MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig#payment_type
+                module PaymentType
+                  extend MetronomeSDK::Internal::Type::Enum
+
+                  INVOICE = :INVOICE
+                  PAYMENT_INTENT = :PAYMENT_INTENT
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
+              # not wish Metronome to calculate tax on your behalf. Leaving this field blank
+              # will default to NONE.
+              #
+              # @see MetronomeSDK::Models::V1::ContractListResponse::Data::SpendThresholdConfiguration::PaymentGateConfig#tax_type
+              module TaxType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                NONE = :NONE
+                STRIPE = :STRIPE
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
         end
       end
     end