metronome-sdk 3.5.0 → 3.7.0

data/rbi/metronome_sdk/models/contract_v2.rbi

@@ -286,12 +286,31 @@ module MetronomeSDK
       end
       attr_writer :spend_threshold_configuration
 
+      # Spend trackers attached to this contract.
+      sig do
+        returns(T.nilable(T::Array[MetronomeSDK::ContractV2::SpendTracker]))
+      end
+      attr_reader :spend_trackers
+
+      sig do
+        params(
+          spend_trackers:
+            T::Array[MetronomeSDK::ContractV2::SpendTracker::OrHash]
+        ).void
+      end
+      attr_writer :spend_trackers
+
       # List of subscriptions on the contract.
-      sig { returns(T.nilable(T::Array[MetronomeSDK::Subscription])) }
+      sig do
+        returns(T.nilable(T::Array[MetronomeSDK::ContractV2::Subscription]))
+      end
       attr_reader :subscriptions
 
       sig do
-        params(subscriptions: T::Array[MetronomeSDK::Subscription::OrHash]).void
+        params(
+          subscriptions:
+            T::Array[MetronomeSDK::ContractV2::Subscription::OrHash]
+        ).void
       end
       attr_writer :subscriptions
 
@@ -356,7 +375,10 @@ module MetronomeSDK
             MetronomeSDK::ContractV2::ScheduledChargesOnUsageInvoices::OrSymbol,
           spend_threshold_configuration:
             MetronomeSDK::SpendThresholdConfigurationV2::OrHash,
-          subscriptions: T::Array[MetronomeSDK::Subscription::OrHash],
+          spend_trackers:
+            T::Array[MetronomeSDK::ContractV2::SpendTracker::OrHash],
+          subscriptions:
+            T::Array[MetronomeSDK::ContractV2::Subscription::OrHash],
           total_contract_value: Float,
           uniqueness_key: String
         ).returns(T.attached_class)
@@ -416,6 +438,8 @@ module MetronomeSDK
         # on a separate invoice from usage charges.
         scheduled_charges_on_usage_invoices: nil,
         spend_threshold_configuration: nil,
+        # Spend trackers attached to this contract.
+        spend_trackers: nil,
         # List of subscriptions on the contract.
         subscriptions: nil,
         total_contract_value: nil,
@@ -470,7 +494,8 @@ module MetronomeSDK
               MetronomeSDK::ContractV2::ScheduledChargesOnUsageInvoices::TaggedSymbol,
             spend_threshold_configuration:
               MetronomeSDK::SpendThresholdConfigurationV2,
-            subscriptions: T::Array[MetronomeSDK::Subscription],
+            spend_trackers: T::Array[MetronomeSDK::ContractV2::SpendTracker],
+            subscriptions: T::Array[MetronomeSDK::ContractV2::Subscription],
             total_contract_value: Float,
             uniqueness_key: String
           }
@@ -737,6 +762,22 @@ module MetronomeSDK
         end
         attr_writer :specifiers
 
+        # Optional attributes controlling how this commit interacts with spend trackers.
+        sig do
+          returns(
+            T.nilable(MetronomeSDK::ContractV2::Commit::SpendTrackerAttributes)
+          )
+        end
+        attr_reader :spend_tracker_attributes
+
+        sig do
+          params(
+            spend_tracker_attributes:
+              MetronomeSDK::ContractV2::Commit::SpendTrackerAttributes::OrHash
+          ).void
+        end
+        attr_writer :spend_tracker_attributes
+
         # Attach a subscription to the recurring commit/credit.
         sig do
           returns(T.nilable(MetronomeSDK::RecurringCommitSubscriptionConfig))
@@ -800,6 +841,8 @@ module MetronomeSDK
             rollover_fraction: Float,
             salesforce_opportunity_id: String,
             specifiers: T::Array[MetronomeSDK::CommitSpecifier::OrHash],
+            spend_tracker_attributes:
+              MetronomeSDK::ContractV2::Commit::SpendTrackerAttributes::OrHash,
             subscription_config:
               MetronomeSDK::RecurringCommitSubscriptionConfig::OrHash
           ).returns(T.attached_class)
@@ -860,6 +903,8 @@ module MetronomeSDK
           # or credit. A customer's usage needs to meet the condition of at least one of the
           # specifiers to contribute to a commit's or credit's drawdown.
           specifiers: nil,
+          # Optional attributes controlling how this commit interacts with spend trackers.
+          spend_tracker_attributes: nil,
           # Attach a subscription to the recurring commit/credit.
           subscription_config: nil
         )
