metronome-sdk 3.4.0 → 3.6.0

data/lib/metronome_sdk/models/contract_v2.rb

@@ -200,8 +200,9 @@ module MetronomeSDK
       # @!attribute subscriptions
       #   List of subscriptions on the contract.
       #
-      #   @return [Array<MetronomeSDK::Models::Subscription>, nil]
-      optional :subscriptions, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Subscription] }
+      #   @return [Array<MetronomeSDK::Models::ContractV2::Subscription>, nil]
+      optional :subscriptions,
+               -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::Subscription] }
 
       # @!attribute total_contract_value
       #
@@ -284,7 +285,7 @@ module MetronomeSDK
       #
       #   @param spend_threshold_configuration [MetronomeSDK::Models::SpendThresholdConfigurationV2]
       #
-      #   @param subscriptions [Array<MetronomeSDK::Models::Subscription>] List of subscriptions on the contract.
+      #   @param subscriptions [Array<MetronomeSDK::Models::ContractV2::Subscription>] List of subscriptions on the contract.
       #
       #   @param total_contract_value [Float]
       #
@@ -1237,6 +1238,11 @@ module MetronomeSDK
         #   @return [String]
         required :id, String
 
+        # @!attribute created_at
+        #
+        #   @return [Time]
+        required :created_at, Time
+
         # @!attribute starting_at
         #
         #   @return [Time]
@@ -1303,8 +1309,9 @@ module MetronomeSDK
         #   @return [Symbol, MetronomeSDK::Models::ContractV2::Override::Type, nil]
         optional :type, enum: -> { MetronomeSDK::ContractV2::Override::Type }
 
-        # @!method initialize(id:, starting_at:, applicable_product_tags: nil, ending_before: nil, entitled: nil, is_commit_specific: nil, multiplier: nil, override_specifiers: nil, override_tiers: nil, overwrite_rate: nil, priority: nil, product: nil, target: nil, type: nil)
+        # @!method initialize(id:, created_at:, starting_at:, applicable_product_tags: nil, ending_before: nil, entitled: nil, is_commit_specific: nil, multiplier: nil, override_specifiers: nil, override_tiers: nil, overwrite_rate: nil, priority: nil, product: nil, target: nil, type: nil)
         #   @param id [String]
+        #   @param created_at [Time]
         #   @param starting_at [Time]
         #   @param applicable_product_tags [Array<String>]
         #   @param ending_before [Time]
@@ -1356,12 +1363,7 @@ module MetronomeSDK
           #   @return [Array<String>, nil]
           optional :recurring_commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
 
-          # @!attribute recurring_credit_ids
-          #
-          #   @return [Array<String>, nil]
-          optional :recurring_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!method initialize(billing_frequency: nil, commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil, recurring_credit_ids: nil)
+          # @!method initialize(billing_frequency: nil, commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil)
           #   @param billing_frequency [Symbol, MetronomeSDK::Models::ContractV2::Override::OverrideSpecifier::BillingFrequency]
           #   @param commit_ids [Array<String>]
           #   @param presentation_group_values [Hash{Symbol=>String, nil}]
@@ -1369,7 +1371,6 @@ module MetronomeSDK
           #   @param product_id [String]
           #   @param product_tags [Array<String>]
           #   @param recurring_commit_ids [Array<String>]
-          #   @param recurring_credit_ids [Array<String>]
 
           # @see MetronomeSDK::Models::ContractV2::Override::OverrideSpecifier#billing_frequency
           module BillingFrequency
@@ -1645,6 +1646,11 @@ module MetronomeSDK
         #   @return [Array<String>, nil]
         optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
 
+        # @!attribute archived_at
+        #
+        #   @return [Time, nil]
+        optional :archived_at, Time
+
         # @!attribute balance
         #   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,
@@ -1693,7 +1699,7 @@ module MetronomeSDK
         #   A list of ordered events that impact the balance of a credit. For example, an
         #   invoice deduction or an expiration.
         #
-        #   @return [Array<MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry>, nil]
+        #   @return [Array<MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry>, nil]
         optional :ledger,
                  -> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::ContractV2::Credit::Ledger] }
 
@@ -1721,6 +1727,11 @@ module MetronomeSDK
         #   @return [String, nil]
         optional :recurring_credit_id, String
 
+        # @!attribute rolled_over_from
+        #
+        #   @return [MetronomeSDK::Models::ContractV2::Credit::RolledOverFrom, nil]
+        optional :rolled_over_from, -> { MetronomeSDK::ContractV2::Credit::RolledOverFrom }
+
         # @!attribute salesforce_opportunity_id
         #   This field's availability is dependent on your client's configuration.
         #
