metronome-sdk 1.0.0 → 2.1.0

data/lib/metronome_sdk/models/contract_v2.rb

@@ -104,8 +104,8 @@ module MetronomeSDK
       #   Either a **parent** configuration with a list of children or a **child**
       #   configuration with a single parent.
       #
-      #   @return [MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration, nil]
-      optional :hierarchy_configuration, union: -> { MetronomeSDK::HierarchyConfiguration }
+      #   @return [MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2, nil]
+      optional :hierarchy_configuration, union: -> { MetronomeSDK::ContractV2::HierarchyConfiguration }
 
       # @!attribute multiplier_override_prioritization
       #   Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
@@ -254,7 +254,7 @@ module MetronomeSDK
       #
       #   @param has_more [MetronomeSDK::Models::ContractV2::HasMore] Indicates whether there are more items than the limit for this endpoint. Use the
       #
-      #   @param hierarchy_configuration [MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration] Either a **parent** configuration with a list of children or a **child** configu
+      #   @param hierarchy_configuration [MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2] Either a **parent** configuration with a list of children or a **child** configu
       #
       #   @param multiplier_override_prioritization [Symbol, MetronomeSDK::Models::ContractV2::MultiplierOverridePrioritization] Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list price
       #
@@ -1264,8 +1264,8 @@ module MetronomeSDK
 
         # @!attribute overwrite_rate
         #
-        #   @return [MetronomeSDK::Models::OverwriteRate, nil]
-        optional :overwrite_rate, -> { MetronomeSDK::OverwriteRate }
+        #   @return [MetronomeSDK::Models::ContractV2::Override::OverwriteRate, nil]
+        optional :overwrite_rate, -> { MetronomeSDK::ContractV2::Override::OverwriteRate }
 
         # @!attribute priority
         #
@@ -1297,7 +1297,7 @@ module MetronomeSDK
         #   @param multiplier [Float]
         #   @param override_specifiers [Array<MetronomeSDK::Models::ContractV2::Override::OverrideSpecifier>]
         #   @param override_tiers [Array<MetronomeSDK::Models::OverrideTier>]
-        #   @param overwrite_rate [MetronomeSDK::Models::OverwriteRate]
+        #   @param overwrite_rate [MetronomeSDK::Models::ContractV2::Override::OverwriteRate]
         #   @param priority [Float]
         #   @param product [MetronomeSDK::Models::ContractV2::Override::Product]
         #   @param target [Symbol, MetronomeSDK::Models::ContractV2::Override::Target]
@@ -1369,6 +1369,84 @@ module MetronomeSDK
           end
         end
 
+        # @see MetronomeSDK::Models::ContractV2::Override#overwrite_rate
+        class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute rate_type
+          #
+          #   @return [Symbol, MetronomeSDK::Models::ContractV2::Override::OverwriteRate::RateType]
+          required :rate_type, enum: -> { MetronomeSDK::ContractV2::Override::OverwriteRate::RateType }
+
+          # @!attribute credit_type
+          #
+          #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+          optional :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+          # @!attribute custom_rate
+          #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
+          #   processors.
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+          # @!attribute is_prorated
+          #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+          #   set to true.
+          #
+          #   @return [Boolean, nil]
+          optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+          # @!attribute price
+          #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+          #   this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+          #
+          #   @return [Float, nil]
+          optional :price, Float
+
+          # @!attribute quantity
+          #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+          #
+          #   @return [Float, nil]
+          optional :quantity, Float
+
+          # @!attribute tiers
+          #   Only set for TIERED rate_type.
+          #
+          #   @return [Array<MetronomeSDK::Models::Tier>, nil]
+          optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
+
+          # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::ContractV2::Override::OverwriteRate} for more details.
+          #
+          #   @param rate_type [Symbol, MetronomeSDK::Models::ContractV2::Override::OverwriteRate::RateType]
+          #
+          #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+          #
+          #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
+          #
+          #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+          #
+          #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
+          #
+          #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+          #
+          #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+
+          # @see MetronomeSDK::Models::ContractV2::Override::OverwriteRate#rate_type
+          module RateType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            FLAT = :FLAT
+            PERCENTAGE = :PERCENTAGE
+            SUBSCRIPTION = :SUBSCRIPTION
+            TIERED = :TIERED
+            CUSTOM = :CUSTOM
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # @see MetronomeSDK::Models::ContractV2::Override#product
         class Product < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute id
