metronome-sdk 0.1.0 → 0.3.0

data/lib/metronome_sdk/models/v2/contract_edit_params.rb

@@ -413,6 +413,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. This field cannot
           #   be used together with `applicable_product_ids` or `applicable_product_tags`.
+          #   Instead, to target usage by product or product tag, pass those values in the
+          #   body of `specifiers`.
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCommit::Specifier>, nil]
           optional :specifiers,
@@ -642,11 +644,18 @@ module MetronomeSDK
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddCommit#invoice_schedule
           class InvoiceSchedule < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute credit_type_id
-            #   Defaults to USD if not passed. Only USD is supported at this time.
+            #   Defaults to USD (cents) if not passed.
             #
             #   @return [String, nil]
             optional :credit_type_id, String
 
+            # @!attribute do_not_invoice
+            #   This field is only applicable to commit invoice schedules. If true, this
+            #   schedule will not generate an invoice.
+            #
+            #   @return [Boolean, nil]
+            optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean
+
             # @!attribute recurring_schedule
             #   Enter the unit price and quantity for the charge or instead only send the
             #   amount. If amount is sent, the unit price is assumed to be the amount and
@@ -667,7 +676,7 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddCommit::InvoiceSchedule::ScheduleItem]
                      }
 
-            # @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
+            # @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V2::ContractEditParams::AddCommit::InvoiceSchedule} for
             #   more details.
@@ -677,7 +686,9 @@ module MetronomeSDK
             #   amount. Optional for "PREPAID" commits: if not provided, this will be a
             #   "complimentary" commit with no invoice.
             #
-            #   @param credit_type_id [String] Defaults to USD if not passed. Only USD is supported at this time.
+            #   @param credit_type_id [String] Defaults to USD (cents) if not passed.
+            #
+            #   @param do_not_invoice [Boolean] This field is only applicable to commit invoice schedules. If true, this schedul
             #
             #   @param recurring_schedule [MetronomeSDK::Models::V2::ContractEditParams::AddCommit::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
@@ -950,7 +961,20 @@ module MetronomeSDK
               #   @return [Hash{Symbol=>String}, nil]
               optional :invoice_metadata, MetronomeSDK::Internal::Type::HashOf[String]
 
-              # @!method initialize(payment_type:, invoice_metadata: nil)
+              # @!attribute on_session_payment
+              #   If true, the payment will be made assuming the customer is present (i.e. on
+              #   session).
+              #
+              #   If false, the payment will be made assuming the customer is not present (i.e.
+              #   off session). For cardholders from a country with an e-mandate requirement (e.g.
+              #   India), the payment may be declined.
+              #
+              #   If left blank, will default to false.
+              #
+              #   @return [Boolean, nil]
+              optional :on_session_payment, MetronomeSDK::Internal::Type::Boolean
+
+              # @!method initialize(payment_type:, invoice_metadata: nil, on_session_payment: nil)
               #   Some parameter documentations has been truncated, see
               #   {MetronomeSDK::Models::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig}
               #   for more details.
@@ -960,6 +984,8 @@ module MetronomeSDK
               #   @param payment_type [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddCommit::PaymentGateConfig::StripeConfig::PaymentType] If left blank, will default to INVOICE
               #
               #   @param invoice_metadata [Hash{Symbol=>String}] Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+              #
+              #   @param on_session_payment [Boolean] If true, the payment will be made assuming the customer is present (i.e. on sess
 
               # If left blank, will default to INVOICE
               #
@@ -1116,6 +1142,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. This field cannot
           #   be used together with `applicable_product_ids` or `applicable_product_tags`.
+          #   Instead, to target usage by product or product tag, pass those values in the
+          #   body of `specifiers`.
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCredit::Specifier>, nil]
           optional :specifiers,
@@ -1403,11 +1431,18 @@ module MetronomeSDK
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddDiscount#schedule
           class Schedule < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute credit_type_id
-            #   Defaults to USD if not passed. Only USD is supported at this time.
+            #   Defaults to USD (cents) if not passed.
             #
             #   @return [String, nil]
             optional :credit_type_id, String
 
+            # @!attribute do_not_invoice
+            #   This field is only applicable to commit invoice schedules. If true, this
+            #   schedule will not generate an invoice.
+            #
+            #   @return [Boolean, nil]
+            optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean
+
             # @!attribute recurring_schedule
             #   Enter the unit price and quantity for the charge or instead only send the
             #   amount. If amount is sent, the unit price is assumed to be the amount and
@@ -1426,14 +1461,16 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddDiscount::Schedule::ScheduleItem]
                      }
 
