metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

data/rbi/metronome_sdk/models/v1/contract_retrieve_response.rbi

@@ -135,6 +135,13 @@ module MetronomeSDK
           end
           attr_writer :prepaid_balance_threshold_configuration
 
+          # Priority of the contract.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :priority
+
+          sig { params(priority: Float).void }
+          attr_writer :priority
+
           # Determines which scheduled and commit charges to consolidate onto the Contract's
           # usage invoice. The charge's `timestamp` must match the usage invoice's
           # `ending_before` date for consolidation to occur. This field cannot be modified
@@ -174,6 +181,28 @@ module MetronomeSDK
           end
           attr_writer :spend_threshold_configuration
 
+          # List of subscriptions on the contract.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription
+                ]
+              )
+            )
+          end
+          attr_reader :subscriptions
+
+          sig do
+            params(
+              subscriptions:
+                T::Array[
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::OrHash
+                ]
+            ).void
+          end
+          attr_writer :subscriptions
+
           # Prevents the creation of duplicates. If a request to create a record is made
           # with a previously used uniqueness key, a new record will not be created and the
           # request will fail with a 409 error.
@@ -199,10 +228,15 @@ module MetronomeSDK
                 MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::CustomerBillingProviderConfiguration::OrHash,
               prepaid_balance_threshold_configuration:
                 MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::OrHash,
+              priority: Float,
               scheduled_charges_on_usage_invoices:
                 MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::ScheduledChargesOnUsageInvoices::OrSymbol,
               spend_threshold_configuration:
                 MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::OrHash,
+              subscriptions:
+                T::Array[
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::OrHash
+                ],
               uniqueness_key: String
             ).returns(T.attached_class)
           end
@@ -219,6 +253,8 @@ module MetronomeSDK
             # The billing provider configuration associated with a contract.
             customer_billing_provider_configuration: nil,
             prepaid_balance_threshold_configuration: nil,
+            # Priority of the contract.
+            priority: nil,
             # Determines which scheduled and commit charges to consolidate onto the Contract's
             # usage invoice. The charge's `timestamp` must match the usage invoice's
             # `ending_before` date for consolidation to occur. This field cannot be modified
@@ -226,6 +262,8 @@ module MetronomeSDK
             # on a separate invoice from usage charges.
             scheduled_charges_on_usage_invoices: nil,
             spend_threshold_configuration: nil,
+            # List of subscriptions on the contract.
+            subscriptions: nil,
             # Prevents the creation of duplicates. If a request to create a record is made
             # with a previously used uniqueness key, a new record will not be created and the
             # request will fail with a 409 error.
@@ -250,10 +288,15 @@ module MetronomeSDK
                   MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::CustomerBillingProviderConfiguration,
                 prepaid_balance_threshold_configuration:
                   MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration,
+                priority: Float,
                 scheduled_charges_on_usage_invoices:
                   MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::ScheduledChargesOnUsageInvoices::TaggedSymbol,
                 spend_threshold_configuration:
                   MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration,
+                subscriptions:
+                  T::Array[
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription
+                  ],
                 uniqueness_key: String
               }
             )
@@ -830,6 +873,14 @@ module MetronomeSDK
             sig { returns(Float) }
             attr_accessor :threshold_amount
 
+            # If provided, the threshold, recharge-to amount, and the resulting threshold
+            # commit amount will be in terms of this credit type instead of the fiat currency.
+            sig { returns(T.nilable(String)) }
+            attr_reader :custom_credit_type_id
+
+            sig { params(custom_credit_type_id: String).void }
+            attr_writer :custom_credit_type_id
+
             sig do
               params(
                 commit:
@@ -838,7 +889,8 @@ module MetronomeSDK
                 payment_gate_config:
                   MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::OrHash,
                 recharge_to_amount: Float,
-                threshold_amount: Float
+                threshold_amount: Float,
+                custom_credit_type_id: String
               ).returns(T.attached_class)
             end
             def self.new(
@@ -852,7 +904,10 @@ module MetronomeSDK
               recharge_to_amount:,
               # Specify the threshold amount for the contract. Each time the contract's prepaid
               # balance lowers to this amount, a threshold charge will be initiated.
-              threshold_amount:
+              threshold_amount:,
+              # If provided, the threshold, recharge-to amount, and the resulting threshold
+              # commit amount will be in terms of this credit type instead of the fiat currency.
+              custom_credit_type_id: nil
             )
             end
 