@@ -2070,6 +2148,7 @@ module MetronomeSDK
           QUICKBOOKS_ONLINE = :quickbooks_online
           WORKDAY = :workday
           GCP_MARKETPLACE = :gcp_marketplace
+          METRONOME = :metronome
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -2119,6 +2198,196 @@ module MetronomeSDK
         #   @param credits [Boolean] Whether there are more credits on this contract than the limit for this endpoint
       end
 
+      # Either a **parent** configuration with a list of children or a **child**
+      # configuration with a single parent.
+      #
+      # @see MetronomeSDK::Models::ContractV2#hierarchy_configuration
+      module HierarchyConfiguration
+        extend MetronomeSDK::Internal::Type::Union
+
+        variant -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration }
+
+        variant -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2 }
+
+        class ParentHierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute children
+          #   List of contracts that belong to this parent.
+          #
+          #   @return [Array<MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::Child>]
+          required :children,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::Child] }
+
+          # @!attribute parent_behavior
+          #
+          #   @return [MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior, nil]
+          optional :parent_behavior,
+                   -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior }
+
+          # @!method initialize(children:, parent_behavior: nil)
+          #   @param children [Array<MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::Child>] List of contracts that belong to this parent.
+          #
+          #   @param parent_behavior [MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior]
+
+          class Child < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute contract_id
+            #
+            #   @return [String]
+            required :contract_id, String
+
+            # @!attribute customer_id
+            #
+            #   @return [String]
+            required :customer_id, String
+
+            # @!method initialize(contract_id:, customer_id:)
+            #   @param contract_id [String]
+            #   @param customer_id [String]
+          end
+
+          # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration#parent_behavior
+          class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute invoice_consolidation_type
+            #   Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            #   generated by the parent in a customer hierarchy
+            #
+            #   **CONCATENATE**: Statements on the invoices of child customers will be appended
+            #   to the consolidated invoice
+            #
+            #   **NONE**: Do not generate consolidated invoices
+            #
+            #   @return [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType, nil]
+            optional :invoice_consolidation_type,
+                     enum: -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType }
+
+            # @!method initialize(invoice_consolidation_type: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior}
+            #   for more details.
+            #
+            #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Account hierarchy M3 - Indicates the desired behavior of consolidated invoices g
+
+            # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+            # generated by the parent in a customer hierarchy
+            #
+            # **CONCATENATE**: Statements on the invoices of child customers will be appended
+            # to the consolidated invoice
+            #
+            # **NONE**: Do not generate consolidated invoices
+            #
+            # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior#invoice_consolidation_type
+            module InvoiceConsolidationType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              CONCATENATE = :CONCATENATE
+              NONE = :NONE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+
+        class ChildHierarchyConfigurationV2 < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute parent
+          #   The single parent contract/customer for this child.
+          #
+          #   @return [MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Parent]
+          required :parent,
+                   -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Parent }
+
+          # @!attribute payer
+          #   Account hierarchy M3 - Indicates which customer should pay for the child's
+          #   invoice charges **SELF**: The child pays for its own invoice charges **PARENT**:
+          #   The parent pays for the child's invoice charges
+          #
+          #   @return [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Payer, nil]
+          optional :payer,
+                   enum: -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Payer }
+
+          # @!attribute usage_statement_behavior
+          #   Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          #   on the parent's invoices.
+          #
+          #   **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          #   consolidated invoices
+          #
+          #   **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          #   consolidated invoices
+          #
+          #   @return [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::UsageStatementBehavior, nil]
+          optional :usage_statement_behavior,
+                   enum: -> { MetronomeSDK::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::UsageStatementBehavior }
+
+          # @!method initialize(parent:, payer: nil, usage_statement_behavior: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2}
+          #   for more details.
+          #
+          #   @param parent [MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Parent] The single parent contract/customer for this child.
+          #
+          #   @param payer [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::Payer] Account hierarchy M3 - Indicates which customer should pay for the child's invoi
+          #
+          #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2::UsageStatementBehavior] Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+
+          # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2#parent
+          class Parent < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute contract_id
+            #
+            #   @return [String]
+            required :contract_id, String
+
+            # @!attribute customer_id
+            #
+            #   @return [String]
+            required :customer_id, String
+
+            # @!method initialize(contract_id:, customer_id:)
+            #   The single parent contract/customer for this child.
+            #
+            #   @param contract_id [String]
+            #   @param customer_id [String]
+          end
+
+          # Account hierarchy M3 - Indicates which customer should pay for the child's
+          # invoice charges **SELF**: The child pays for its own invoice charges **PARENT**:
+          # The parent pays for the child's invoice charges
+          #
+          # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2#payer
+          module Payer
+            extend MetronomeSDK::Internal::Type::Enum
+
+            SELF = :SELF
+            PARENT = :PARENT
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+          # on the parent's invoices.
+          #
+          # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+          # consolidated invoices
+          #
+          # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+          # consolidated invoices
+          #
+          # @see MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2#usage_statement_behavior
+          module UsageStatementBehavior
+            extend MetronomeSDK::Internal::Type::Enum
+
+            CONSOLIDATE = :CONSOLIDATE
+            SEPARATE = :SEPARATE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @!method self.variants
+        #   @return [Array(MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ParentHierarchyConfiguration, MetronomeSDK::Models::ContractV2::HierarchyConfiguration::ChildHierarchyConfigurationV2)]
+      end
+
       # Defaults to LOWEST_MULTIPLIER, which applies the greatest discount to list
       # prices automatically. EXPLICIT prioritization requires specifying priorities for
       # each multiplier; the one with the lowest priority value will be prioritized