-            # @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
+            # @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V2::ContractEditParams::AddDiscount::Schedule} for more
             #   details.
             #
             #   Must provide either schedule_items or recurring_schedule.
             #
-            #   @param credit_type_id [String] Defaults to USD if not passed. Only USD is supported at this time.
+            #   @param credit_type_id [String] Defaults to USD (cents) if not passed.
+            #
+            #   @param do_not_invoice [Boolean] This field is only applicable to commit invoice schedules. If true, this schedul
             #
             #   @param recurring_schedule [MetronomeSDK::Models::V2::ContractEditParams::AddDiscount::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
@@ -2042,6 +2079,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. This field cannot
             #   be used together with `applicable_product_ids` or `applicable_product_tags`.
+            #   Instead, to target usage by product or product tag, pass those values in the
+            #   body of `specifiers`.
             #
             #   @return [Array<MetronomeSDK::Models::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::Commit::Specifier>, nil]
             optional :specifiers,
@@ -2393,7 +2432,7 @@ module MetronomeSDK
           optional :ending_before, Time
 
           # @!attribute hierarchy_configuration
-          #   Optional configuration for recurring commit/credit hierarchy access control
+          #   Optional configuration for recurring credit hierarchy access control
           #
           #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::HierarchyConfiguration, nil]
           optional :hierarchy_configuration,
@@ -2460,6 +2499,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. This field cannot
           #   be used together with `applicable_product_ids` or `applicable_product_tags`.
+          #   Instead, to target usage by product or product tag, pass those values in the
+          #   body of `specifiers`.
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::Specifier>, nil]
           optional :specifiers,
@@ -2467,6 +2508,13 @@ module MetronomeSDK
                      MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::Specifier]
                    }
 
+          # @!attribute subscription_config
+          #   Attach a subscription to the recurring commit/credit.
+          #
+          #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig, nil]
+          optional :subscription_config,
+                   -> { MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig }
+
           # @!attribute temporary_id
           #   A temporary ID that can be used to reference the recurring commit for commit
           #   specific overrides.
@@ -2474,7 +2522,7 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :temporary_id, String
 
-          # @!method initialize(access_amount:, commit_duration:, priority:, product_id:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, rate_type: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, temporary_id: nil)
+          # @!method initialize(access_amount:, commit_duration:, priority:, product_id:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, invoice_amount: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, rate_type: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil, temporary_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit} for more
           #   details.
@@ -2497,7 +2545,7 @@ module MetronomeSDK
           #
           #   @param ending_before [Time] Determines when the contract will stop creating recurring commits. optional
           #
-          #   @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::HierarchyConfiguration] Optional configuration for recurring commit/credit hierarchy access control
+          #   @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::HierarchyConfiguration] Optional configuration for recurring credit hierarchy access control
           #
           #   @param invoice_amount [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::InvoiceAmount] The amount the customer should be billed for the commit. Not required.
           #
@@ -2515,6 +2563,8 @@ module MetronomeSDK
           #
           #   @param specifiers [Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
           #
+          #   @param subscription_config [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig] Attach a subscription to the recurring commit/credit.
+          #
           #   @param temporary_id [String] A temporary ID that can be used to reference the recurring commit for commit spe
 
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit#access_amount
@@ -2530,8 +2580,8 @@ module MetronomeSDK
             required :unit_price, Float
 
             # @!attribute quantity
-            #   This field is currently required. Upcoming recurring commit/credit configuration
-            #   options will allow it to be optional.
+            #   This field is required unless a subscription is attached via
+            #   `subscription_config`.
             #
             #   @return [Float, nil]
             optional :quantity, Float
@@ -2547,7 +2597,7 @@ module MetronomeSDK
             #
             #   @param unit_price [Float]
             #
-            #   @param quantity [Float] This field is currently required. Upcoming recurring commit/credit configuration
+            #   @param quantity [Float] This field is required unless a subscription is attached via `subscription_confi
           end
 
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit#commit_duration
@@ -2595,7 +2645,7 @@ module MetronomeSDK
                      }
 
             # @!method initialize(child_access:)
-            #   Optional configuration for recurring commit/credit hierarchy access control
+            #   Optional configuration for recurring credit hierarchy access control
             #
             #   @param child_access [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
 
@@ -2805,6 +2855,65 @@ module MetronomeSDK
             #
             #   @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
           end