@@ -1741,7 +1752,7 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
         optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
 
-        # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, created_at: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, recurring_credit_id: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
+        # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, created_at: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, recurring_credit_id: nil, rolled_over_from: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractV2::Credit} for more details.
         #
@@ -1759,6 +1770,8 @@ module MetronomeSDK
         #
         #   @param applicable_product_tags [Array<String>]
         #
+        #   @param archived_at [Time]
+        #
         #   @param balance [Float] The current balance of the credit or commit. This balance reflects the amount of
         #
         #   @param contract [MetronomeSDK::Models::ContractV2::Credit::Contract]
@@ -1771,7 +1784,7 @@ module MetronomeSDK
         #
         #   @param hierarchy_configuration [MetronomeSDK::Models::CommitHierarchyConfiguration] Optional configuration for credit hierarchy access control
         #
-        #   @param ledger [Array<MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry>] A list of ordered events that impact the balance of a credit. For example, an in
+        #   @param ledger [Array<MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry>] A list of ordered events that impact the balance of a credit. For example, an in
         #
         #   @param name [String]
         #
@@ -1781,6 +1794,8 @@ module MetronomeSDK
         #
         #   @param recurring_credit_id [String] The ID of the recurring credit that created this credit
         #
+        #   @param rolled_over_from [MetronomeSDK::Models::ContractV2::Credit::RolledOverFrom]
+        #
         #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
         #
         #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
@@ -1842,6 +1857,8 @@ module MetronomeSDK
 
           variant -> { MetronomeSDK::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry }
 
+          variant -> { MetronomeSDK::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry }
+
           class CreditSegmentStartLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute amount
             #
@@ -2146,8 +2163,69 @@ module MetronomeSDK
             end
           end
 
+          class CreditRolloverLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute amount
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute new_contract_id
+            #
+            #   @return [String]
+            required :new_contract_id, String
+
+            # @!attribute segment_id
+            #
+            #   @return [String]
+            required :segment_id, String
+
+            # @!attribute timestamp
+            #
+            #   @return [Time]
+            required :timestamp, Time
+
+            # @!attribute type
+            #
+            #   @return [Symbol, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry::Type]
+            required :type, enum: -> { MetronomeSDK::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry::Type }
+
+            # @!method initialize(amount:, new_contract_id:, segment_id:, timestamp:, type:)
+            #   @param amount [Float]
+            #   @param new_contract_id [String]
+            #   @param segment_id [String]
+            #   @param timestamp [Time]
+            #   @param type [Symbol, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry::Type]
+
+            # @see MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry#type
+            module Type
+              extend MetronomeSDK::Internal::Type::Enum
+
+              CREDIT_ROLLOVER = :CREDIT_ROLLOVER
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
           # @!method self.variants
-          #   @return [Array(MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry)]
+          #   @return [Array(MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSegmentStartLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditAutomatedInvoiceDeductionLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditExpirationLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCanceledLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditCreditedLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditManualLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditSeatBasedAdjustmentLedgerEntry, MetronomeSDK::Models::ContractV2::Credit::Ledger::CreditRolloverLedgerEntry)]
+        end
+
+        # @see MetronomeSDK::Models::ContractV2::Credit#rolled_over_from
+        class RolledOverFrom < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute contract_id
+          #
+          #   @return [String]
+          required :contract_id, String
+
+          # @!attribute credit_id
+          #
+          #   @return [String]
+          required :credit_id, String
+
+          # @!method initialize(contract_id:, credit_id:)
+          #   @param contract_id [String]
+          #   @param credit_id [String]
         end
       end
 