@@ -865,7 +920,8 @@ module MetronomeSDK
                   payment_gate_config:
                     MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig,
                   recharge_to_amount: Float,
-                  threshold_amount: Float
+                  threshold_amount: Float,
+                  custom_credit_type_id: String
                 }
               )
             end
@@ -886,17 +942,18 @@ module MetronomeSDK
               sig { returns(String) }
               attr_accessor :product_id
 
-              # Which products the threshold commit applies to. If both applicable_product_ids
-              # and applicable_product_tags are not provided, the commit applies to all
-              # products.
+              # Which products the threshold commit applies to. If applicable_product_ids,
+              # applicable_product_tags or specifiers are not provided, the commit applies to
+              # all products.
               sig { returns(T.nilable(T::Array[String])) }
               attr_reader :applicable_product_ids
 
               sig { params(applicable_product_ids: T::Array[String]).void }
               attr_writer :applicable_product_ids
 
-              # Which tags the threshold commit applies to. If both applicable_product_ids and
-              # applicable_product_tags are not provided, the commit applies to all products.
+              # Which tags the threshold commit applies to. If applicable_product_ids,
+              # applicable_product_tags or specifiers are not provided, the commit applies to
+              # all products.
               sig { returns(T.nilable(T::Array[String])) }
               attr_reader :applicable_product_tags
 
@@ -917,30 +974,65 @@ module MetronomeSDK
               sig { params(name: String).void }
               attr_writer :name
 
+              # List of filters that determine what kind of customer usage draws down a commit
+              # 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`.
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier
+                    ]
+                  )
+                )
+              end
+              attr_reader :specifiers
+
+              sig do
+                params(
+                  specifiers:
+                    T::Array[
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier::OrHash
+                    ]
+                ).void
+              end
+              attr_writer :specifiers
+
               sig do
                 params(
                   product_id: String,
                   applicable_product_ids: T::Array[String],
                   applicable_product_tags: T::Array[String],
                   description: String,
-                  name: String
+                  name: String,
+                  specifiers:
+                    T::Array[
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier::OrHash
+                    ]
                 ).returns(T.attached_class)
               end
               def self.new(
                 # The commit product that will be used to generate the line item for commit
                 # payment.
                 product_id:,
-                # Which products the threshold commit applies to. If both applicable_product_ids
-                # and applicable_product_tags are not provided, the commit applies to all
-                # products.
+                # Which products the threshold commit applies to. If applicable_product_ids,
+                # applicable_product_tags or specifiers are not provided, the commit applies to
+                # all products.
                 applicable_product_ids: nil,
-                # Which tags the threshold commit applies to. If both applicable_product_ids and
-                # applicable_product_tags are not provided, the commit applies to all products.
+                # Which tags the threshold commit applies to. If applicable_product_ids,
+                # applicable_product_tags or specifiers are not provided, the commit applies to
+                # all products.
                 applicable_product_tags: nil,
                 description: nil,
                 # Specify the name of the line item for the threshold charge. If left blank, it
                 # will default to the commit product name.
-                name: nil
+                name: nil,
+                # List of filters that determine what kind of customer usage draws down a commit
+                # 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`.
+                specifiers: nil
               )
               end
 
@@ -951,12 +1043,91 @@ module MetronomeSDK
                     applicable_product_ids: T::Array[String],
                     applicable_product_tags: T::Array[String],
                     description: String,
-                    name: String
+                    name: String,
+                    specifiers:
+                      T::Array[
+                        MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier
+                      ]
                   }
                 )
               end
               def to_hash
               end