+
+          # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit#subscription_config
+          class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute apply_seat_increase_config
+            #
+            #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
+            required :apply_seat_increase_config,
+                     -> {
+                       MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig
+                     }
+
+            # @!attribute subscription_id
+            #   ID of the subscription to configure on the recurring commit/credit.
+            #
+            #   @return [String]
+            required :subscription_id, String
+
+            # @!attribute allocation
+            #   If set to POOLED, allocation added per seat is pooled across the account.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig::Allocation, nil]
+            optional :allocation,
+                     enum: -> {
+                       MetronomeSDK::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig::Allocation
+                     }
+
+            # @!method initialize(apply_seat_increase_config:, subscription_id:, allocation: nil)
+            #   Attach a subscription to the recurring commit/credit.
+            #
+            #   @param apply_seat_increase_config [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
+            #
+            #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
+            #
+            #   @param allocation [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+
+            # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig#apply_seat_increase_config
+            class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute is_prorated
+              #   Indicates whether a mid-period seat increase should be prorated.
+              #
+              #   @return [Boolean]
+              required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+              # @!method initialize(is_prorated:)
+              #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+            end
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            #
+            # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit::SubscriptionConfig#allocation
+            module Allocation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              POOLED = :POOLED
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class AddRecurringCredit < MetronomeSDK::Internal::Type::BaseModel
@@ -2870,7 +2979,7 @@ module MetronomeSDK
           optional :ending_before, Time
 
           # @!attribute hierarchy_configuration
-          #   Optional configuration for recurring commit/credit hierarchy access control
+          #   Optional configuration for recurring credit hierarchy access control
           #
           #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::HierarchyConfiguration, nil]
           optional :hierarchy_configuration,
@@ -2928,6 +3037,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. This field cannot
           #   be used together with `applicable_product_ids` or `applicable_product_tags`.
+          #   Instead, to target usage by product or product tag, pass those values in the
+          #   body of `specifiers`.
           #
           #   @return [Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::Specifier>, nil]
           optional :specifiers,
@@ -2935,6 +3046,13 @@ module MetronomeSDK
                      MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::Specifier]
                    }
 
+          # @!attribute subscription_config
+          #   Attach a subscription to the recurring commit/credit.
+          #
+          #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig, nil]
+          optional :subscription_config,
+                   -> { MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig }
+
           # @!attribute temporary_id
           #   A temporary ID that can be used to reference the recurring commit for commit
           #   specific overrides.
@@ -2942,7 +3060,7 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :temporary_id, String
 
-          # @!method initialize(access_amount:, commit_duration:, priority:, product_id:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, rate_type: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, temporary_id: nil)
+          # @!method initialize(access_amount:, commit_duration:, priority:, product_id:, starting_at:, applicable_product_ids: nil, applicable_product_tags: nil, description: nil, ending_before: nil, hierarchy_configuration: nil, name: nil, netsuite_sales_order_id: nil, proration: nil, rate_type: nil, recurrence_frequency: nil, rollover_fraction: nil, specifiers: nil, subscription_config: nil, temporary_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit} for more
           #   details.
@@ -2965,7 +3083,7 @@ module MetronomeSDK
           #
           #   @param ending_before [Time] Determines when the contract will stop creating recurring commits. optional
           #
-          #   @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::HierarchyConfiguration] Optional configuration for recurring commit/credit hierarchy access control
+          #   @param hierarchy_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::HierarchyConfiguration] Optional configuration for recurring credit hierarchy access control
           #
           #   @param name [String] displayed on invoices. will be passed through to the individual commits
           #
@@ -2981,6 +3099,8 @@ module MetronomeSDK
           #
           #   @param specifiers [Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
           #
+          #   @param subscription_config [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig] Attach a subscription to the recurring commit/credit.
+          #
           #   @param temporary_id [String] A temporary ID that can be used to reference the recurring commit for commit spe
 
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit#access_amount
@@ -2996,8 +3116,8 @@ module MetronomeSDK
             required :unit_price, Float
 
             # @!attribute quantity
-            #   This field is currently required. Upcoming recurring commit/credit configuration
-            #   options will allow it to be optional.
+            #   This field is required unless a subscription is attached via
+            #   `subscription_config`.
             #
             #   @return [Float, nil]
             optional :quantity, Float
@@ -3013,7 +3133,7 @@ module MetronomeSDK
             #
             #   @param unit_price [Float]
             #
-            #   @param quantity [Float] This field is currently required. Upcoming recurring commit/credit configuration
+            #   @param quantity [Float] This field is required unless a subscription is attached via `subscription_confi
           end
 
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit#commit_duration
@@ -3061,7 +3181,7 @@ module MetronomeSDK
                      }
 
             # @!method initialize(child_access:)
