metronome-sdk 2.1.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70b65323a25a4de65861565a092a6aa70f43d28e5e910acca44d883efe9cf86
-  data.tar.gz: 4d89458274f95fb69ca5d6bccad455a6ecaf92a3d1a93b8843290166f724e01d
+  metadata.gz: a988182a5b3f8a91e63e06cc9ed209042ea94b2b5d93b70767ea7b1af2509e65
+  data.tar.gz: 54b423b7428e7994d37133d36b0357032f84db951abe9bb5bb5f424c40247241
 SHA512:
-  metadata.gz: '010907bdf574da3664f42af09be522e41a87dfc4ae1280ee4307326c8d62751c1fdc11bfec4214ec22176cbaf0002a2f1a7b6ed3668da3fb3347ab2bdb3b5494'
-  data.tar.gz: d9be0ec4d10b760064dc84412f78c074258613af6b2ba7e33432ddade4c39d6356ed9d4fc59fb7a89eadc1ce4cd99f893e7c329bbedc27b4dc8e3ac8f76d1c5d
+  metadata.gz: 3ea8e0edd4dc7010d06dd66b20834d5673d79fbfb2c76211bf6c9891f5e836858ad3e8a640e21774e0da7cd9cb9276e1029f8b76b0d867a1d5a95ab195a8773e
+  data.tar.gz: 8a585909ec60973a81a8daeed7a6c6bb0a3f11cb88c03be03903f173c5a501a88a07ec42ff4e344abd9151291724e88e55156f0b137ec9640dcb1b0a43e9d2b3

data/CHANGELOG.md

@@ -1,5 +1,70 @@
 # Changelog
 
