metronome-sdk 0.1.0 → 0.3.0

data/rbi/metronome_sdk/models/v1/contract_create_params.rbi

@@ -1583,6 +1583,14 @@ module MetronomeSDK
             sig { params(credit_type_id: String).void }
             attr_writer :credit_type_id
 
+            # This field is only applicable to commit invoice schedules. If true, this
+            # schedule will not generate an invoice.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :do_not_invoice
+
+            sig { params(do_not_invoice: T::Boolean).void }
+            attr_writer :do_not_invoice
+
             # 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
             # quantity is inferred to be 1.
@@ -1632,6 +1640,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -1643,6 +1652,9 @@ module MetronomeSDK
             def self.new(
               # Defaults to USD (cents) if not passed.
               credit_type_id: nil,
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              do_not_invoice: nil,
               # 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
               # quantity is inferred to be 1.
@@ -1656,6 +1668,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V1::ContractCreateParams::Commit::InvoiceSchedule::RecurringSchedule,
                   schedule_items:
@@ -2181,12 +2194,27 @@ module MetronomeSDK
               sig { params(invoice_metadata: T::Hash[Symbol, String]).void }
               attr_writer :invoice_metadata
 
+              # 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.
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :on_session_payment
+
+              sig { params(on_session_payment: T::Boolean).void }
+              attr_writer :on_session_payment
+
               # Only applicable if using STRIPE as your payment gate type.
               sig do
                 params(
                   payment_type:
                     MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol,
-                  invoice_metadata: T::Hash[Symbol, String]
+                  invoice_metadata: T::Hash[Symbol, String],
+                  on_session_payment: T::Boolean
                 ).returns(T.attached_class)
               end
               def self.new(
@@ -2194,7 +2222,16 @@ module MetronomeSDK
                 payment_type:,
                 # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
                 # your payment type.
-                invoice_metadata: nil
+                invoice_metadata: nil,
+                # 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.
+                on_session_payment: nil
               )
               end
 
@@ -2203,7 +2240,8 @@ module MetronomeSDK
                   {
                     payment_type:
                       MetronomeSDK::V1::ContractCreateParams::Commit::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol,
-                    invoice_metadata: T::Hash[Symbol, String]
+                    invoice_metadata: T::Hash[Symbol, String],
+                    on_session_payment: T::Boolean
                   }
                 )
               end
@@ -3202,6 +3240,14 @@ module MetronomeSDK
             sig { params(credit_type_id: String).void }
             attr_writer :credit_type_id
 
+            # This field is only applicable to commit invoice schedules. If true, this
+            # schedule will not generate an invoice.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :do_not_invoice
+
+            sig { params(do_not_invoice: T::Boolean).void }
+            attr_writer :do_not_invoice
+
             # 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
             # quantity is inferred to be 1.
@@ -3248,6 +3294,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -3259,6 +3306,9 @@ module MetronomeSDK
             def self.new(
               # Defaults to USD (cents) if not passed.
               credit_type_id: nil,
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              do_not_invoice: nil,
               # 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
               # quantity is inferred to be 1.
@@ -3272,6 +3322,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V1::ContractCreateParams::Discount::Schedule::RecurringSchedule,
                   schedule_items:
@@ -5373,6 +5424,24 @@ module MetronomeSDK
           end
           attr_writer :specifiers
 
+          # Attach a subscription to the recurring commit/credit.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig
+              )
+            )
+          end
+          attr_reader :subscription_config
+
+          sig do
+            params(
+              subscription_config:
+                MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::OrHash
+            ).void
+          end
+          attr_writer :subscription_config
+
           # A temporary ID that can be used to reference the recurring commit for commit
           # specific overrides.
           sig { returns(T.nilable(String)) }
@@ -5411,6 +5480,8 @@ module MetronomeSDK
                 T::Array[
                   MetronomeSDK::V1::ContractCreateParams::RecurringCommit::Specifier::OrHash
                 ],
+              subscription_config:
+                MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::OrHash,
               temporary_id: String
             ).returns(T.attached_class)
           end
@@ -5462,6 +5533,8 @@ module MetronomeSDK
             # 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`.
             specifiers: nil,
+            # Attach a subscription to the recurring commit/credit.
+            subscription_config: nil,
             # A temporary ID that can be used to reference the recurring commit for commit
             # specific overrides.
             temporary_id: nil
@@ -5499,6 +5572,8 @@ module MetronomeSDK
                   T::Array[
                     MetronomeSDK::V1::ContractCreateParams::RecurringCommit::Specifier
                   ],
+                subscription_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig,
                 temporary_id: String
               }
             )
@@ -5521,8 +5596,8 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :unit_price
 
-            # 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`.
             sig { returns(T.nilable(Float)) }
             attr_reader :quantity
 
@@ -5540,8 +5615,8 @@ module MetronomeSDK
             def self.new(
               credit_type_id:,
               unit_price:,
-              # 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`.
               quantity: nil
             )
             end