@@ -899,6 +944,8 @@ module MetronomeSDK
               rollover_fraction: Float,
               salesforce_opportunity_id: String,
               specifiers: T::Array[MetronomeSDK::CommitSpecifier],
+              spend_tracker_attributes:
+                MetronomeSDK::ContractV2::Commit::SpendTrackerAttributes,
               subscription_config:
                 MetronomeSDK::RecurringCommitSubscriptionConfig
             }
@@ -2331,6 +2378,36 @@ module MetronomeSDK
           def to_hash
           end
         end
+
+        class SpendTrackerAttributes < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractV2::Commit::SpendTrackerAttributes,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # If true, this commit is included in spend trackers with discounted set to
+          # DISCOUNTED_ONLY
+          sig { returns(T::Boolean) }
+          attr_accessor :counts_as_discounted
+
+          # Optional attributes controlling how this commit interacts with spend trackers.
+          sig do
+            params(counts_as_discounted: T::Boolean).returns(T.attached_class)
+          end
+          def self.new(
+            # If true, this commit is included in spend trackers with discounted set to
+            # DISCOUNTED_ONLY
+            counts_as_discounted:
+          )
+          end
+
+          sig { override.returns({ counts_as_discounted: T::Boolean }) }
+          def to_hash
+          end
+        end
       end
 
       class Override < MetronomeSDK::Internal::Type::BaseModel
@@ -3211,6 +3288,12 @@ module MetronomeSDK
         sig { params(applicable_product_tags: T::Array[String]).void }
         attr_writer :applicable_product_tags
 
+        sig { returns(T.nilable(Time)) }
+        attr_reader :archived_at
+
+        sig { params(archived_at: Time).void }
+        attr_writer :archived_at
+
         # The current balance of the credit or commit. This balance reflects the amount of
         # credit or commit that the customer has access to use at this moment - thus,
         # expired and upcoming credit or commit segments contribute 0 to the balance. The
@@ -3384,6 +3467,7 @@ module MetronomeSDK
             applicable_contract_ids: T::Array[String],
             applicable_product_ids: T::Array[String],
             applicable_product_tags: T::Array[String],
+            archived_at: Time,
             balance: Float,
             contract: MetronomeSDK::ContractV2::Credit::Contract::OrHash,
             created_at: Time,
@@ -3425,6 +3509,7 @@ module MetronomeSDK
           applicable_contract_ids: nil,
           applicable_product_ids: nil,
           applicable_product_tags: nil,
+          archived_at: nil,
           # The current balance of the credit or commit. This balance reflects the amount of
           # credit or commit that the customer has access to use at this moment - thus,
           # expired and upcoming credit or commit segments contribute 0 to the balance. The
@@ -3478,6 +3563,7 @@ module MetronomeSDK
               applicable_contract_ids: T::Array[String],
               applicable_product_ids: T::Array[String],
               applicable_product_tags: T::Array[String],
+              archived_at: Time,
               balance: Float,
               contract: MetronomeSDK::ContractV2::Credit::Contract,
               created_at: Time,
@@ -6664,6 +6750,1088 @@ module MetronomeSDK
         def self.values
         end
       end