+## 3.0.0 (2026-01-17)
+
+Full Changelog: [v2.2.0...v3.0.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v2.2.0...v3.0.0)
+
+### Features
+
+* [ORCH-739] expose rev rec data in api ([1e5912a](https://github.com/Metronome-Industries/metronome-ruby/commit/1e5912a60dd3bbfb37740057beac9055f96911e4))
+* [ORCH-739] expose rev rec data in api ([ea99ea2](https://github.com/Metronome-Industries/metronome-ruby/commit/ea99ea27275244d1854395b0906bf1402f09308f))
+* add recurring commit ID and subscription config to commit/credit response schema ([87a38ed](https://github.com/Metronome-Industries/metronome-ruby/commit/87a38ed2828cac15073a4650347ff2b6d3c14935))
+* Add support for custom fields on package terms ([e6ca46b](https://github.com/Metronome-Industries/metronome-ruby/commit/e6ca46b3d30e047799c76d5b6e9407622c94f027))
+* remove use list prices config in requests and responses ([44e02d3](https://github.com/Metronome-Industries/metronome-ruby/commit/44e02d367bedd33dca17c34d45006d21ef630abd))
+* Revert [ORCH-739] expose rev rec data in api ([656d322](https://github.com/Metronome-Industries/metronome-ruby/commit/656d322008021add127b8b6a76e70f3576090e2b))
+
+
+### Chores
+
+* fix typo in descriptions ([fdce90d](https://github.com/Metronome-Industries/metronome-ruby/commit/fdce90df6ae0e1223005482011560ba7eb53821c))
+* **internal:** codegen related update ([64bba19](https://github.com/Metronome-Industries/metronome-ruby/commit/64bba1958c92d4d260271fffc212a7ac904fe881))
+* **internal:** codegen related update ([3237dc8](https://github.com/Metronome-Industries/metronome-ruby/commit/3237dc894931f5a4a4504f545f46be1a0d9b8841))
+* **internal:** update `actions/checkout` version ([5aa0985](https://github.com/Metronome-Industries/metronome-ruby/commit/5aa09854840915a76d003d2e94ea7b25478ca198))
+
+
+### Documentation
+
+* prominently feature MCP server setup in root SDK readmes ([353dc18](https://github.com/Metronome-Industries/metronome-ruby/commit/353dc181c9ce9b55c3e588849391c257ca6e79d8))
+
+## 2.2.0 (2025-12-18)
+
+Full Changelog: [v2.1.0...v2.2.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v2.1.0...v2.2.0)
+
+### Features
+
+* [ORCH-605] uses x-mint groups to enable conditional rendering of gated revenue system config apis ([22ceee8](https://github.com/Metronome-Industries/metronome-ruby/commit/22ceee870bf6b1642ff4283b37485be599658e47))
+* [ORCH-752] Update contract creation endpoints to allow setting revenue system configuration ([c2ca4f7](https://github.com/Metronome-Industries/metronome-ruby/commit/c2ca4f7ef46b0ead89b74a6e75a37a2ba55d9dc8))
+* Add `commit_transactions` to the body of `/upsertAvalaraCredentials` endpoint ([d99cab3](https://github.com/Metronome-Industries/metronome-ruby/commit/d99cab3cda4f2da4f80ec925c76583e31ea1763a))
+* Add `seat_filter` field to creation request and response parameters of the alert object ([165e3f0](https://github.com/Metronome-Industries/metronome-ruby/commit/165e3f0deab903b00fb7b4b235179b52a4f8093f))
+* add quantity to plan pricing adjustment response ([cbf2539](https://github.com/Metronome-Industries/metronome-ruby/commit/cbf2539bbab6fac9f0d4984cd0f88c9f6b0ceea2))
+* adds external_payment_id to ExternalInvoice ([ff5f18f](https://github.com/Metronome-Industries/metronome-ruby/commit/ff5f18f6b14e08b4c499689ca329b357a03177a9))
+* everything ([6188141](https://github.com/Metronome-Industries/metronome-ruby/commit/618814115adbe126a1b0b5a330244034a14c98f7))
+* GET-6845 get openapi specs ready for GA ([dc48f09](https://github.com/Metronome-Industries/metronome-ruby/commit/dc48f094c3283251a7f452aa4cc3db917ee7eba6))
+* include aggregation BM info from searchEvents ([ea0dfc0](https://github.com/Metronome-Industries/metronome-ruby/commit/ea0dfc021a244b0e0d3ebfbcdacfc053f5194b61))
+* ORCH-833/948/946/947 - updated the API to accept aws_customer_account_id all gated behind a feature flag ([4c2e292](https://github.com/Metronome-Industries/metronome-ruby/commit/4c2e2926ed8b6d0844b3670312f9780f14df2beb))
+* remove beta language, FF, stainless skip ([b504def](https://github.com/Metronome-Industries/metronome-ruby/commit/b504defa5b97aa3f622bbc746e76ac12691d1e90))
+* Return values for set customer billing configuration endpoint ([1641a74](https://github.com/Metronome-Industries/metronome-ruby/commit/1641a74439ebf507fb85f0478bbd056f6047c173))
+* update create alert api to allow LowRemainingSeatBalanceReached alert ([54a60e6](https://github.com/Metronome-Industries/metronome-ruby/commit/54a60e6027b889e61554b7a006c780e3a9fc4815))
+
+
+### Bug Fixes
+
+* better thread safety via early initializing SSL store during HTTP client creation ([341992d](https://github.com/Metronome-Industries/metronome-ruby/commit/341992d633b9191d24209713f5f6a734d2229601))
+* calling `break` out of streams should be instantaneous ([0db918b](https://github.com/Metronome-Industries/metronome-ruby/commit/0db918bb075b3420715faf0e73ef96cc01d58697))
+* issue where json.parse errors when receiving HTTP 204 with nobody ([7a27bb6](https://github.com/Metronome-Industries/metronome-ruby/commit/7a27bb648e886deaf33358cde8f5c3c5d80ccf42))
+
+
+### Chores
+
+* **client:** send user-agent header ([379e4e4](https://github.com/Metronome-Industries/metronome-ruby/commit/379e4e46eb858bce94633dd193fbc1526ea1c42c))
+* explicitly require "base64" gem ([5d4a7dc](https://github.com/Metronome-Industries/metronome-ruby/commit/5d4a7dc568346f2fc33ab39cf1517582923d98d5))
+* **internal:** codegen related update ([9878983](https://github.com/Metronome-Industries/metronome-ruby/commit/9878983e4d67b0d04d543d7a49afdd14e9eb4f73))
+
+
+### Documentation
+
+* document missing fields for schemas related to recurring credits and commits ([d848e15](https://github.com/Metronome-Industries/metronome-ruby/commit/d848e159b2046aebccea5d2b3915779adf891791))
+
 ## 2.1.0 (2025-10-31)
 
 Full Changelog: [v2.0.0...v2.1.0](https://github.com/Metronome-Industries/metronome-ruby/compare/v2.0.0...v2.1.0)

data/README.md

@@ -4,6 +4,15 @@ The Metronome Ruby library provides convenient access to the Metronome REST API
 
 It is generated with [Stainless](https://www.stainless.com/).
 
+## MCP Server
+
+Use the Metronome MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40metronome%2Fmcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkBtZXRyb25vbWUvbWNwIl19)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40metronome%2Fmcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40metronome%2Fmcp%22%5D%7D)
+
+> Note: You may need to set environment variables in your MCP client.
+
 ## Documentation
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/metronome-sdk).
@@ -17,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "metronome-sdk", "~> 2.1.0"
+gem "metronome-sdk", "~> 3.0.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/metronome_sdk/internal/transport/base_client.rb

@@ -201,7 +201,8 @@ module MetronomeSDK
             self.class::PLATFORM_HEADERS,
             {
               "accept" => "application/json",
-              "content-type" => "application/json"
+              "content-type" => "application/json",
+              "user-agent" => user_agent
             },
             headers
           )
@@ -219,6 +220,11 @@ module MetronomeSDK
         # @return [Hash{String=>String}]
         private def auth_headers = {}
 
+        # @api private
+        #
+        # @return [String]
+        private def user_agent = "#{self.class.name}/Ruby #{MetronomeSDK::VERSION}"
+
         # @api private
         #
         # @return [String]

data/lib/metronome_sdk/internal/transport/pooled_net_requester.rb

@@ -16,10 +16,11 @@ module MetronomeSDK
         class << self
           # @api private
           #
+          # @param cert_store [OpenSSL::X509::Store]
           # @param url [URI::Generic]
           #
           # @return [Net::HTTP]
-          def connect(url)
+          def connect(cert_store:, url:)
             port =
               case [url.port, url.scheme]
               in [Integer, _]
@@ -33,6 +34,8 @@ module MetronomeSDK
             Net::HTTP.new(url.host, port).tap do
               _1.use_ssl = %w[https wss].include?(url.scheme)
               _1.max_retries = 0
+
+              (_1.cert_store = cert_store) if _1.use_ssl?
             end
           end
 
@@ -102,7 +105,7 @@ module MetronomeSDK
           pool =
             @mutex.synchronize do
               @pools[origin] ||= ConnectionPool.new(size: @size) do
-                self.class.connect(url)
+                self.class.connect(cert_store: @cert_store, url: url)
               end
             end
 
@@ -150,17 +153,19 @@ module MetronomeSDK
                   end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
-                  conn.request(req) do |rsp|
-                    y << [req, rsp]
-                    break if finished
-
-                    rsp.read_body do |bytes|
-                      y << bytes.force_encoding(Encoding::BINARY)
-                      break if finished
-
-                      self.class.calibrate_socket_timeout(conn, deadline)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
                     end
-                    eof = true
                   end
                 end
               ensure
@@ -192,6 +197,7 @@ module MetronomeSDK
         def initialize(size: self.class::DEFAULT_MAX_CONNECTIONS)
           @mutex = Mutex.new
           @size = size
+          @cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths)
           @pools = {}
         end
 

data/lib/metronome_sdk/internal/util.rb

@@ -657,7 +657,8 @@ module MetronomeSDK
         def decode_content(headers, stream:, suppress_error: false)
           case (content_type = headers["content-type"])
           in MetronomeSDK::Internal::Util::JSON_CONTENT
-            json = stream.to_a.join
+            return nil if (json = stream.to_a.join).empty?
+
             begin
               JSON.parse(json, symbolize_names: true)
             rescue JSON::ParserError => e
@@ -667,7 +668,11 @@ module MetronomeSDK
           in MetronomeSDK::Internal::Util::JSONL_CONTENT
             lines = decode_lines(stream)
             chain_fused(lines) do |y|
-              lines.each { y << JSON.parse(_1, symbolize_names: true) }
+              lines.each do
+                next if _1.empty?
+
+                y << JSON.parse(_1, symbolize_names: true)
+              end
             end
           in %r{^text/event-stream}
             lines = decode_lines(stream)

data/lib/metronome_sdk/models/commit.rb

@@ -140,6 +140,13 @@ module MetronomeSDK
       #   @return [Symbol, MetronomeSDK::Models::Commit::RateType, nil]
       optional :rate_type, enum: -> { MetronomeSDK::Commit::RateType }
 
+      # @!attribute recurring_commit_id
+      #   The ID of the recurring commit that this commit was generated from, if
+      #   applicable.
+      #
+      #   @return [String, nil]
+      optional :recurring_commit_id, String
+
       # @!attribute rolled_over_from
       #
       #   @return [MetronomeSDK::Models::Commit::RolledOverFrom, nil]
@@ -164,6 +171,13 @@ module MetronomeSDK
       #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
       optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
+      # @!attribute subscription_config
+      #   The subscription configuration for this commit, if it was generated from a
+      #   recurring commit with a subscription attached.
+      #
+      #   @return [MetronomeSDK::Models::Commit::SubscriptionConfig, nil]
+      optional :subscription_config, -> { MetronomeSDK::Commit::SubscriptionConfig }
+
       # @!attribute uniqueness_key
       #   Prevents the creation of duplicates. If a request to create a commit or credit
       #   is made with a uniqueness key that was previously used to create a commit or
@@ -173,7 +187,7 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :uniqueness_key, String
 
-      # @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil)
+      # @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, amount: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil, uniqueness_key: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Commit} for more details.
       #
@@ -221,6 +235,8 @@ module MetronomeSDK
       #
       #   @param rate_type [Symbol, MetronomeSDK::Models::Commit::RateType]
       #
+      #   @param recurring_commit_id [String] The ID of the recurring commit that this commit was generated from, if applicabl
+      #
       #   @param rolled_over_from [MetronomeSDK::Models::Commit::RolledOverFrom]
       #
       #   @param rollover_fraction [Float]
@@ -229,6 +245,8 @@ module MetronomeSDK
       #
       #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
       #
+      #   @param subscription_config [MetronomeSDK::Models::Commit::SubscriptionConfig] The subscription configuration for this commit, if it was generated from a recur
+      #
       #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
 
       # @see MetronomeSDK::Models::Commit#product
@@ -934,6 +952,56 @@ module MetronomeSDK
         #   @param commit_id [String]
         #   @param contract_id [String]
       end
+
+      # @see MetronomeSDK::Models::Commit#subscription_config
+      class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute allocation
+        #
+        #   @return [Symbol, MetronomeSDK::Models::Commit::SubscriptionConfig::Allocation, nil]
+        optional :allocation, enum: -> { MetronomeSDK::Commit::SubscriptionConfig::Allocation }
+
+        # @!attribute apply_seat_increase_config
+        #
+        #   @return [MetronomeSDK::Models::Commit::SubscriptionConfig::ApplySeatIncreaseConfig, nil]
+        optional :apply_seat_increase_config,
+                 -> { MetronomeSDK::Commit::SubscriptionConfig::ApplySeatIncreaseConfig }
+
+        # @!attribute subscription_id
+        #
+        #   @return [String, nil]
+        optional :subscription_id, String
+
+        # @!method initialize(allocation: nil, apply_seat_increase_config: nil, subscription_id: nil)
+        #   The subscription configuration for this commit, if it was generated from a
+        #   recurring commit with a subscription attached.
+        #
+        #   @param allocation [Symbol, MetronomeSDK::Models::Commit::SubscriptionConfig::Allocation]
+        #   @param apply_seat_increase_config [MetronomeSDK::Models::Commit::SubscriptionConfig::ApplySeatIncreaseConfig]
+        #   @param subscription_id [String]
+
+        # @see MetronomeSDK::Models::Commit::SubscriptionConfig#allocation
+        module Allocation
+          extend MetronomeSDK::Internal::Type::Enum
+
+          INDIVIDUAL = :INDIVIDUAL
+          POOLED = :POOLED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see MetronomeSDK::Models::Commit::SubscriptionConfig#apply_seat_increase_config
+        class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute is_prorated
+          #   Indicates whether a mid-period seat increase should be prorated.
+          #
+          #   @return [Boolean]
+          required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+          # @!method initialize(is_prorated:)
+          #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+        end
+      end
     end
   end
 end

data/lib/metronome_sdk/models/contract_v2.rb

@@ -421,6 +421,12 @@ module MetronomeSDK
         #   @return [Symbol, MetronomeSDK::Models::ContractV2::Commit::RateType, nil]
         optional :rate_type, enum: -> { MetronomeSDK::ContractV2::Commit::RateType }
 
+        # @!attribute recurring_commit_id
+        #   The ID of the recurring commit that created this commit
+        #
+        #   @return [String, nil]
+        optional :recurring_commit_id, String
+
         # @!attribute rolled_over_from
         #
         #   @return [MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom, nil]
@@ -445,7 +451,13 @@ module MetronomeSDK
         #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
         optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
-        # @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil)
+        # @!attribute subscription_config
+        #   Attach a subscription to the recurring commit/credit.
+        #
+        #   @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
+        optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
+
+        # @!method initialize(id:, created_at:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, archived_at: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, invoice_contract: nil, invoice_schedule: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_commit_id: nil, rolled_over_from: nil, rollover_fraction: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractV2::Commit} for more details.
         #
@@ -491,6 +503,8 @@ module MetronomeSDK
         #
         #   @param rate_type [Symbol, MetronomeSDK::Models::ContractV2::Commit::RateType]
         #
+        #   @param recurring_commit_id [String] The ID of the recurring commit that created this commit
+        #
         #   @param rolled_over_from [MetronomeSDK::Models::ContractV2::Commit::RolledOverFrom]
         #
         #   @param rollover_fraction [Float]
@@ -498,6 +512,8 @@ module MetronomeSDK
         #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
         #
         #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
+        #
+        #   @param subscription_config [MetronomeSDK::Models::RecurringCommitSubscriptionConfig] Attach a subscription to the recurring commit/credit.
 
         # @see MetronomeSDK::Models::ContractV2::Commit#product
         class Product < MetronomeSDK::Internal::Type::BaseModel
@@ -1646,6 +1662,15 @@ module MetronomeSDK
         #   @return [MetronomeSDK::Models::ContractV2::Credit::Contract, nil]
         optional :contract, -> { MetronomeSDK::ContractV2::Credit::Contract }
 
+        # @!attribute created_at
+        #   Timestamp of when the credit was created.
+        #
+        #   - Recurring credits: latter of credit service period date and parent credit
+        #     start date
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
         # @!attribute custom_fields
         #   Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         #
@@ -1689,6 +1714,12 @@ module MetronomeSDK
         #   @return [Float, nil]
         optional :priority, Float
 
+        # @!attribute recurring_credit_id
+        #   The ID of the recurring credit that created this credit
+        #
+        #   @return [String, nil]
+        optional :recurring_credit_id, String
+
         # @!attribute salesforce_opportunity_id
         #   This field's availability is dependent on your client's configuration.
         #
@@ -1703,7 +1734,13 @@ module MetronomeSDK
         #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
         optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
-        # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, salesforce_opportunity_id: nil, specifiers: nil)
+        # @!attribute subscription_config
+        #   Attach a subscription to the recurring commit/credit.
+        #
+        #   @return [MetronomeSDK::Models::RecurringCommitSubscriptionConfig, nil]
+        optional :subscription_config, -> { MetronomeSDK::RecurringCommitSubscriptionConfig }
+
+        # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, created_at: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, recurring_credit_id: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil)
         #   Some parameter documentations has been truncated, see
         #   {MetronomeSDK::Models::ContractV2::Credit} for more details.
         #
@@ -1725,6 +1762,8 @@ module MetronomeSDK
         #
         #   @param contract [MetronomeSDK::Models::ContractV2::Credit::Contract]
         #
+        #   @param created_at [Time] Timestamp of when the credit was created.
+        #
         #   @param custom_fields [Hash{Symbol=>String}] Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         #
         #   @param description [String]
@@ -1739,9 +1778,13 @@ module MetronomeSDK
         #
         #   @param priority [Float] If multiple credits or commits are applicable, the one with the lower priority w
         #
+        #   @param recurring_credit_id [String] The ID of the recurring credit that created this credit
+        #
         #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
         #
         #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
+        #
+        #   @param subscription_config [MetronomeSDK::Models::RecurringCommitSubscriptionConfig] Attach a subscription to the recurring commit/credit.
 
         # @see MetronomeSDK::Models::ContractV2::Credit#product
         class Product < MetronomeSDK::Internal::Type::BaseModel

data/lib/metronome_sdk/models/credit.rb

@@ -104,6 +104,13 @@ module MetronomeSDK
       #   @return [Symbol, MetronomeSDK::Models::Credit::RateType, nil]
       optional :rate_type, enum: -> { MetronomeSDK::Credit::RateType }
 
+      # @!attribute recurring_credit_id
+      #   The ID of the recurring credit that this credit was generated from, if
+      #   applicable.
+      #
+      #   @return [String, nil]
+      optional :recurring_credit_id, String
+
       # @!attribute salesforce_opportunity_id
       #   This field's availability is dependent on your client's configuration.
       #
@@ -118,6 +125,13 @@ module MetronomeSDK
       #   @return [Array<MetronomeSDK::Models::CommitSpecifier>, nil]
       optional :specifiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::CommitSpecifier] }
 
+      # @!attribute subscription_config
+      #   The subscription configuration for this credit, if it was generated from a
+      #   recurring credit with a subscription attached.
+      #
+      #   @return [MetronomeSDK::Models::Credit::SubscriptionConfig, nil]
+      optional :subscription_config, -> { MetronomeSDK::Credit::SubscriptionConfig }
+
       # @!attribute uniqueness_key
       #   Prevents the creation of duplicates. If a request to create a commit or credit
       #   is made with a uniqueness key that was previously used to create a commit or
@@ -127,7 +141,7 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :uniqueness_key, String
 
-      # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil)
+      # @!method initialize(id:, product:, type:, access_schedule: nil, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, balance: nil, contract: nil, custom_fields: nil, description: nil, hierarchy_configuration: nil, ledger: nil, name: nil, netsuite_sales_order_id: nil, priority: nil, rate_type: nil, recurring_credit_id: nil, salesforce_opportunity_id: nil, specifiers: nil, subscription_config: nil, uniqueness_key: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Credit} for more details.
       #
@@ -165,10 +179,14 @@ module MetronomeSDK
       #
       #   @param rate_type [Symbol, MetronomeSDK::Models::Credit::RateType]
       #
+      #   @param recurring_credit_id [String] The ID of the recurring credit that this credit was generated from, if applicabl
+      #
       #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
       #
       #   @param specifiers [Array<MetronomeSDK::Models::CommitSpecifier>] List of filters that determine what kind of customer usage draws down a commit o
       #
+      #   @param subscription_config [MetronomeSDK::Models::Credit::SubscriptionConfig] The subscription configuration for this credit, if it was generated from a recur
+      #
       #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
 
       # @see MetronomeSDK::Models::Credit#product
@@ -543,6 +561,56 @@ module MetronomeSDK
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      # @see MetronomeSDK::Models::Credit#subscription_config
+      class SubscriptionConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute allocation
+        #
+        #   @return [Symbol, MetronomeSDK::Models::Credit::SubscriptionConfig::Allocation, nil]
+        optional :allocation, enum: -> { MetronomeSDK::Credit::SubscriptionConfig::Allocation }
+
+        # @!attribute apply_seat_increase_config
+        #
+        #   @return [MetronomeSDK::Models::Credit::SubscriptionConfig::ApplySeatIncreaseConfig, nil]
+        optional :apply_seat_increase_config,
+                 -> { MetronomeSDK::Credit::SubscriptionConfig::ApplySeatIncreaseConfig }
+
+        # @!attribute subscription_id
+        #
+        #   @return [String, nil]
+        optional :subscription_id, String
+
+        # @!method initialize(allocation: nil, apply_seat_increase_config: nil, subscription_id: nil)
+        #   The subscription configuration for this credit, if it was generated from a
+        #   recurring credit with a subscription attached.
+        #
+        #   @param allocation [Symbol, MetronomeSDK::Models::Credit::SubscriptionConfig::Allocation]
+        #   @param apply_seat_increase_config [MetronomeSDK::Models::Credit::SubscriptionConfig::ApplySeatIncreaseConfig]
+        #   @param subscription_id [String]
+
+        # @see MetronomeSDK::Models::Credit::SubscriptionConfig#allocation
+        module Allocation
+          extend MetronomeSDK::Internal::Type::Enum
+
+          INDIVIDUAL = :INDIVIDUAL
+          POOLED = :POOLED
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see MetronomeSDK::Models::Credit::SubscriptionConfig#apply_seat_increase_config
+        class ApplySeatIncreaseConfig < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute is_prorated
+          #   Indicates whether a mid-period seat increase should be prorated.
+          #
+          #   @return [Boolean]
+          required :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+          # @!method initialize(is_prorated:)
+          #   @param is_prorated [Boolean] Indicates whether a mid-period seat increase should be prorated.
+        end
+      end
     end
   end
 end

data/lib/metronome_sdk/models/rate.rb

@@ -53,15 +53,7 @@ module MetronomeSDK
       #   @return [Array<MetronomeSDK::Models::Tier>, nil]
       optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
 
-      # @!attribute use_list_prices
-      #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
-      #   using list prices rather than the standard rates for this product on the
-      #   contract.
-      #
-      #   @return [Boolean, nil]
-      optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
-
-      # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+      # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Rate} for more details.
       #
@@ -80,8 +72,6 @@ module MetronomeSDK
       #   @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.
-      #
-      #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
 
       # @see MetronomeSDK::Models::Rate#rate_type
       module RateType

data/lib/metronome_sdk/models/subscription.rb

@@ -24,8 +24,8 @@ 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
+      #   **SEAT_BASED**: 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.
@@ -82,7 +82,12 @@ module MetronomeSDK
       #   @return [String, nil]
       optional :name, String
 
-      # @!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)
+      # @!attribute seat_config
+      #
+      #   @return [MetronomeSDK::Models::Subscription::SeatConfig, nil]
+      optional :seat_config, -> { MetronomeSDK::Subscription::SeatConfig }
+
+      # @!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, seat_config: nil)
       #   Some parameter documentations has been truncated, see
       #   {MetronomeSDK::Models::Subscription} for more details.
       #
@@ -111,6 +116,8 @@ module MetronomeSDK
       #   @param fiat_credit_type_id [String]
       #
       #   @param name [String]
+      #
+      #   @param seat_config [MetronomeSDK::Models::Subscription::SeatConfig]
 
       # @see MetronomeSDK::Models::Subscription#billing_periods
       class BillingPeriods < MetronomeSDK::Internal::Type::BaseModel
@@ -231,8 +238,8 @@ 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
+      # **SEAT_BASED**: 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.
@@ -316,6 +323,26 @@ module MetronomeSDK
           #   @param name [String]
         end
       end
+
+      # @see MetronomeSDK::Models::Subscription#seat_config
+      class SeatConfig < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute seat_group_key
+        #   The property name, sent on usage events, that identifies the seat ID associated
+        #   with the usage event. For example, the property name might be seat_id or
+        #   user_id. The property must be set as a group key on billable metrics and a
+        #   presentation/pricing group key on contract products. This allows linked
+        #   recurring credits with an allocation per seat to be consumed by only one seat's
+        #   usage.
+        #
+        #   @return [String]
+        required :seat_group_key, String
+
+        # @!method initialize(seat_group_key:)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::Subscription::SeatConfig} for more details.
+        #
+        #   @param seat_group_key [String] The property name, sent on usage events, that identifies the seat ID associated
+      end
     end
   end
 end