+
+              class Specifier < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::Commit::Specifier,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(T.nilable(T::Hash[Symbol, String])) }
+                attr_reader :presentation_group_values
+
+                sig do
+                  params(
+                    presentation_group_values: T::Hash[Symbol, String]
+                  ).void
+                end
+                attr_writer :presentation_group_values
+
+                sig { returns(T.nilable(T::Hash[Symbol, String])) }
+                attr_reader :pricing_group_values
+
+                sig do
+                  params(pricing_group_values: T::Hash[Symbol, String]).void
+                end
+                attr_writer :pricing_group_values
+
+                # If provided, the specifier will only apply to the product with the specified ID.
+                sig { returns(T.nilable(String)) }
+                attr_reader :product_id
+
+                sig { params(product_id: String).void }
+                attr_writer :product_id
+
+                # If provided, the specifier will only apply to products with all the specified
+                # tags.
+                sig { returns(T.nilable(T::Array[String])) }
+                attr_reader :product_tags
+
+                sig { params(product_tags: T::Array[String]).void }
+                attr_writer :product_tags
+
+                sig do
+                  params(
+                    presentation_group_values: T::Hash[Symbol, String],
+                    pricing_group_values: T::Hash[Symbol, String],
+                    product_id: String,
+                    product_tags: T::Array[String]
+                  ).returns(T.attached_class)
+                end
+                def self.new(
+                  presentation_group_values: nil,
+                  pricing_group_values: nil,
+                  # If provided, the specifier will only apply to the product with the specified ID.
+                  product_id: nil,
+                  # If provided, the specifier will only apply to products with all the specified
+                  # tags.
+                  product_tags: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    {
+                      presentation_group_values: T::Hash[Symbol, String],
+                      pricing_group_values: T::Hash[Symbol, String],
+                      product_id: String,
+                      product_tags: T::Array[String]
+                    }
+                  )
+                end
+                def to_hash
+                end
+              end
             end
 
             class PaymentGateConfig < MetronomeSDK::Internal::Type::BaseModel
@@ -979,7 +1150,25 @@ module MetronomeSDK
               end
               attr_accessor :payment_gate_type
 
