metronome-sdk 0.1.0 → 0.3.0

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

@@ -479,6 +479,13 @@ module MetronomeSDK
             #   @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
@@ -497,7 +504,7 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Commit::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::V1::ContractAmendParams::Commit::InvoiceSchedule} for
             #   more details.
@@ -509,6 +516,8 @@ module MetronomeSDK
             #
             #   @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::V1::ContractAmendParams::Commit::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
             #   @param schedule_items [Array<MetronomeSDK::Models::V1::ContractAmendParams::Commit::InvoiceSchedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
@@ -781,7 +790,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::V1::ContractAmendParams::Commit::PaymentGateConfig::StripeConfig}
               #   for more details.
@@ -791,6 +813,8 @@ module MetronomeSDK
               #   @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractAmendParams::Commit::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
               #
@@ -1241,6 +1265,13 @@ module MetronomeSDK
             #   @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
@@ -1259,7 +1290,7 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::Discount::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::V1::ContractAmendParams::Discount::Schedule} for more
             #   details.
@@ -1268,6 +1299,8 @@ module MetronomeSDK
             #
             #   @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::V1::ContractAmendParams::Discount::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
             #   @param schedule_items [Array<MetronomeSDK::Models::V1::ContractAmendParams::Discount::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
@@ -1981,6 +2014,11 @@ module MetronomeSDK
           #   @return [MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule]
           required :schedule, -> { MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::Schedule }
 
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
           # @!attribute name
           #   displayed on invoices
           #
@@ -1993,11 +2031,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::V1::ContractAmendParams::ScheduledCharge::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.
@@ -2010,6 +2050,13 @@ module MetronomeSDK
             #   @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
@@ -2030,7 +2077,7 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractAmendParams::ScheduledCharge::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::V1::ContractAmendParams::ScheduledCharge::Schedule} for
             #   more details.
@@ -2039,6 +2086,8 @@ module MetronomeSDK
             #
             #   @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::V1::ContractAmendParams::ScheduledCharge::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
             #   @param schedule_items [Array<MetronomeSDK::Models::V1::ContractAmendParams::ScheduledCharge::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.

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

@@ -724,6 +724,13 @@ module MetronomeSDK
             #   @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
@@ -742,7 +749,7 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Commit::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::V1::ContractCreateParams::Commit::InvoiceSchedule} for
             #   more details.
@@ -754,6 +761,8 @@ module MetronomeSDK
             #
             #   @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::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
             #   @param schedule_items [Array<MetronomeSDK::Models::V1::ContractCreateParams::Commit::InvoiceSchedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
@@ -1024,7 +1033,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::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig}
               #   for more details.
@@ -1034,6 +1056,8 @@ module MetronomeSDK
               #   @param payment_type [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Commit::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
               #
@@ -1484,6 +1508,13 @@ module MetronomeSDK
             #   @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
@@ -1502,7 +1533,7 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::Discount::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::V1::ContractCreateParams::Discount::Schedule} for more
             #   details.
@@ -1511,6 +1542,8 @@ module MetronomeSDK
             #
             #   @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::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
             #   @param schedule_items [Array<MetronomeSDK::Models::V1::ContractCreateParams::Discount::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
@@ -2581,6 +2614,13 @@ module MetronomeSDK
                      MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::RecurringCommit::Specifier]
                    }
 
+          # @!attribute subscription_config
+          #   Attach a subscription to the recurring commit/credit.
+          #
+          #   @return [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig, nil]
+          optional :subscription_config,
+                   -> { MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig }
+
           # @!attribute temporary_id
           #   A temporary ID that can be used to reference the recurring commit for commit
           #   specific overrides.
@@ -2588,7 +2628,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::V1::ContractCreateParams::RecurringCommit} for more
           #   details.
@@ -2629,6 +2669,8 @@ module MetronomeSDK
           #
           #   @param specifiers [Array<MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
           #
+          #   @param subscription_config [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::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::V1::ContractCreateParams::RecurringCommit#access_amount
@@ -2644,8 +2686,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
@@ -2661,7 +2703,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::V1::ContractCreateParams::RecurringCommit#commit_duration
@@ -2919,6 +2961,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::V1::ContractCreateParams::RecurringCommit#subscription_config
+          class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute apply_seat_increase_config
+            #
+            #   @return [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
+            required :apply_seat_increase_config,
+                     -> {
+                       MetronomeSDK::V1::ContractCreateParams::RecurringCommit::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::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation, nil]
+            optional :allocation,
+                     enum: -> {
+                       MetronomeSDK::V1::ContractCreateParams::RecurringCommit::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::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig]
+            #
+            #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
+            #
+            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+
+            # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCommit::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::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig#allocation
+            module Allocation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              POOLED = :POOLED
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class RecurringCredit < MetronomeSDK::Internal::Type::BaseModel
@@ -3046,6 +3147,13 @@ module MetronomeSDK
                      MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::RecurringCredit::Specifier]
                    }
 