@@ -6153,6 +6228,141 @@ module MetronomeSDK
             def to_hash
             end
           end
+
+          class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig
+              )
+            end
+            attr_reader :apply_seat_increase_config
+
+            sig do
+              params(
+                apply_seat_increase_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+              ).void
+            end
+            attr_writer :apply_seat_increase_config
+
+            # ID of the subscription to configure on the recurring commit/credit.
+            sig { returns(String) }
+            attr_accessor :subscription_id
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol
+                )
+              )
+            end
+            attr_reader :allocation
+
+            sig do
+              params(
+                allocation:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol
+              ).void
+            end
+            attr_writer :allocation
+
+            # Attach a subscription to the recurring commit/credit.
+            sig do
+              params(
+                apply_seat_increase_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+                subscription_id: String,
+                allocation:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              apply_seat_increase_config:,
+              # ID of the subscription to configure on the recurring commit/credit.
+              subscription_id:,
+              # If set to POOLED, allocation added per seat is pooled across the account.
+              allocation: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  apply_seat_increase_config:
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                  subscription_id: String,
+                  allocation:
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              # Indicates whether a mid-period seat increase should be prorated.
+              sig { returns(T::Boolean) }
+              attr_accessor :is_prorated
+
+              sig { params(is_prorated: T::Boolean).returns(T.attached_class) }
+              def self.new(
+                # Indicates whether a mid-period seat increase should be prorated.
+                is_prorated:
+              )
+              end
+
+              sig { override.returns({ is_prorated: T::Boolean }) }
+              def to_hash
+              end
+            end
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            module Allocation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              POOLED =
+                T.let(
+                  :POOLED,
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCommit::SubscriptionConfig::Allocation::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class RecurringCredit < MetronomeSDK::Internal::Type::BaseModel
@@ -6362,6 +6572,24 @@ module MetronomeSDK
           end
           attr_writer :specifiers
 
+          # Attach a subscription to the recurring commit/credit.
+          sig do
+            returns(
+              T.nilable(
+                MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig
+              )
+            )
+          end
+          attr_reader :subscription_config
+
+          sig do
+            params(
+              subscription_config:
+                MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::OrHash
+            ).void
+          end
+          attr_writer :subscription_config
+
           # A temporary ID that can be used to reference the recurring commit for commit
           # specific overrides.
           sig { returns(T.nilable(String)) }
@@ -6398,6 +6626,8 @@ module MetronomeSDK
                 T::Array[
                   MetronomeSDK::V1::ContractCreateParams::RecurringCredit::Specifier::OrHash
                 ],
+              subscription_config:
+                MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::OrHash,
               temporary_id: String
             ).returns(T.attached_class)
           end
@@ -6447,6 +6677,8 @@ module MetronomeSDK
             # 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`.
             specifiers: nil,
+            # Attach a subscription to the recurring commit/credit.
+            subscription_config: nil,
             # A temporary ID that can be used to reference the recurring commit for commit
             # specific overrides.
             temporary_id: nil
@@ -6482,6 +6714,8 @@ module MetronomeSDK
                   T::Array[
                     MetronomeSDK::V1::ContractCreateParams::RecurringCredit::Specifier
                   ],
+                subscription_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig,
                 temporary_id: String
               }
             )
@@ -6504,8 +6738,8 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :unit_price
 
-            # 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`.
             sig { returns(T.nilable(Float)) }
             attr_reader :quantity
 
@@ -6523,8 +6757,8 @@ module MetronomeSDK
             def self.new(
               credit_type_id:,
               unit_price:,
-              # 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`.
               quantity: nil
             )
             end
@@ -7098,6 +7332,141 @@ module MetronomeSDK
             def to_hash
             end
           end