-              # Only applicable if using Stripe as your payment gateway through Metronome.
+              # Only applicable if using PRECALCULATED as your tax type.
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig
+                  )
+                )
+              end
+              attr_reader :precalculated_tax_config
+
+              sig do
+                params(
+                  precalculated_tax_config:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig::OrHash
+                ).void
+              end
+              attr_writer :precalculated_tax_config
+
+              # Only applicable if using STRIPE as your payment gate type.
               sig do
                 returns(
                   T.nilable(
@@ -1021,6 +1210,8 @@ module MetronomeSDK
                 params(
                   payment_gate_type:
                     MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType::OrSymbol,
+                  precalculated_tax_config:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig::OrHash,
                   stripe_config:
                     MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::OrHash,
                   tax_type:
@@ -1033,7 +1224,9 @@ module MetronomeSDK
                 # facilitate payment using your own payment integration. Select NONE if you do not
                 # wish to payment gate the commit balance.
                 payment_gate_type:,
-                # Only applicable if using Stripe as your payment gateway through Metronome.
+                # Only applicable if using PRECALCULATED as your tax type.
+                precalculated_tax_config: nil,
+                # Only applicable if using STRIPE as your payment gate type.
                 stripe_config: nil,
                 # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
                 # not wish Metronome to calculate tax on your behalf. Leaving this field blank
@@ -1047,6 +1240,8 @@ module MetronomeSDK
                   {
                     payment_gate_type:
                       MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PaymentGateType::TaggedSymbol,
+                    precalculated_tax_config:
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig,
                     stripe_config:
                       MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig,
                     tax_type:
@@ -1100,6 +1295,51 @@ module MetronomeSDK
                 end
               end
 
+              class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                # Amount of tax to be applied. This should be in the same currency and
+                # denomination as the commit's invoice schedule
+                sig { returns(Float) }
+                attr_accessor :tax_amount
+
+                # Name of the tax to be applied. This may be used in an invoice line item
+                # description.
+                sig { returns(T.nilable(String)) }
+                attr_reader :tax_name
+
+                sig { params(tax_name: String).void }
+                attr_writer :tax_name
+
+                # Only applicable if using PRECALCULATED as your tax type.
+                sig do
+                  params(tax_amount: Float, tax_name: String).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # Amount of tax to be applied. This should be in the same currency and
+                  # denomination as the commit's invoice schedule
+                  tax_amount:,
+                  # Name of the tax to be applied. This may be used in an invoice line item
+                  # description.
+                  tax_name: nil
+                )
+                end
+
+                sig do
+                  override.returns({ tax_amount: Float, tax_name: String })
+                end
+                def to_hash
+                end
+              end
+
               class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
                 OrHash =
                   T.type_alias do
@@ -1117,16 +1357,28 @@ module MetronomeSDK
                 end
                 attr_accessor :payment_type
 
-                # Only applicable if using Stripe as your payment gateway through Metronome.
+                # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+                # your payment type.
+                sig { returns(T.nilable(T::Hash[Symbol, String])) }
+                attr_reader :invoice_metadata
+
+                sig { params(invoice_metadata: T::Hash[Symbol, String]).void }
+                attr_writer :invoice_metadata
+
+                # Only applicable if using STRIPE as your payment gate type.
                 sig do
                   params(
                     payment_type:
-                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol,
+                    invoice_metadata: T::Hash[Symbol, String]
                   ).returns(T.attached_class)
                 end
                 def self.new(
                   # If left blank, will default to INVOICE
-                  payment_type:
+                  payment_type:,
+                  # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+                  # your payment type.
+                  invoice_metadata: nil
                 )
                 end
 
@@ -1134,7 +1386,8 @@ module MetronomeSDK
                   override.returns(
                     {
                       payment_type:
-                        MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType::TaggedSymbol
+                        MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType::TaggedSymbol,
+                      invoice_metadata: T::Hash[Symbol, String]
                     }
                   )
                 end
@@ -1202,6 +1455,16 @@ module MetronomeSDK
                     :STRIPE,
                     MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType::TaggedSymbol
                   )
+                ANROK =
+                  T.let(
+                    :ANROK,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType::TaggedSymbol
+                  )
+                PRECALCULATED =
+                  T.let(
+                    :PRECALCULATED,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::PrepaidBalanceThresholdConfiguration::PaymentGateConfig::TaxType::TaggedSymbol
+                  )
 
                 sig do
                   override.returns(
@@ -1413,7 +1676,25 @@ module MetronomeSDK
               end
               attr_accessor :payment_gate_type
 
-              # Only applicable if using Stripe as your payment gateway through Metronome.
+              # Only applicable if using PRECALCULATED as your tax type.
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig
+                  )
+                )
+              end
+              attr_reader :precalculated_tax_config
+
+              sig do
+                params(
+                  precalculated_tax_config:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig::OrHash
+                ).void
+              end
+              attr_writer :precalculated_tax_config
+
+              # Only applicable if using STRIPE as your payment gate type.
               sig do
                 returns(
                   T.nilable(
@@ -1455,6 +1736,8 @@ module MetronomeSDK
                 params(
                   payment_gate_type:
                     MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType::OrSymbol,
+                  precalculated_tax_config:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig::OrHash,
                   stripe_config:
                     MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::OrHash,
                   tax_type:
@@ -1467,7 +1750,9 @@ module MetronomeSDK
                 # facilitate payment using your own payment integration. Select NONE if you do not
                 # wish to payment gate the commit balance.
                 payment_gate_type:,
-                # Only applicable if using Stripe as your payment gateway through Metronome.
+                # Only applicable if using PRECALCULATED as your tax type.
+                precalculated_tax_config: nil,
+                # Only applicable if using STRIPE as your payment gate type.
                 stripe_config: nil,
                 # Stripe tax is only supported for Stripe payment gateway. Select NONE if you do
                 # not wish Metronome to calculate tax on your behalf. Leaving this field blank
@@ -1481,6 +1766,8 @@ module MetronomeSDK
                   {
                     payment_gate_type:
                       MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PaymentGateType::TaggedSymbol,
+                    precalculated_tax_config:
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig,
                     stripe_config:
                       MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig,
                     tax_type:
@@ -1534,6 +1821,51 @@ module MetronomeSDK
                 end
               end
 
+              class PrecalculatedTaxConfig < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::PrecalculatedTaxConfig,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                # Amount of tax to be applied. This should be in the same currency and
+                # denomination as the commit's invoice schedule
+                sig { returns(Float) }
+                attr_accessor :tax_amount
+
+                # Name of the tax to be applied. This may be used in an invoice line item
+                # description.
+                sig { returns(T.nilable(String)) }
+                attr_reader :tax_name
+
+                sig { params(tax_name: String).void }
+                attr_writer :tax_name
+
+                # Only applicable if using PRECALCULATED as your tax type.
+                sig do
+                  params(tax_amount: Float, tax_name: String).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # Amount of tax to be applied. This should be in the same currency and
+                  # denomination as the commit's invoice schedule
+                  tax_amount:,
+                  # Name of the tax to be applied. This may be used in an invoice line item
+                  # description.
+                  tax_name: nil
+                )
+                end
+
+                sig do
+                  override.returns({ tax_amount: Float, tax_name: String })
+                end
+                def to_hash
+                end
+              end
+
               class StripeConfig < MetronomeSDK::Internal::Type::BaseModel
                 OrHash =
                   T.type_alias do
@@ -1551,16 +1883,28 @@ module MetronomeSDK
                 end
                 attr_accessor :payment_type
 
-                # Only applicable if using Stripe as your payment gateway through Metronome.
+                # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+                # your payment type.
+                sig { returns(T.nilable(T::Hash[Symbol, String])) }
+                attr_reader :invoice_metadata
+
+                sig { params(invoice_metadata: T::Hash[Symbol, String]).void }
+                attr_writer :invoice_metadata
+
+                # Only applicable if using STRIPE as your payment gate type.
                 sig do
                   params(
                     payment_type:
-                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType::OrSymbol,
+                    invoice_metadata: T::Hash[Symbol, String]
                   ).returns(T.attached_class)
                 end
                 def self.new(
                   # If left blank, will default to INVOICE
-                  payment_type:
+                  payment_type:,
+                  # Metadata to be added to the Stripe invoice. Only applicable if using INVOICE as
+                  # your payment type.
+                  invoice_metadata: nil
                 )
                 end
 
@@ -1568,7 +1912,8 @@ module MetronomeSDK
                   override.returns(
                     {
                       payment_type:
-                        MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType::TaggedSymbol
+                        MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::StripeConfig::PaymentType::TaggedSymbol,
+                      invoice_metadata: T::Hash[Symbol, String]
                     }
                   )
                 end
@@ -1636,6 +1981,16 @@ module MetronomeSDK
                     :STRIPE,
                     MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::TaxType::TaggedSymbol
                   )
+                ANROK =
+                  T.let(
+                    :ANROK,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::TaxType::TaggedSymbol
+                  )
+                PRECALCULATED =
+                  T.let(
+                    :PRECALCULATED,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::SpendThresholdConfiguration::PaymentGateConfig::TaxType::TaggedSymbol
+                  )
 
                 sig do
                   override.returns(
@@ -1649,6 +2004,443 @@ module MetronomeSDK
               end
             end
           end
+
+          class Subscription < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::CollectionSchedule::TaggedSymbol
+              )
+            end
+            attr_accessor :collection_schedule
+
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration
+              )
+            end
+            attr_reader :proration
+
+            sig do
+              params(
+                proration:
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::OrHash
+              ).void
+            end
+            attr_writer :proration
+
+            # List of quantity schedule items for the subscription. Only includes the current
+            # quantity and future quantity changes.
+            sig do
+              returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::QuantitySchedule
+                ]
+              )
+            end
+            attr_accessor :quantity_schedule
+
+            sig { returns(Time) }
+            attr_accessor :starting_at
+
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate
+              )
+            end
+            attr_reader :subscription_rate
+
+            sig do
+              params(
+                subscription_rate:
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::OrHash
+              ).void
+            end
+            attr_writer :subscription_rate
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :id
+
+            sig { params(id: String).void }
+            attr_writer :id
+
+            sig { returns(T.nilable(T::Hash[Symbol, String])) }
+            attr_reader :custom_fields
+
+            sig { params(custom_fields: T::Hash[Symbol, String]).void }
+            attr_writer :custom_fields
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :description
+
+            sig { params(description: String).void }
+            attr_writer :description
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :ending_before
+
+            sig { params(ending_before: Time).void }
+            attr_writer :ending_before
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :fiat_credit_type_id
+
+            sig { params(fiat_credit_type_id: String).void }
+            attr_writer :fiat_credit_type_id
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :name
+
+            sig { params(name: String).void }
+            attr_writer :name
+
+            sig do
+              params(
+                collection_schedule:
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::CollectionSchedule::OrSymbol,
+                proration:
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::OrHash,
+                quantity_schedule:
+                  T::Array[
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::QuantitySchedule::OrHash
+                  ],
+                starting_at: Time,
+                subscription_rate:
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::OrHash,
+                id: String,
+                custom_fields: T::Hash[Symbol, String],
+                description: String,
+                ending_before: Time,
+                fiat_credit_type_id: String,
+                name: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              collection_schedule:,
+              proration:,
+              # List of quantity schedule items for the subscription. Only includes the current
+              # quantity and future quantity changes.
+              quantity_schedule:,
+              starting_at:,
+              subscription_rate:,
+              id: nil,
+              custom_fields: nil,
+              description: nil,
+              ending_before: nil,
+              fiat_credit_type_id: nil,
+              name: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  collection_schedule:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::CollectionSchedule::TaggedSymbol,
+                  proration:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration,
+                  quantity_schedule:
+                    T::Array[
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::QuantitySchedule
+                    ],
+                  starting_at: Time,
+                  subscription_rate:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate,
+                  id: String,
+                  custom_fields: T::Hash[Symbol, String],
+                  description: String,
+                  ending_before: Time,
+                  fiat_credit_type_id: String,
+                  name: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module CollectionSchedule
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::CollectionSchedule
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              ADVANCE =
+                T.let(
+                  :ADVANCE,
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::CollectionSchedule::TaggedSymbol
+                )
+              ARREARS =
+                T.let(
+                  :ARREARS,
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::CollectionSchedule::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::CollectionSchedule::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            class Proration < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::InvoiceBehavior::TaggedSymbol
+                )
+              end
+              attr_accessor :invoice_behavior
+
+              sig { returns(T::Boolean) }
+              attr_accessor :is_prorated
+
+              sig do
+                params(
+                  invoice_behavior:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::InvoiceBehavior::OrSymbol,
+                  is_prorated: T::Boolean
+                ).returns(T.attached_class)
+              end
+              def self.new(invoice_behavior:, is_prorated:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    invoice_behavior:
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::InvoiceBehavior::TaggedSymbol,
+                    is_prorated: T::Boolean
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              module InvoiceBehavior
+                extend MetronomeSDK::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::InvoiceBehavior
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                BILL_IMMEDIATELY =
+                  T.let(
+                    :BILL_IMMEDIATELY,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::InvoiceBehavior::TaggedSymbol
+                  )
+                BILL_ON_NEXT_COLLECTION_DATE =
+                  T.let(
+                    :BILL_ON_NEXT_COLLECTION_DATE,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::InvoiceBehavior::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::Proration::InvoiceBehavior::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+
+            class QuantitySchedule < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::QuantitySchedule,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Float) }
+              attr_accessor :quantity
+
+              sig { returns(Time) }
+              attr_accessor :starting_at
+
+              sig { returns(T.nilable(Time)) }
+              attr_reader :ending_before
+
+              sig { params(ending_before: Time).void }
+              attr_writer :ending_before
+
+              sig do
+                params(
+                  quantity: Float,
+                  starting_at: Time,
+                  ending_before: Time
+                ).returns(T.attached_class)
+              end
+              def self.new(quantity:, starting_at:, ending_before: nil)
+              end
+
+              sig do
+                override.returns(
+                  { quantity: Float, starting_at: Time, ending_before: Time }
+                )
+              end
+              def to_hash
+              end
+            end
+
+            class SubscriptionRate < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+                )
+              end
+              attr_accessor :billing_frequency
+
+              sig do
+                returns(
+                  MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::Product
+                )
+              end
+              attr_reader :product
+
+              sig do
+                params(
+                  product:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::Product::OrHash
+                ).void
+              end
+              attr_writer :product
+
+              sig do
+                params(
+                  billing_frequency:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency::OrSymbol,
+                  product:
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::Product::OrHash
+                ).returns(T.attached_class)
+              end
+              def self.new(billing_frequency:, product:)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    billing_frequency:
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol,
+                    product:
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::Product
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              module BillingFrequency
+                extend MetronomeSDK::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                MONTHLY =
+                  T.let(
+                    :MONTHLY,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+                  )
+                QUARTERLY =
+                  T.let(
+                    :QUARTERLY,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+                  )
+                ANNUAL =
+                  T.let(
+                    :ANNUAL,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+                  )
+                WEEKLY =
+                  T.let(
+                    :WEEKLY,
+                    MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::BillingFrequency::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+
+              class Product < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V1::ContractRetrieveResponse::Data::Subscription::SubscriptionRate::Product,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(String) }
+                attr_accessor :id
+
+                sig { returns(String) }
+                attr_accessor :name
+
+                sig do
+                  params(id: String, name: String).returns(T.attached_class)
+                end
+                def self.new(id:, name:)
+                end
+
+                sig { override.returns({ id: String, name: String }) }
+                def to_hash
+                end
+              end
+            end
+          end
         end
       end
     end