@@ -3227,6 +3305,356 @@ module MetronomeSDK
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      class Subscription < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute billing_periods
+        #   Previous, current, and next billing periods for the subscription.
+        #
+        #   @return [MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods]
+        required :billing_periods, -> { MetronomeSDK::ContractV2::Subscription::BillingPeriods }
+
+        # @!attribute collection_schedule
+        #
+        #   @return [Symbol, MetronomeSDK::Models::ContractV2::Subscription::CollectionSchedule]
+        required :collection_schedule, enum: -> { MetronomeSDK::ContractV2::Subscription::CollectionSchedule }
+
+        # @!attribute proration
+        #
+        #   @return [MetronomeSDK::Models::ContractV2::Subscription::Proration]
+        required :proration, -> { MetronomeSDK::ContractV2::Subscription::Proration }
+
+        # @!attribute quantity_management_mode
+        #   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.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::ContractV2::Subscription::QuantityManagementMode]
+        required :quantity_management_mode,
+                 enum: -> { MetronomeSDK::ContractV2::Subscription::QuantityManagementMode }
+
+        # @!attribute quantity_schedule
+        #   List of quantity schedule items for the subscription. Only includes the current
+        #   quantity and future quantity changes.
+        #
+        #   @return [Array<MetronomeSDK::Models::ContractV2::Subscription::QuantitySchedule>]
+        required :quantity_schedule,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::Subscription::QuantitySchedule] }
+
+        # @!attribute starting_at
+        #
+        #   @return [Time]
+        required :starting_at, Time
+
+        # @!attribute subscription_rate
+        #
+        #   @return [MetronomeSDK::Models::ContractV2::Subscription::SubscriptionRate]
+        required :subscription_rate, -> { MetronomeSDK::ContractV2::Subscription::SubscriptionRate }
+
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute custom_fields
+        #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute ending_before
+        #
+        #   @return [Time, nil]
+        optional :ending_before, Time
+
+        # @!attribute fiat_credit_type_id
+        #
+        #   @return [String, nil]
+        optional :fiat_credit_type_id, String
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute seat_config
+        #
+        #   @return [MetronomeSDK::Models::ContractV2::Subscription::SeatConfig, nil]
+        optional :seat_config, -> { MetronomeSDK::ContractV2::Subscription::SeatConfig }
+
+        # @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil, seat_config: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::ContractV2::Subscription} for more details.
+        #
+        #   @param billing_periods [MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods] Previous, current, and next billing periods for the subscription.
+        #
+        #   @param collection_schedule [Symbol, MetronomeSDK::Models::ContractV2::Subscription::CollectionSchedule]
+        #
+        #   @param proration [MetronomeSDK::Models::ContractV2::Subscription::Proration]
+        #
+        #   @param quantity_management_mode [Symbol, MetronomeSDK::Models::ContractV2::Subscription::QuantityManagementMode] Determines how the subscription's quantity is controlled. Defaults to QUANTITY_O
+        #
+        #   @param quantity_schedule [Array<MetronomeSDK::Models::ContractV2::Subscription::QuantitySchedule>] List of quantity schedule items for the subscription. Only includes the current
+        #
+        #   @param starting_at [Time]
+        #
+        #   @param subscription_rate [MetronomeSDK::Models::ContractV2::Subscription::SubscriptionRate]
+        #
+        #   @param id [String]
+        #
+        #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
+        #
+        #   @param description [String]
+        #
+        #   @param ending_before [Time]
+        #
+        #   @param fiat_credit_type_id [String]
+        #
+        #   @param name [String]
+        #
+        #   @param seat_config [MetronomeSDK::Models::ContractV2::Subscription::SeatConfig]
+
+        # @see MetronomeSDK::Models::ContractV2::Subscription#billing_periods
+        class BillingPeriods < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute current
+          #
+          #   @return [MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods::Current, nil]
+          optional :current, -> { MetronomeSDK::ContractV2::Subscription::BillingPeriods::Current }
+
+          # @!attribute next_
+          #
+          #   @return [MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods::Next, nil]
+          optional :next_,
+                   -> {
+                     MetronomeSDK::ContractV2::Subscription::BillingPeriods::Next
+                   },
+                   api_name: :next
+
+          # @!attribute previous
+          #
+          #   @return [MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods::Previous, nil]
+          optional :previous, -> { MetronomeSDK::ContractV2::Subscription::BillingPeriods::Previous }
+
+          # @!method initialize(current: nil, next_: nil, previous: nil)
+          #   Previous, current, and next billing periods for the subscription.
+          #
+          #   @param current [MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods::Current]
+          #   @param next_ [MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods::Next]
+          #   @param previous [MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods::Previous]
+
+          # @see MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods#current
+          class Current < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute ending_before
+            #
+            #   @return [Time]
+            required :ending_before, Time
+
+            # @!attribute starting_at
+            #
+            #   @return [Time]
+            required :starting_at, Time
+
+            # @!method initialize(ending_before:, starting_at:)
+            #   @param ending_before [Time]
+            #   @param starting_at [Time]
+          end
+
+          # @see MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods#next_
+          class Next < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute ending_before
+            #
+            #   @return [Time]
+            required :ending_before, Time
+
+            # @!attribute starting_at
+            #
+            #   @return [Time]
+            required :starting_at, Time
+
+            # @!method initialize(ending_before:, starting_at:)
+            #   @param ending_before [Time]
+            #   @param starting_at [Time]
+          end
+
+          # @see MetronomeSDK::Models::ContractV2::Subscription::BillingPeriods#previous
+          class Previous < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute ending_before
+            #
+            #   @return [Time]
+            required :ending_before, Time
+
+            # @!attribute starting_at
+            #
+            #   @return [Time]
+            required :starting_at, Time
+
+            # @!method initialize(ending_before:, starting_at:)
+            #   @param ending_before [Time]
+            #   @param starting_at [Time]
+          end
+        end
+
+        # @see MetronomeSDK::Models::ContractV2::Subscription#collection_schedule
+        module CollectionSchedule
+          extend MetronomeSDK::Internal::Type::Enum
+
+          ADVANCE = :ADVANCE
+          ARREARS = :ARREARS
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see MetronomeSDK::Models::ContractV2::Subscription#proration
+        class Proration < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute invoice_behavior
+          #
+          #   @return [Symbol, MetronomeSDK::Models::ContractV2::Subscription::Proration::InvoiceBehavior]
+          required :invoice_behavior,
+                   enum: -> { MetronomeSDK::ContractV2::Subscription::Proration::InvoiceBehavior }
+
+          # @!attribute is_prorated
+          #
+          #   @return [Boolean]
+          required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+          # @!method initialize(invoice_behavior:, is_prorated:)
+          #   @param invoice_behavior [Symbol, MetronomeSDK::Models::ContractV2::Subscription::Proration::InvoiceBehavior]
+          #   @param is_prorated [Boolean]
+
+          # @see MetronomeSDK::Models::ContractV2::Subscription::Proration#invoice_behavior
+          module InvoiceBehavior
+            extend MetronomeSDK::Internal::Type::Enum
+
+            BILL_IMMEDIATELY = :BILL_IMMEDIATELY
+            BILL_ON_NEXT_COLLECTION_DATE = :BILL_ON_NEXT_COLLECTION_DATE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          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.
+        #
+        # @see MetronomeSDK::Models::ContractV2::Subscription#quantity_management_mode
+        module QuantityManagementMode
+          extend MetronomeSDK::Internal::Type::Enum
+
+          SEAT_BASED = :SEAT_BASED
+          QUANTITY_ONLY = :QUANTITY_ONLY
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class QuantitySchedule < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute quantity
+          #
+          #   @return [Float]
+          required :quantity, Float
+
+          # @!attribute starting_at
+          #
+          #   @return [Time]
+          required :starting_at, Time
+
+          # @!attribute ending_before
+          #
+          #   @return [Time, nil]
+          optional :ending_before, Time
+
+          # @!method initialize(quantity:, starting_at:, ending_before: nil)
+          #   @param quantity [Float]
+          #   @param starting_at [Time]
+          #   @param ending_before [Time]
+        end
+
+        # @see MetronomeSDK::Models::ContractV2::Subscription#subscription_rate
+        class SubscriptionRate < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute billing_frequency
+          #
+          #   @return [Symbol, MetronomeSDK::Models::ContractV2::Subscription::SubscriptionRate::BillingFrequency]
+          required :billing_frequency,
+                   enum: -> { MetronomeSDK::ContractV2::Subscription::SubscriptionRate::BillingFrequency }
+
+          # @!attribute product
+          #
+          #   @return [MetronomeSDK::Models::ContractV2::Subscription::SubscriptionRate::Product]
+          required :product, -> { MetronomeSDK::ContractV2::Subscription::SubscriptionRate::Product }
+
+          # @!method initialize(billing_frequency:, product:)
+          #   @param billing_frequency [Symbol, MetronomeSDK::Models::ContractV2::Subscription::SubscriptionRate::BillingFrequency]
+          #   @param product [MetronomeSDK::Models::ContractV2::Subscription::SubscriptionRate::Product]
+
+          # @see MetronomeSDK::Models::ContractV2::Subscription::SubscriptionRate#billing_frequency
+          module BillingFrequency
+            extend MetronomeSDK::Internal::Type::Enum
+
+            MONTHLY = :MONTHLY
+            QUARTERLY = :QUARTERLY
+            ANNUAL = :ANNUAL
+            WEEKLY = :WEEKLY
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see MetronomeSDK::Models::ContractV2::Subscription::SubscriptionRate#product
+          class Product < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(id:, name:)
+            #   @param id [String]
+            #   @param name [String]
+          end
+        end
+
+        # @see MetronomeSDK::Models::ContractV2::Subscription#seat_config
+        class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute seat_group_key
+          #   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.
+          #
+          #   @return [String]
+          required :seat_group_key, String
+
+          # @!method initialize(seat_group_key:)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::ContractV2::Subscription::SeatConfig} for more details.
+          #
+          #   @param seat_group_key [String] The property name, sent on usage events, that identifies the seat ID associated
+        end
+      end
     end
   end
 end