+          # @!attribute subscription_config
+          #   Attach a subscription to the recurring commit/credit.
+          #
+          #   @return [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig, nil]
+          optional :subscription_config,
+                   -> { MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig }
+
           # @!attribute temporary_id
           #   A temporary ID that can be used to reference the recurring commit for commit
           #   specific overrides.
@@ -3053,7 +3161,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::V1::ContractCreateParams::RecurringCredit} for more
           #   details.
@@ -3092,6 +3200,8 @@ module MetronomeSDK
           #
           #   @param specifiers [Array<MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
           #
+          #   @param subscription_config [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::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::V1::ContractCreateParams::RecurringCredit#access_amount
@@ -3107,8 +3217,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
@@ -3124,7 +3234,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::V1::ContractCreateParams::RecurringCredit#commit_duration
@@ -3357,6 +3467,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::V1::ContractCreateParams::RecurringCredit#subscription_config
+          class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute apply_seat_increase_config
+            #
+            #   @return [MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
+            required :apply_seat_increase_config,
+                     -> {
+                       MetronomeSDK::V1::ContractCreateParams::RecurringCredit::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::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation, nil]
+            optional :allocation,
+                     enum: -> {
+                       MetronomeSDK::V1::ContractCreateParams::RecurringCredit::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::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig]
+            #
+            #   @param subscription_id [String] ID of the subscription to configure on the recurring commit/credit.
+            #
+            #   @param allocation [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation] If set to POOLED, allocation added per seat is pooled across the account.
+
+            # @see MetronomeSDK::Models::V1::ContractCreateParams::RecurringCredit::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::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig#allocation
+            module Allocation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              POOLED = :POOLED
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
@@ -3500,6 +3669,11 @@ module MetronomeSDK
           #   @return [MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule]
           required :schedule, -> { MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule }
 
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
           # @!attribute name
           #   displayed on invoices
           #
@@ -3512,11 +3686,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::V1::ContractCreateParams::ScheduledCharge::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.
@@ -3529,6 +3705,13 @@ module MetronomeSDK
             #   @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
@@ -3549,7 +3732,7 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::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::V1::ContractCreateParams::ScheduledCharge::Schedule} for
             #   more details.
@@ -3558,6 +3741,8 @@ module MetronomeSDK
             #
             #   @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::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
             #   @param schedule_items [Array<MetronomeSDK::Models::V1::ContractCreateParams::ScheduledCharge::Schedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
@@ -4019,7 +4204,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::V1::ContractCreateParams::Subscription} for more details.
           #
@@ -4040,6 +4232,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::V1::ContractCreateParams::Subscription#collection_schedule
           module CollectionSchedule
@@ -4055,10 +4249,11 @@ module MetronomeSDK
           # @see MetronomeSDK::Models::V1::ContractCreateParams::Subscription#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::V1::ContractCreateParams::Subscription::Proration::InvoiceBehavior, nil]
             optional :invoice_behavior,
@@ -4077,14 +4272,15 @@ module MetronomeSDK
             #   {MetronomeSDK::Models::V1::ContractCreateParams::Subscription::Proration} for
             #   more details.
             #
-            #   @param invoice_behavior [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Subscription::Proration::InvoiceBehavior] Indicates how mid-period quantity adjustments are invoiced. If BILL_IMMEDIATELY
+            #   @param invoice_behavior [Symbol, MetronomeSDK::Models::V1::ContractCreateParams::Subscription::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::V1::ContractCreateParams::Subscription::Proration#invoice_behavior
             module InvoiceBehavior

data/lib/metronome_sdk/models/v1/contracts/product_create_params.rb

@@ -38,6 +38,11 @@ module MetronomeSDK
           #   @return [Array<String>, nil]
           optional :composite_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
 
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
           # @!attribute exclude_free_usage
           #   Beta feature only available for composite products. If true, products with $0
           #   will not be included when computing composite usage. Defaults to false
@@ -107,7 +112,7 @@ module MetronomeSDK
           #   @return [Array<String>, nil]
           optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
 
-          # @!method initialize(name:, type:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, tags: nil, request_options: {})
+          # @!method initialize(name:, type:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, custom_fields: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, tags: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::Contracts::ProductCreateParams} for more details.
           #
@@ -121,6 +126,8 @@ module MetronomeSDK
           #
           #   @param composite_tags [Array<String>] Required for COMPOSITE products
           #
+          #   @param custom_fields [Hash{Symbol=>String}]
+          #
           #   @param exclude_free_usage [Boolean] Beta feature only available for composite products. If true, products with $0 wi
           #
           #   @param is_refundable [Boolean] This field's availability is dependent on your client's configuration. Defaults

data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb

@@ -244,6 +244,13 @@ module MetronomeSDK
             #   @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
@@ -264,7 +271,7 @@ module MetronomeSDK
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::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::V1::Customers::CommitCreateParams::InvoiceSchedule} for
             #   more details.
@@ -276,6 +283,8 @@ module MetronomeSDK
             #
             #   @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::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
             #
             #   @param schedule_items [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.