data/lib/metronome_sdk/models/contract_without_amendments.rb

@@ -50,7 +50,7 @@ module MetronomeSDK
       optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Credit] }
 
       # @!attribute discounts
-      #   This field's availability is dependent on your client's configuration.
+      #   This field's availability is dependent on your client's
       #
       #   @return [Array<MetronomeSDK::Models::Discount>, nil]
       optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Discount] }
@@ -174,7 +174,7 @@ module MetronomeSDK
       #
       #   @param credits [Array<MetronomeSDK::Models::Credit>]
       #
-      #   @param discounts [Array<MetronomeSDK::Models::Discount>] This field's availability is dependent on your client's configuration.
+      #   @param discounts [Array<MetronomeSDK::Models::Discount>] This field's availability is dependent on your client's
       #
       #   @param ending_before [Time]
       #

data/lib/metronome_sdk/models/hierarchy_configuration.rb

@@ -19,8 +19,16 @@ module MetronomeSDK
         required :children,
                  -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::Child] }
 
-        # @!method initialize(children:)
+        # @!attribute parent_behavior
+        #
+        #   @return [MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior, nil]
+        optional :parent_behavior,
+                 -> { MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior }
+
+        # @!method initialize(children:, parent_behavior: nil)
         #   @param children [Array<MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::Child>] List of contracts that belong to this parent.
+        #
+        #   @param parent_behavior [MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior]
 
         class Child < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute contract_id
@@ -37,6 +45,48 @@ module MetronomeSDK
           #   @param contract_id [String]
           #   @param customer_id [String]
         end
+
+        # @see MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration#parent_behavior
+        class ParentBehavior < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute invoice_consolidation_type
+          #   Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+          #   generated by the parent in a customer hierarchy
+          #
+          #   **CONCATENATE**: Statements on the invoices of child customers will be appended
+          #   to the consolidated invoice
+          #
+          #   **NONE**: Do not generate consolidated invoices
+          #
+          #   @return [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType, nil]
+          optional :invoice_consolidation_type,
+                   enum: -> { MetronomeSDK::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType }
+
+          # @!method initialize(invoice_consolidation_type: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior}
+          #   for more details.
+          #
+          #   @param invoice_consolidation_type [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior::InvoiceConsolidationType] Account hierarchy M3 - Indicates the desired behavior of consolidated invoices g
+
+          # Account hierarchy M3 - Indicates the desired behavior of consolidated invoices
+          # generated by the parent in a customer hierarchy
+          #
+          # **CONCATENATE**: Statements on the invoices of child customers will be appended
+          # to the consolidated invoice
+          #
+          # **NONE**: Do not generate consolidated invoices
+          #
+          # @see MetronomeSDK::Models::HierarchyConfiguration::ParentHierarchyConfiguration::ParentBehavior#invoice_consolidation_type
+          module InvoiceConsolidationType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            CONCATENATE = :CONCATENATE
+            NONE = :NONE
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
       end
 
       class ChildHierarchyConfiguration < MetronomeSDK::Internal::Type::BaseModel
@@ -46,8 +96,41 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Parent]
         required :parent, -> { MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Parent }
 