-            #   Optional configuration for recurring commit/credit hierarchy access control
+            #   Optional configuration for recurring credit hierarchy access control
             #
             #   @param child_access [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessAll, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessNone, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::HierarchyConfiguration::ChildAccess::CommitHierarchyChildAccessContractIDs]
 
@@ -3246,6 +3366,65 @@ module MetronomeSDK
             #
             #   @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
           end
+
+          # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit#subscription_config
+          class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute apply_seat_increase_config
+            #
+            #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
+            required :apply_seat_increase_config,
+                     -> {
+                       MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig
+                     }
+
+            # @!attribute subscription_id
+            #   ID of the subscription to configure on the recurring commit/credit.
+            #
+            #   @return [String]
+            required :subscription_id, String
+
+            # @!attribute allocation
+            #   If set to POOLED, allocation added per seat is pooled across the account.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig::Allocation, nil]
+            optional :allocation,
+                     enum: -> {
+                       MetronomeSDK::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig::Allocation
+                     }
+
+            # @!method initialize(apply_seat_increase_config:, subscription_id:, allocation: nil)
+            #   Attach a subscription to the recurring commit/credit.
+            #
+            #   @param apply_seat_increase_config [MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
+            #
+            #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
+            #
+            #   @param allocation [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+
+            # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig#apply_seat_increase_config
+            class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute is_prorated
+              #   Indicates whether a mid-period seat increase should be prorated.
+              #
+              #   @return [Boolean]
+              required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+              # @!method initialize(is_prorated:)
+              #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+            end
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            #
+            # @see MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit::SubscriptionConfig#allocation
+            module Allocation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              POOLED = :POOLED
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class AddResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
@@ -3390,6 +3569,11 @@ module MetronomeSDK
           #   @return [MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge::Schedule]
           required :schedule, -> { MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule }
 
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
           # @!attribute name
           #   displayed on invoices
           #
@@ -3402,11 +3586,13 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :netsuite_sales_order_id, String
 
-          # @!method initialize(product_id:, schedule:, name: nil, netsuite_sales_order_id: nil)
+          # @!method initialize(product_id:, schedule:, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
           #   @param product_id [String]
           #
           #   @param schedule [MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge::Schedule] Must provide either schedule_items or recurring_schedule.
           #
+          #   @param custom_fields [Hash{Symbol=>String}]
+          #
           #   @param name [String] displayed on invoices
           #
           #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
@@ -3414,11 +3600,18 @@ module MetronomeSDK
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge#schedule
           class Schedule < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute credit_type_id
-            #   Defaults to USD if not passed. Only USD is supported at this time.
+            #   Defaults to USD (cents) if not passed.
             #
             #   @return [String, nil]
             optional :credit_type_id, String
 
+            # @!attribute do_not_invoice
+            #   This field is only applicable to commit invoice schedules. If true, this
+            #   schedule will not generate an invoice.
+            #
+            #   @return [Boolean, nil]
+            optional :do_not_invoice, MetronomeSDK::Internal::Type::Boolean
+
             # @!attribute recurring_schedule
             #   Enter the unit price and quantity for the charge or instead only send the
             #   amount. If amount is sent, the unit price is assumed to be the amount and
@@ -3439,14 +3632,16 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::Schedule::ScheduleItem]
                      }
 
-            # @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
+            # @!method initialize(credit_type_id: nil, do_not_invoice: nil, recurring_schedule: nil, schedule_items: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge::Schedule} for
             #   more details.
             #
             #   Must provide either schedule_items or recurring_schedule.
             #
-            #   @param credit_type_id [String] Defaults to USD if not passed. Only USD is supported at this time.
+            #   @param credit_type_id [String] Defaults to USD (cents) if not passed.
+            #
+            #   @param do_not_invoice [Boolean] This field is only applicable to commit invoice schedules. If true, this schedul
             #
             #   @param recurring_schedule [MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
@@ -3896,7 +4091,14 @@ module MetronomeSDK
           #   @return [Time, nil]
           optional :starting_at, Time
 
-          # @!method initialize(collection_schedule:, initial_quantity:, proration:, subscription_rate:, custom_fields: nil, description: nil, ending_before: nil, name: nil, starting_at: nil)
+          # @!attribute temporary_id
+          #   A temporary ID used to reference the subscription in recurring commit/credit
+          #   subscription configs created within the same payload.
+          #
+          #   @return [String, nil]
+          optional :temporary_id, String
+
+          # @!method initialize(collection_schedule:, initial_quantity:, proration:, subscription_rate:, custom_fields: nil, description: nil, ending_before: nil, name: nil, starting_at: nil, temporary_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V2::ContractEditParams::AddSubscription} for more
           #   details.