+
+          class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig
+              )
+            end
+            attr_reader :apply_seat_increase_config
+
+            sig do
+              params(
+                apply_seat_increase_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash
+              ).void
+            end
+            attr_writer :apply_seat_increase_config
+
+            # ID of the subscription to configure on the recurring commit/credit.
+            sig { returns(String) }
+            attr_accessor :subscription_id
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol
+                )
+              )
+            end
+            attr_reader :allocation
+
+            sig do
+              params(
+                allocation:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol
+              ).void
+            end
+            attr_writer :allocation
+
+            # Attach a subscription to the recurring commit/credit.
+            sig do
+              params(
+                apply_seat_increase_config:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig::OrHash,
+                subscription_id: String,
+                allocation:
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              apply_seat_increase_config:,
+              # ID of the subscription to configure on the recurring commit/credit.
+              subscription_id:,
+              # If set to POOLED, allocation added per seat is pooled across the account.
+              allocation: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  apply_seat_increase_config:
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                  subscription_id: String,
+                  allocation:
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::ApplySeatIncreaseConfig,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              # Indicates whether a mid-period seat increase should be prorated.
+              sig { returns(T::Boolean) }
+              attr_accessor :is_prorated
+
+              sig { params(is_prorated: T::Boolean).returns(T.attached_class) }
+              def self.new(
+                # Indicates whether a mid-period seat increase should be prorated.
+                is_prorated:
+              )
+              end
+
+              sig { override.returns({ is_prorated: T::Boolean }) }
+              def to_hash
+              end
+            end
+
+            # If set to POOLED, allocation added per seat is pooled across the account.
+            module Allocation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              POOLED =
+                T.let(
+                  :POOLED,
+                  MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::ContractCreateParams::RecurringCredit::SubscriptionConfig::Allocation::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
         end
 
         class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
@@ -7403,6 +7772,12 @@ module MetronomeSDK
           end
           attr_writer :schedule
 
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :custom_fields
+
+          sig { params(custom_fields: T::Hash[Symbol, String]).void }
+          attr_writer :custom_fields
+
           # displayed on invoices
           sig { returns(T.nilable(String)) }
           attr_reader :name
@@ -7422,6 +7797,7 @@ module MetronomeSDK
               product_id: String,
               schedule:
                 MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::OrHash,
+              custom_fields: T::Hash[Symbol, String],
               name: String,
               netsuite_sales_order_id: String
             ).returns(T.attached_class)
@@ -7430,6 +7806,7 @@ module MetronomeSDK
             product_id:,
             # Must provide either schedule_items or recurring_schedule.
             schedule:,
+            custom_fields: nil,
             # displayed on invoices
             name: nil,
             # This field's availability is dependent on your client's configuration.
@@ -7443,6 +7820,7 @@ module MetronomeSDK
                 product_id: String,
                 schedule:
                   MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule,
+                custom_fields: T::Hash[Symbol, String],
                 name: String,
                 netsuite_sales_order_id: String
               }
@@ -7467,6 +7845,14 @@ module MetronomeSDK
             sig { params(credit_type_id: String).void }
             attr_writer :credit_type_id
 
+            # This field is only applicable to commit invoice schedules. If true, this
+            # schedule will not generate an invoice.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :do_not_invoice
+
+            sig { params(do_not_invoice: T::Boolean).void }
+            attr_writer :do_not_invoice
+
             # 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
             # quantity is inferred to be 1.
@@ -7513,6 +7899,7 @@ module MetronomeSDK
             sig do
               params(
                 credit_type_id: String,
+                do_not_invoice: T::Boolean,
                 recurring_schedule:
                   MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule::OrHash,
                 schedule_items:
@@ -7524,6 +7911,9 @@ module MetronomeSDK
             def self.new(
               # Defaults to USD (cents) if not passed.
               credit_type_id: nil,
+              # This field is only applicable to commit invoice schedules. If true, this
+              # schedule will not generate an invoice.
+              do_not_invoice: nil,
               # 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
               # quantity is inferred to be 1.
@@ -7537,6 +7927,7 @@ module MetronomeSDK
               override.returns(
                 {
                   credit_type_id: String,
+                  do_not_invoice: T::Boolean,
                   recurring_schedule:
                     MetronomeSDK::V1::ContractCreateParams::ScheduledCharge::Schedule::RecurringSchedule,
                   schedule_items:
@@ -8437,6 +8828,14 @@ module MetronomeSDK
           sig { params(starting_at: Time).void }
           attr_writer :starting_at
 
+          # A temporary ID used to reference the subscription in recurring commit/credit
+          # subscription configs created within the same payload.
+          sig { returns(T.nilable(String)) }
+          attr_reader :temporary_id
+
+          sig { params(temporary_id: String).void }
+          attr_writer :temporary_id
+
           sig do
             params(
               collection_schedule:
@@ -8450,7 +8849,8 @@ module MetronomeSDK
               description: String,
               ending_before: Time,
               name: String,
-              starting_at: Time
+              starting_at: Time,
+              temporary_id: String
             ).returns(T.attached_class)
           end
           def self.new(
@@ -8467,7 +8867,10 @@ module MetronomeSDK
             name: nil,
             # Inclusive start time for the subscription. If not provided, defaults to contract
             # start date
-            starting_at: nil
+            starting_at: nil,
+            # A temporary ID used to reference the subscription in recurring commit/credit
+            # subscription configs created within the same payload.
+            temporary_id: nil
           )
           end
 
@@ -8485,7 +8888,8 @@ module MetronomeSDK
                 description: String,
                 ending_before: Time,
                 name: String,
-                starting_at: Time
+                starting_at: Time,
+                temporary_id: String
               }
             )
           end
@@ -8535,10 +8939,11 @@ module MetronomeSDK
                 )
               end
 
-            # 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.
             sig do
               returns(
                 T.nilable(
@@ -8571,10 +8976,11 @@ module MetronomeSDK
               ).returns(T.attached_class)
             end
             def self.new(
-              # 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.
               invoice_behavior: nil,
               # Indicates if the partial period will be prorated or charged a full amount.
               is_prorated: nil
@@ -8593,10 +8999,11 @@ module MetronomeSDK
             def to_hash
             end
 
-            # 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.
             module InvoiceBehavior
               extend MetronomeSDK::Internal::Type::Enum