-        # @!method initialize(parent:)
+        # @!attribute payer
+        #   Account hierarchy M3 - Indicates which customer should pay for the child's
+        #   invoice charges
+        #
+        #   **SELF**: The child pays for its own invoice charges
+        #
+        #   **PARENT**: The parent pays for the child's invoice charges
+        #
+        #   @return [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Payer, nil]
+        optional :payer, enum: -> { MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::Payer }
+
+        # @!attribute usage_statement_behavior
+        #   Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+        #   on the parent's invoices.
+        #
+        #   **CONSOLIDATE**: Child's invoice statements will be added to parent's
+        #   consolidated invoices
+        #
+        #   **SEPARATE**: Child's invoice statements will appear not appear on parent's
+        #   consolidated invoices
+        #
+        #   @return [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior, nil]
+        optional :usage_statement_behavior,
+                 enum: -> { MetronomeSDK::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior }
+
+        # @!method initialize(parent:, payer: nil, usage_statement_behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration} for
+        #   more details.
+        #
         #   @param parent [MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Parent] The single parent contract/customer for this child.
+        #
+        #   @param payer [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::Payer] Account hierarchy M3 - Indicates which customer should pay for the child's invoi
+        #
+        #   @param usage_statement_behavior [Symbol, MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration::UsageStatementBehavior] Account hierarchy M3 - Indicates the behavior of the child's invoice statements
 
         # @see MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration#parent
         class Parent < MetronomeSDK::Internal::Type::BaseModel
@@ -67,6 +150,44 @@ module MetronomeSDK
           #   @param contract_id [String]
           #   @param customer_id [String]
         end
+
+        # Account hierarchy M3 - Indicates which customer should pay for the child's
+        # invoice charges
+        #
+        # **SELF**: The child pays for its own invoice charges
+        #
+        # **PARENT**: The parent pays for the child's invoice charges
+        #
+        # @see MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration#payer
+        module Payer
+          extend MetronomeSDK::Internal::Type::Enum
+
+          SELF = :SELF
+          PARENT = :PARENT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Account hierarchy M3 - Indicates the behavior of the child's invoice statements
+        # on the parent's invoices.
+        #
+        # **CONSOLIDATE**: Child's invoice statements will be added to parent's
+        # consolidated invoices
+        #
+        # **SEPARATE**: Child's invoice statements will appear not appear on parent's
+        # consolidated invoices
+        #
+        # @see MetronomeSDK::Models::HierarchyConfiguration::ChildHierarchyConfiguration#usage_statement_behavior
+        module UsageStatementBehavior
+          extend MetronomeSDK::Internal::Type::Enum
+
+          CONSOLIDATE = :CONSOLIDATE
+          SEPARATE = :SEPARATE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # @!method self.variants

data/lib/metronome_sdk/models/payment_gate_config.rb

@@ -139,6 +139,7 @@ module MetronomeSDK
         NONE = :NONE
         STRIPE = :STRIPE
         ANROK = :ANROK
+        AVALARA = :AVALARA
         PRECALCULATED = :PRECALCULATED
 
         # @!method self.values

data/lib/metronome_sdk/models/payment_gate_config_v2.rb

@@ -139,6 +139,7 @@ module MetronomeSDK
         NONE = :NONE
         STRIPE = :STRIPE
         ANROK = :ANROK
+        AVALARA = :AVALARA
         PRECALCULATED = :PRECALCULATED
 
         # @!method self.values

data/lib/metronome_sdk/models/subscription.rb

@@ -3,6 +3,12 @@
 module MetronomeSDK
   module Models
     class Subscription < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute billing_periods
+      #   Previous, current, and next billing periods for the subscription.
+      #
+      #   @return [MetronomeSDK::Models::Subscription::BillingPeriods]
+      required :billing_periods, -> { MetronomeSDK::Subscription::BillingPeriods }
+
       # @!attribute collection_schedule
       #
       #   @return [Symbol, MetronomeSDK::Models::Subscription::CollectionSchedule]
@@ -18,6 +24,11 @@ module MetronomeSDK
       #   QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
       #   directly on the subscription. `initial_quantity` must be provided with this
       #   option. Compatible with recurring commits/credits that use POOLED allocation.
+      #   **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+      #   add user_123) to increment and decrement a subscription quantity, rather than
+      #   directly providing the quantity. You must use a **SEAT_BASED** subscription to
+      #   use a linked recurring credit with an allocation per seat. `seat_config` must be
+      #   provided with this option.
       #
       #   @return [Symbol, MetronomeSDK::Models::Subscription::QuantityManagementMode]
       required :quantity_management_mode, enum: -> { MetronomeSDK::Subscription::QuantityManagementMode }