@@ -3918,6 +4120,8 @@ module MetronomeSDK
           #   @param name [String]
           #
           #   @param starting_at [Time] Inclusive start time for the subscription. If not provided, defaults to contract
+          #
+          #   @param temporary_id [String] A temporary ID used to reference the subscription in recurring commit/credit sub
 
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddSubscription#collection_schedule
           module CollectionSchedule
@@ -3933,10 +4137,11 @@ module MetronomeSDK
           # @see MetronomeSDK::Models::V2::ContractEditParams::AddSubscription#proration
           class Proration < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute invoice_behavior
-            #   Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
-            #   is selected, the quantity increase will be billed on the scheduled date. If
-            #   BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
-            #   for in-arrears at the end of the period.
+            #   Indicates how mid-period quantity adjustments are invoiced.
+            #   **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+            #   quantity increase will be billed immediately on the scheduled date.
+            #   **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+            #   in-arrears at the end of the period.
             #
             #   @return [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration::InvoiceBehavior, nil]
             optional :invoice_behavior,
@@ -3955,14 +4160,15 @@ module MetronomeSDK
             #   {MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration} for
             #   more details.
             #
-            #   @param invoice_behavior [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration::InvoiceBehavior] Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
+            #   @param invoice_behavior [Symbol, MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration::InvoiceBehavior] Indicates how mid-period quantity adjustments are invoiced.
             #
             #   @param is_prorated [Boolean] Indicates if the partial period will be prorated or charged a full amount.
 
-            # Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
-            # is selected, the quantity increase will be billed on the scheduled date. If
-            # BILL_ON_NEXT_COLLECTION_DATE is selected, the quantity increase will be billed
-            # for in-arrears at the end of the period.
+            # Indicates how mid-period quantity adjustments are invoiced.
+            # **BILL_IMMEDIATELY**: Only available when collection schedule is `ADVANCE`. The
+            # quantity increase will be billed immediately on the scheduled date.
+            # **BILL_ON_NEXT_COLLECTION_DATE**: The quantity increase will be billed for
+            # in-arrears at the end of the period.
             #
             # @see MetronomeSDK::Models::V2::ContractEditParams::AddSubscription::Proration#invoice_behavior
             module InvoiceBehavior
@@ -4108,6 +4314,11 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :netsuite_sales_order_id, String, nil?: true
 
+          # @!attribute priority
+          #
+          #   @return [Float, nil]
+          optional :priority, Float, nil?: true
+
           # @!attribute product_id
           #
           #   @return [String, nil]
@@ -4118,7 +4329,7 @@ module MetronomeSDK
           #   @return [Float, nil]
           optional :rollover_fraction, Float, nil?: true
 
-          # @!method initialize(commit_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_schedule: nil, netsuite_sales_order_id: nil, product_id: nil, rollover_fraction: nil)
+          # @!method initialize(commit_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, invoice_schedule: nil, netsuite_sales_order_id: nil, priority: nil, product_id: nil, rollover_fraction: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit} for more details.
           #
@@ -4136,6 +4347,8 @@ module MetronomeSDK
           #
           #   @param netsuite_sales_order_id [String, nil]
           #
+          #   @param priority [Float, nil]
+          #
           #   @param product_id [String]
           #
           #   @param rollover_fraction [Float, nil]
@@ -4487,12 +4700,17 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :netsuite_sales_order_id, String, nil?: true
 
+          # @!attribute priority
+          #
+          #   @return [Float, nil]
+          optional :priority, Float, nil?: true
+
           # @!attribute product_id
           #
           #   @return [String, nil]
           optional :product_id, String
 
-          # @!method initialize(credit_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, netsuite_sales_order_id: nil, product_id: nil)
+          # @!method initialize(credit_id:, access_schedule: nil, applicable_product_ids: nil, applicable_product_tags: nil, hierarchy_configuration: nil, netsuite_sales_order_id: nil, priority: nil, product_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V2::ContractEditParams::UpdateCredit} for more details.
           #
@@ -4508,6 +4726,8 @@ module MetronomeSDK
           #
           #   @param netsuite_sales_order_id [String, nil]
           #
+          #   @param priority [Float, nil]
+          #
           #   @param product_id [String]
 
           # @see MetronomeSDK::Models::V2::ContractEditParams::UpdateCredit#access_schedule
@@ -4817,6 +5037,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. This field cannot
             #   be used together with `applicable_product_ids` or `applicable_product_tags`.
+            #   Instead, to target usage by product or product tag, pass those values in the
+            #   body of `specifiers`.
             #
             #   @return [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration::Commit::Specifier>, nil]
             optional :specifiers,