+
+      class SpendTracker < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::ContractV2::SpendTracker,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # Human-readable identifier, unique per contract.
+        sig { returns(String) }
+        attr_accessor :alias_
+
+        sig do
+          returns(
+            T::Array[
+              MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier
+            ]
+          )
+        end
+        attr_accessor :applicable_spend_specifiers
+
+        sig { returns(String) }
+        attr_accessor :credit_type_id
+
+        sig do
+          returns(
+            MetronomeSDK::ContractV2::SpendTracker::ResetFrequency::TaggedSymbol
+          )
+        end
+        attr_accessor :reset_frequency
+
+        sig do
+          returns(
+            T.nilable(MetronomeSDK::ContractV2::SpendTracker::AccumulatedSpend)
+          )
+        end
+        attr_reader :accumulated_spend
+
+        sig do
+          params(
+            accumulated_spend:
+              MetronomeSDK::ContractV2::SpendTracker::AccumulatedSpend::OrHash
+          ).void
+        end
+        attr_writer :accumulated_spend
+
+        sig do
+          params(
+            alias_: String,
+            applicable_spend_specifiers:
+              T::Array[
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::OrHash
+              ],
+            credit_type_id: String,
+            reset_frequency:
+              MetronomeSDK::ContractV2::SpendTracker::ResetFrequency::OrSymbol,
+            accumulated_spend:
+              MetronomeSDK::ContractV2::SpendTracker::AccumulatedSpend::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Human-readable identifier, unique per contract.
+          alias_:,
+          applicable_spend_specifiers:,
+          credit_type_id:,
+          reset_frequency:,
+          accumulated_spend: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              alias_: String,
+              applicable_spend_specifiers:
+                T::Array[
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier
+                ],
+              credit_type_id: String,
+              reset_frequency:
+                MetronomeSDK::ContractV2::SpendTracker::ResetFrequency::TaggedSymbol,
+              accumulated_spend:
+                MetronomeSDK::ContractV2::SpendTracker::AccumulatedSpend
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class ApplicableSpendSpecifier < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T::Array[
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+              ]
+            )
+          end
+          attr_accessor :sources
+
+          sig do
+            returns(
+              MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::SpendType::TaggedSymbol
+            )
+          end
+          attr_accessor :spend_type
+
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :discounted
+
+          sig do
+            params(
+              discounted:
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted::OrSymbol
+            ).void
+          end
+          attr_writer :discounted
+
+          sig do
+            params(
+              sources:
+                T::Array[
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Source::OrSymbol
+                ],
+              spend_type:
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::SpendType::OrSymbol,
+              discounted:
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted::OrSymbol
+            ).returns(T.attached_class)
+          end
+          def self.new(sources:, spend_type:, discounted: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                sources:
+                  T::Array[
+                    MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+                  ],
+                spend_type:
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::SpendType::TaggedSymbol,
+                discounted:
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Source
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Source
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            THRESHOLD_RECHARGE =
+              T.let(
+                :THRESHOLD_RECHARGE,
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+              )
+            MANUAL =
+              T.let(
+                :MANUAL,
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Source::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module SpendType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::SpendType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            COMMIT_PURCHASE =
+              T.let(
+                :COMMIT_PURCHASE,
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::SpendType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::SpendType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Discounted
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ANY =
+              T.let(
+                :ANY,
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              )
+            DISCOUNTED_ONLY =
+              T.let(
+                :DISCOUNTED_ONLY,
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              )
+            UNDISCOUNTED_ONLY =
+              T.let(
+                :UNDISCOUNTED_ONLY,
+                MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractV2::SpendTracker::ApplicableSpendSpecifier::Discounted::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        module ResetFrequency
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::ContractV2::SpendTracker::ResetFrequency
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BILLING_PERIOD =
+            T.let(
+              :BILLING_PERIOD,
+              MetronomeSDK::ContractV2::SpendTracker::ResetFrequency::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::ContractV2::SpendTracker::ResetFrequency::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class AccumulatedSpend < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractV2::SpendTracker::AccumulatedSpend,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Float) }
+          attr_accessor :amount
+
+          sig { returns(Time) }
+          attr_accessor :period_ending_before
+
+          sig { returns(Time) }
+          attr_accessor :period_starting_at
+
+          sig do
+            params(
+              amount: Float,
+              period_ending_before: Time,
+              period_starting_at: Time
+            ).returns(T.attached_class)
+          end
+          def self.new(amount:, period_ending_before:, period_starting_at:)
+          end
+
+          sig do
+            override.returns(
+              {
+                amount: Float,
+                period_ending_before: Time,
+                period_starting_at: Time
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+
+      class Subscription < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::ContractV2::Subscription,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # Previous, current, and next billing periods for the subscription.
+        sig { returns(MetronomeSDK::ContractV2::Subscription::BillingPeriods) }
+        attr_reader :billing_periods
+
+        sig do
+          params(
+            billing_periods:
+              MetronomeSDK::ContractV2::Subscription::BillingPeriods::OrHash
+          ).void
+        end
+        attr_writer :billing_periods
+
+        sig do
+          returns(
+            MetronomeSDK::ContractV2::Subscription::CollectionSchedule::TaggedSymbol
+          )
+        end
+        attr_accessor :collection_schedule
+
+        sig { returns(MetronomeSDK::ContractV2::Subscription::Proration) }
+        attr_reader :proration
+
+        sig do
+          params(
+            proration: MetronomeSDK::ContractV2::Subscription::Proration::OrHash
+          ).void
+        end
+        attr_writer :proration
+
+        # Determines how the subscription's quantity is controlled. Defaults to
+        # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
+        # directly on the subscription. `initial_quantity` must be provided with this
+        # option. Compatible with recurring commits/credits that use POOLED allocation.
+        # **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+        # user_123) to increment and decrement a subscription quantity, rather than
+        # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+        # use a linked recurring credit with an allocation per seat. `seat_config` must be
+        # provided with this option.
+        sig do
+          returns(
+            MetronomeSDK::ContractV2::Subscription::QuantityManagementMode::TaggedSymbol
+          )
+        end
+        attr_accessor :quantity_management_mode
+
+        # List of quantity schedule items for the subscription. Only includes the current
+        # quantity and future quantity changes.
+        sig do
+          returns(
+            T::Array[MetronomeSDK::ContractV2::Subscription::QuantitySchedule]
+          )
+        end
+        attr_accessor :quantity_schedule
+
+        sig { returns(Time) }
+        attr_accessor :starting_at
+
+        sig do
+          returns(MetronomeSDK::ContractV2::Subscription::SubscriptionRate)
+        end
+        attr_reader :subscription_rate
+
+        sig do
+          params(
+            subscription_rate:
+              MetronomeSDK::ContractV2::Subscription::SubscriptionRate::OrHash
+          ).void
+        end
+        attr_writer :subscription_rate
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :custom_fields
+
+        sig { params(custom_fields: T::Hash[Symbol, String]).void }
+        attr_writer :custom_fields
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :ending_before
+
+        sig { params(ending_before: Time).void }
+        attr_writer :ending_before
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :fiat_credit_type_id
+
+        sig { params(fiat_credit_type_id: String).void }
+        attr_writer :fiat_credit_type_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig do
+          returns(T.nilable(MetronomeSDK::ContractV2::Subscription::SeatConfig))
+        end
+        attr_reader :seat_config
+
+        sig do
+          params(
+            seat_config:
+              MetronomeSDK::ContractV2::Subscription::SeatConfig::OrHash
+          ).void
+        end
+        attr_writer :seat_config
+
+        sig do
+          params(
+            billing_periods:
+              MetronomeSDK::ContractV2::Subscription::BillingPeriods::OrHash,
+            collection_schedule:
+              MetronomeSDK::ContractV2::Subscription::CollectionSchedule::OrSymbol,
+            proration:
+              MetronomeSDK::ContractV2::Subscription::Proration::OrHash,
+            quantity_management_mode:
+              MetronomeSDK::ContractV2::Subscription::QuantityManagementMode::OrSymbol,
+            quantity_schedule:
+              T::Array[
+                MetronomeSDK::ContractV2::Subscription::QuantitySchedule::OrHash
+              ],
+            starting_at: Time,
+            subscription_rate:
+              MetronomeSDK::ContractV2::Subscription::SubscriptionRate::OrHash,
+            id: String,
+            custom_fields: T::Hash[Symbol, String],
+            description: String,
+            ending_before: Time,
+            fiat_credit_type_id: String,
+            name: String,
+            seat_config:
+              MetronomeSDK::ContractV2::Subscription::SeatConfig::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Previous, current, and next billing periods for the subscription.
+          billing_periods:,
+          collection_schedule:,
+          proration:,
+          # Determines how the subscription's quantity is controlled. Defaults to
+          # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
+          # directly on the subscription. `initial_quantity` must be provided with this
+          # option. Compatible with recurring commits/credits that use POOLED allocation.
+          # **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+          # user_123) to increment and decrement a subscription quantity, rather than
+          # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+          # use a linked recurring credit with an allocation per seat. `seat_config` must be
+          # provided with this option.
+          quantity_management_mode:,
+          # List of quantity schedule items for the subscription. Only includes the current
+          # quantity and future quantity changes.
+          quantity_schedule:,
+          starting_at:,
+          subscription_rate:,
+          id: nil,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+          custom_fields: nil,
+          description: nil,
+          ending_before: nil,
+          fiat_credit_type_id: nil,
+          name: nil,
+          seat_config: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              billing_periods:
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods,
+              collection_schedule:
+                MetronomeSDK::ContractV2::Subscription::CollectionSchedule::TaggedSymbol,
+              proration: MetronomeSDK::ContractV2::Subscription::Proration,
+              quantity_management_mode:
+                MetronomeSDK::ContractV2::Subscription::QuantityManagementMode::TaggedSymbol,
+              quantity_schedule:
+                T::Array[
+                  MetronomeSDK::ContractV2::Subscription::QuantitySchedule
+                ],
+              starting_at: Time,
+              subscription_rate:
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate,
+              id: String,
+              custom_fields: T::Hash[Symbol, String],
+              description: String,
+              ending_before: Time,
+              fiat_credit_type_id: String,
+              name: String,
+              seat_config: MetronomeSDK::ContractV2::Subscription::SeatConfig
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class BillingPeriods < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Current
+              )
+            )
+          end
+          attr_reader :current
+
+          sig do
+            params(
+              current:
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Current::OrHash
+            ).void
+          end
+          attr_writer :current
+
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Next
+              )
+            )
+          end
+          attr_reader :next_
+
+          sig do
+            params(
+              next_:
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Next::OrHash
+            ).void
+          end
+          attr_writer :next_
+
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Previous
+              )
+            )
+          end
+          attr_reader :previous
+
+          sig do
+            params(
+              previous:
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Previous::OrHash
+            ).void
+          end
+          attr_writer :previous
+
+          # Previous, current, and next billing periods for the subscription.
+          sig do
+            params(
+              current:
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Current::OrHash,
+              next_:
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Next::OrHash,
+              previous:
+                MetronomeSDK::ContractV2::Subscription::BillingPeriods::Previous::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(current: nil, next_: nil, previous: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                current:
+                  MetronomeSDK::ContractV2::Subscription::BillingPeriods::Current,
+                next_:
+                  MetronomeSDK::ContractV2::Subscription::BillingPeriods::Next,
+                previous:
+                  MetronomeSDK::ContractV2::Subscription::BillingPeriods::Previous
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Current < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractV2::Subscription::BillingPeriods::Current,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Time) }
+            attr_accessor :ending_before
+
+            sig { returns(Time) }
+            attr_accessor :starting_at
+
+            sig do
+              params(ending_before: Time, starting_at: Time).returns(
+                T.attached_class
+              )
+            end
+            def self.new(ending_before:, starting_at:)
+            end
+
+            sig { override.returns({ ending_before: Time, starting_at: Time }) }
+            def to_hash
+            end
+          end
+
+          class Next < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractV2::Subscription::BillingPeriods::Next,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Time) }
+            attr_accessor :ending_before
+
+            sig { returns(Time) }
+            attr_accessor :starting_at
+
+            sig do
+              params(ending_before: Time, starting_at: Time).returns(
+                T.attached_class
+              )
+            end
+            def self.new(ending_before:, starting_at:)
+            end
+
+            sig { override.returns({ ending_before: Time, starting_at: Time }) }
+            def to_hash
+            end
+          end
+
+          class Previous < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractV2::Subscription::BillingPeriods::Previous,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(Time) }
+            attr_accessor :ending_before
+
+            sig { returns(Time) }
+            attr_accessor :starting_at
+
+            sig do
+              params(ending_before: Time, starting_at: Time).returns(
+                T.attached_class
+              )
+            end
+            def self.new(ending_before:, starting_at:)
+            end
+
+            sig { override.returns({ ending_before: Time, starting_at: Time }) }
+            def to_hash
+            end
+          end
+        end
+
+        module CollectionSchedule
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::ContractV2::Subscription::CollectionSchedule
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ADVANCE =
+            T.let(
+              :ADVANCE,
+              MetronomeSDK::ContractV2::Subscription::CollectionSchedule::TaggedSymbol
+            )
+          ARREARS =
+            T.let(
+              :ARREARS,
+              MetronomeSDK::ContractV2::Subscription::CollectionSchedule::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::ContractV2::Subscription::CollectionSchedule::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Proration < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractV2::Subscription::Proration,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              MetronomeSDK::ContractV2::Subscription::Proration::InvoiceBehavior::TaggedSymbol
+            )
+          end
+          attr_accessor :invoice_behavior
+
+          sig { returns(T::Boolean) }
+          attr_accessor :is_prorated
+
+          sig do
+            params(
+              invoice_behavior:
+                MetronomeSDK::ContractV2::Subscription::Proration::InvoiceBehavior::OrSymbol,
+              is_prorated: T::Boolean
+            ).returns(T.attached_class)
+          end
+          def self.new(invoice_behavior:, is_prorated:)
+          end
+
+          sig do
+            override.returns(
+              {
+                invoice_behavior:
+                  MetronomeSDK::ContractV2::Subscription::Proration::InvoiceBehavior::TaggedSymbol,
+                is_prorated: T::Boolean
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module InvoiceBehavior
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::ContractV2::Subscription::Proration::InvoiceBehavior
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            BILL_IMMEDIATELY =
+              T.let(
+                :BILL_IMMEDIATELY,
+                MetronomeSDK::ContractV2::Subscription::Proration::InvoiceBehavior::TaggedSymbol
+              )
+            BILL_ON_NEXT_COLLECTION_DATE =
+              T.let(
+                :BILL_ON_NEXT_COLLECTION_DATE,
+                MetronomeSDK::ContractV2::Subscription::Proration::InvoiceBehavior::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractV2::Subscription::Proration::InvoiceBehavior::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
+        # Determines how the subscription's quantity is controlled. Defaults to
+        # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
+        # directly on the subscription. `initial_quantity` must be provided with this
+        # option. Compatible with recurring commits/credits that use POOLED allocation.
+        # **SEAT_BASED**: Use when you want to pass specific seat identifiers (e.g. add
+        # user_123) to increment and decrement a subscription quantity, rather than
+        # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+        # use a linked recurring credit with an allocation per seat. `seat_config` must be
+        # provided with this option.
+        module QuantityManagementMode
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                MetronomeSDK::ContractV2::Subscription::QuantityManagementMode
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SEAT_BASED =
+            T.let(
+              :SEAT_BASED,
+              MetronomeSDK::ContractV2::Subscription::QuantityManagementMode::TaggedSymbol
+            )
+          QUANTITY_ONLY =
+            T.let(
+              :QUANTITY_ONLY,
+              MetronomeSDK::ContractV2::Subscription::QuantityManagementMode::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::ContractV2::Subscription::QuantityManagementMode::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class QuantitySchedule < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractV2::Subscription::QuantitySchedule,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Float) }
+          attr_accessor :quantity
+
+          sig { returns(Time) }
+          attr_accessor :starting_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_reader :ending_before
+
+          sig { params(ending_before: Time).void }
+          attr_writer :ending_before
+
+          sig do
+            params(
+              quantity: Float,
+              starting_at: Time,
+              ending_before: Time
+            ).returns(T.attached_class)
+          end
+          def self.new(quantity:, starting_at:, ending_before: nil)
+          end
+
+          sig do
+            override.returns(
+              { quantity: Float, starting_at: Time, ending_before: Time }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class SubscriptionRate < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+            )
+          end
+          attr_accessor :billing_frequency
+
+          sig do
+            returns(
+              MetronomeSDK::ContractV2::Subscription::SubscriptionRate::Product
+            )
+          end
+          attr_reader :product
+
+          sig do
+            params(
+              product:
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate::Product::OrHash
+            ).void
+          end
+          attr_writer :product
+
+          sig do
+            params(
+              billing_frequency:
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency::OrSymbol,
+              product:
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate::Product::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(billing_frequency:, product:)
+          end
+
+          sig do
+            override.returns(
+              {
+                billing_frequency:
+                  MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol,
+                product:
+                  MetronomeSDK::ContractV2::Subscription::SubscriptionRate::Product
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module BillingFrequency
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            MONTHLY =
+              T.let(
+                :MONTHLY,
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+              )
+            QUARTERLY =
+              T.let(
+                :QUARTERLY,
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+              )
+            ANNUAL =
+              T.let(
+                :ANNUAL,
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+              )
+            WEEKLY =
+              T.let(
+                :WEEKLY,
+                MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class Product < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::ContractV2::Subscription::SubscriptionRate::Product,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :id
+
+            sig { returns(String) }
+            attr_accessor :name
+
+            sig { params(id: String, name: String).returns(T.attached_class) }
+            def self.new(id:, name:)
+            end
+
+            sig { override.returns({ id: String, name: String }) }
+            def to_hash
+            end
+          end
+        end
+
+        class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::ContractV2::Subscription::SeatConfig,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          # The property name, sent on usage events, that identifies the seat ID associated
+          # with the usage event. For example, the property name might be seat_id or
+          # user_id. The property must be set as a group key on billable metrics and a
+          # presentation/pricing group key on contract products. This allows linked
+          # recurring credits with an allocation per seat to be consumed by only one seat's
+          # usage.
+          sig { returns(String) }
+          attr_accessor :seat_group_key
+
+          sig { params(seat_group_key: String).returns(T.attached_class) }
+          def self.new(
+            # The property name, sent on usage events, that identifies the seat ID associated
+            # with the usage event. For example, the property name might be seat_id or
+            # user_id. The property must be set as a group key on billable metrics and a
+            # presentation/pricing group key on contract products. This allows linked
+            # recurring credits with an allocation per seat to be consumed by only one seat's
+            # usage.
+            seat_group_key:
+          )
+          end
+
+          sig { override.returns({ seat_group_key: String }) }
+          def to_hash
+          end
+        end
+      end
     end
   end
 end