@@ -71,10 +82,12 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :name, String
 
-      # @!method initialize(collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil)
+      # @!method initialize(billing_periods:, collection_schedule:, proration:, quantity_management_mode:, quantity_schedule:, starting_at:, subscription_rate:, id: nil, custom_fields: nil, description: nil, ending_before: nil, fiat_credit_type_id: nil, name: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Subscription} for more details.
       #
+      #   @param billing_periods [MetronomeSDK::Models::Subscription::BillingPeriods] Previous, current, and next billing periods for the subscription.
+      #
       #   @param collection_schedule [Symbol, MetronomeSDK::Models::Subscription::CollectionSchedule]
       #
       #   @param proration [MetronomeSDK::Models::Subscription::Proration]
@@ -99,6 +112,82 @@ module MetronomeSDK
       #
       #   @param name [String]
 
+      # @see MetronomeSDK::Models::Subscription#billing_periods
+      class BillingPeriods < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute current
+        #
+        #   @return [MetronomeSDK::Models::Subscription::BillingPeriods::Current, nil]
+        optional :current, -> { MetronomeSDK::Subscription::BillingPeriods::Current }
+
+        # @!attribute next_
+        #
+        #   @return [MetronomeSDK::Models::Subscription::BillingPeriods::Next, nil]
+        optional :next_, -> { MetronomeSDK::Subscription::BillingPeriods::Next }, api_name: :next
+
+        # @!attribute previous
+        #
+        #   @return [MetronomeSDK::Models::Subscription::BillingPeriods::Previous, nil]
+        optional :previous, -> { MetronomeSDK::Subscription::BillingPeriods::Previous }
+
+        # @!method initialize(current: nil, next_: nil, previous: nil)
+        #   Previous, current, and next billing periods for the subscription.
+        #
+        #   @param current [MetronomeSDK::Models::Subscription::BillingPeriods::Current]
+        #   @param next_ [MetronomeSDK::Models::Subscription::BillingPeriods::Next]
+        #   @param previous [MetronomeSDK::Models::Subscription::BillingPeriods::Previous]
+
+        # @see MetronomeSDK::Models::Subscription::BillingPeriods#current
+        class Current < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute ending_before
+          #
+          #   @return [Time]
+          required :ending_before, Time
+
+          # @!attribute starting_at
+          #
+          #   @return [Time]
+          required :starting_at, Time
+
+          # @!method initialize(ending_before:, starting_at:)
+          #   @param ending_before [Time]
+          #   @param starting_at [Time]
+        end
+
+        # @see MetronomeSDK::Models::Subscription::BillingPeriods#next_
+        class Next < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute ending_before
+          #
+          #   @return [Time]
+          required :ending_before, Time
+
+          # @!attribute starting_at
+          #
+          #   @return [Time]
+          required :starting_at, Time
+
+          # @!method initialize(ending_before:, starting_at:)
+          #   @param ending_before [Time]
+          #   @param starting_at [Time]
+        end
+
+        # @see MetronomeSDK::Models::Subscription::BillingPeriods#previous
+        class Previous < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute ending_before
+          #
+          #   @return [Time]
+          required :ending_before, Time
+
+          # @!attribute starting_at
+          #
+          #   @return [Time]
+          required :starting_at, Time
+
+          # @!method initialize(ending_before:, starting_at:)
+          #   @param ending_before [Time]
+          #   @param starting_at [Time]
+        end
+      end
+
       # @see MetronomeSDK::Models::Subscription#collection_schedule
       module CollectionSchedule
         extend MetronomeSDK::Internal::Type::Enum
@@ -142,6 +231,11 @@ module MetronomeSDK
       # QUANTITY_ONLY. **QUANTITY_ONLY**: The subscription quantity is specified
       # directly on the subscription. `initial_quantity` must be provided with this
       # option. Compatible with recurring commits/credits that use POOLED allocation.
+      # **SEAT_BASED**: (BETA) Use when you want to pass specific seat identifiers (e.g.
+      # add user_123) to increment and decrement a subscription quantity, rather than
+      # directly providing the quantity. You must use a **SEAT_BASED** subscription to
+      # use a linked recurring credit with an allocation per seat. `seat_config` must be
+      # provided with this option.
       #
       # @see MetronomeSDK::Models::Subscription#quantity_management_mode
       module QuantityManagementMode