orb-billing 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00424b4ad5313d78c7d0bdc5030c16fd1d69407bca56b2e21f08f23ef71d020a
-  data.tar.gz: 6d6701aa83c11d7bd3b0dd7c0acdb6ebba1c16abc9459611e20aee18e5c02bc8
+  metadata.gz: 5c7cdd5d38f2aa6b93c7100f54d7867b638d76be4a8737ea73c1a2c4973b9340
+  data.tar.gz: 5e94a570bc66d4ebc9b9be79806626b3dc12ab835ee19c7efe78ac7c2b89224a
 SHA512:
-  metadata.gz: 78db60c44706650e85b0f51648f9451473c0a8ce4df080ffff020d47e29031b99e2689de610a8e0e4afe91aac33989836fcb43b6508e4b768aec662e26bb28a6
-  data.tar.gz: d34e236c1be08805668e64e147e028db88e3b635ac592204e7d800eceab334bef7cf05491c83ec9835ff415eff126d172fc1db5fbb956e3b4b933d3a96853e89
+  metadata.gz: 8f9921baba3f8d5438b4aa0bbcf0d54ddd4b52b9495f5318e81970535069a06237e8f6350129784166700bd37ba3b33b7421ab5d3d44e8fd3735d244a9fe8cd0
+  data.tar.gz: 715cbc4a16163338a16725d67de9915e144b9877209f6ceb86caead7047f9610c7781a851ef8e8123068536ad7090a05aa8240c4451ebe6e5f487cf63f42a076

data/CHANGELOG.md

@@ -1,5 +1,30 @@
 # Changelog
 
+## 1.13.0 (2026-03-03)
+
+Full Changelog: [v1.12.0...v1.13.0](https://github.com/orbcorp/orb-ruby/compare/v1.12.0...v1.13.0)
+
+### Features
+
+* **api:** api update ([c203926](https://github.com/orbcorp/orb-ruby/commit/c203926582b3237293d3078ada79bf3d221071d7))
+* **api:** api update ([fd4f82d](https://github.com/orbcorp/orb-ruby/commit/fd4f82dd2f04f36cd49a7413fdfaa5e1189f22c2))
+* **api:** api update ([a703c63](https://github.com/orbcorp/orb-ruby/commit/a703c638264d4dd7761a3534562f47a86b8da288))
+* **api:** api update ([49c2213](https://github.com/orbcorp/orb-ruby/commit/49c22131d40a8e0e050f894be9ff48d5958301aa))
+* **api:** api update ([357d2d4](https://github.com/orbcorp/orb-ruby/commit/357d2d4e2758c92578d1c7af1e26f1a1779738b0))
+
+
+### Bug Fixes
+
+* **client:** serialize query parameters properly ([003ab4e](https://github.com/orbcorp/orb-ruby/commit/003ab4e466176c051711b7e89e1e40be5de6a664))
+* properly mock time in ruby ci tests ([c8c588e](https://github.com/orbcorp/orb-ruby/commit/c8c588eb8bd5383d1875fef102cd7de66d6dff71))
+
+
+### Chores
+
+* **ci:** add build step ([b57c8a3](https://github.com/orbcorp/orb-ruby/commit/b57c8a3f52e22c5c67f3842357747437d12f56d7))
+* **docs:** add missing descriptions ([174bbeb](https://github.com/orbcorp/orb-ruby/commit/174bbebe6ed10a5c2c079232299b48b4269e470c))
+* update mock server docs ([4b838cf](https://github.com/orbcorp/orb-ruby/commit/4b838cf2bc89666bea9767ae25e66868d38bbeef))
+
 ## 1.12.0 (2026-02-12)
 
 Full Changelog: [v1.11.2...v1.12.0](https://github.com/orbcorp/orb-ruby/compare/v1.11.2...v1.12.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 1.12.0"
+gem "orb-billing", "~> 1.13.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/client.rb

@@ -21,42 +21,109 @@ module Orb
     # @return [Orb::Resources::TopLevel]
     attr_reader :top_level
 
+    # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+    # subscribed to by a customer. Plans define the billing behavior of the
+    # subscription. You can see more about how to configure prices in the
+    # [Price resource](/reference/price).
     # @return [Orb::Resources::Beta]
     attr_reader :beta
 
+    # A coupon represents a reusable discount configuration that can be applied either
+    # as a fixed or percentage amount to an invoice or subscription. Coupons are
+    # activated using a redemption code, which applies the discount to a subscription
+    # or invoice. The duration of a coupon determines how long it remains available
+    # for use by end users.
     # @return [Orb::Resources::Coupons]
     attr_reader :coupons
 
+    # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+    # been applied to a particular invoice.
     # @return [Orb::Resources::CreditNotes]
     attr_reader :credit_notes
 
+    # A customer is a buyer of your products, and the other party to the billing
+    # relationship.
+    #
+    # In Orb, customers are assigned system generated identifiers automatically, but
+    # it's often desirable to have these match existing identifiers in your system. To
+    # avoid having to denormalize Orb ID information, you can pass in an
+    # `external_customer_id` with your own identifier. See
+    # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+    # information about how these aliases work in Orb.
+    #
+    # In addition to having an identifier in your system, a customer may exist in a
+    # payment provider solution like Stripe. Use the `payment_provider_id` and the
+    # `payment_provider` enum field to express this mapping.
+    #
+    # A customer also has a timezone (from the standard
+    # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+    # your account's timezone. See [Timezone localization](/essentials/timezones) for
+    # information on what this timezone parameter influences within Orb.
     # @return [Orb::Resources::Customers]
     attr_reader :customers
 
+    # The [Event](/core-concepts#event) resource represents a usage event that has
+    # been created for a customer. Events are the core of Orb's usage-based billing
+    # model, and are used to calculate the usage charges for a given billing period.
     # @return [Orb::Resources::Events]
     attr_reader :events
 
+    # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+    # representing the request for payment for a single subscription. This includes a
+    # set of line items, which correspond to prices in the subscription's plan and can
+    # represent fixed recurring fees or usage-based fees. They are generated at the
+    # end of a billing period, or as the result of an action, such as a cancellation.
     # @return [Orb::Resources::InvoiceLineItems]
     attr_reader :invoice_line_items
 
+    # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+    # representing the request for payment for a single subscription. This includes a
+    # set of line items, which correspond to prices in the subscription's plan and can
+    # represent fixed recurring fees or usage-based fees. They are generated at the
+    # end of a billing period, or as the result of an action, such as a cancellation.
     # @return [Orb::Resources::Invoices]
     attr_reader :invoices
 
+    # The Item resource represents a sellable product or good. Items are associated
+    # with all line items, billable metrics, and prices and are used for defining
+    # external sync behavior for invoices and tax calculation purposes.
     # @return [Orb::Resources::Items]
     attr_reader :items
 
+    # The Metric resource represents a calculation of a quantity based on events.
+    # Metrics are defined by the query that transforms raw usage events into
+    # meaningful values for your customers.
     # @return [Orb::Resources::Metrics]
     attr_reader :metrics
 
+    # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+    # subscribed to by a customer. Plans define the billing behavior of the
+    # subscription. You can see more about how to configure prices in the
+    # [Price resource](/reference/price).
     # @return [Orb::Resources::Plans]
     attr_reader :plans
 
+    # The Price resource represents a price that can be billed on a subscription,
+    # resulting in a charge on an invoice in the form of an invoice line item. Prices
+    # take a quantity and determine an amount to bill.
+    #
+    # Orb supports a few different pricing models out of the box. Each of these models
+    # is serialized differently in a given Price object. The model_type field
+    # determines the key for the configuration object that is present.
+    #
+    # For more on the types of prices, see
+    # [the core concepts documentation](/core-concepts#plan-and-price)
     # @return [Orb::Resources::Prices]
     attr_reader :prices
 
     # @return [Orb::Resources::Subscriptions]
     attr_reader :subscriptions
 
+    # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+    # usage, or credit balance and trigger webhooks when a threshold is exceeded.
+    #
+    # Alerts created through the API can be scoped to either customers or
+    # subscriptions.
     # @return [Orb::Resources::Alerts]
     attr_reader :alerts
 
@@ -66,9 +133,14 @@ module Orb
     # @return [Orb::Resources::SubscriptionChanges]
     attr_reader :subscription_changes
 
+    # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+    # credits within Orb.
     # @return [Orb::Resources::CreditBlocks]
     attr_reader :credit_blocks
 
+    # The LicenseType resource represents a type of license that can be assigned to
+    # users. License types are used during billing by grouping metrics on the
+    # configured grouping key.
     # @return [Orb::Resources::LicenseTypes]
     attr_reader :license_types
 

data/lib/orb/internal/util.rb

@@ -490,6 +490,37 @@ module Orb
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection["#{key}[]"] = element.map(&:to_s)
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]

data/lib/orb/models/billable_metric.rb

@@ -41,7 +41,14 @@ module Orb
       #   @return [Symbol, Orb::Models::BillableMetric::Status]
       required :status, enum: -> { Orb::BillableMetric::Status }
 
-      # @!method initialize(id:, description:, item:, metadata:, name:, status:)
+      # @!attribute parameter_definitions
+      #
+      #   @return [Array<Hash{Symbol=>Object}>, nil]
+      optional :parameter_definitions,
+               Orb::Internal::Type::ArrayOf[Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]],
+               nil?: true
+
+      # @!method initialize(id:, description:, item:, metadata:, name:, status:, parameter_definitions: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::BillableMetric} for more details.
       #
@@ -60,6 +67,8 @@ module Orb
       #   @param name [String]
       #
       #   @param status [Symbol, Orb::Models::BillableMetric::Status]
+      #
+      #   @param parameter_definitions [Array<Hash{Symbol=>Object}>, nil]
 
       # @see Orb::Models::BillableMetric#status
       module Status

data/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rb

@@ -243,6 +243,12 @@ module Orb
             #   @return [String, nil]
             optional :item_id, String, nil?: true
 
+            # @!attribute mark_as_paid
+            #   If true, the new credits purchase invoice will be marked as paid.
+            #
+            #   @return [Boolean, nil]
+            optional :mark_as_paid, Orb::Internal::Type::Boolean
+
             # @!attribute memo
             #   An optional memo to display on the invoice.
             #
@@ -254,7 +260,8 @@ module Orb
             #   based on the invoice or issuance date, depending on the account's configured due
             #   date calculation method. A value of '0' here represents that the invoice is due
             #   on issue, whereas a value of '30' represents that the customer has 30 days to
-            #   pay the invoice. Do not set this field if you want to set a custom due date.
+            #   pay the invoice. You must set either `net_terms` or `custom_due_date`, but not
+            #   both.
             #
             #   @return [Integer, nil]
             optional :net_terms, Integer, nil?: true
@@ -266,7 +273,7 @@ module Orb
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!method initialize(auto_collection:, custom_due_date: nil, invoice_date: nil, item_id: nil, memo: nil, net_terms: nil, require_successful_payment: nil)
+            # @!method initialize(auto_collection:, custom_due_date: nil, invoice_date: nil, item_id: nil, mark_as_paid: nil, memo: nil, net_terms: nil, require_successful_payment: nil)
             #   Some parameter documentations has been truncated, see
             #   {Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings}
             #   for more details.
@@ -284,6 +291,8 @@ module Orb
             #
             #   @param item_id [String, nil] The ID of the Item to be used for the invoice line item. If not provided, a defa
             #
+            #   @param mark_as_paid [Boolean] If true, the new credits purchase invoice will be marked as paid.
+            #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
             #   @param net_terms [Integer, nil] The net terms determines the due date of the invoice. Due date is calculated bas

data/lib/orb/models/customers/credits/ledger_create_entry_params.rb

@@ -241,6 +241,12 @@ module Orb
             #   @return [String, nil]
             optional :item_id, String, nil?: true
 
+            # @!attribute mark_as_paid
+            #   If true, the new credits purchase invoice will be marked as paid.
+            #
+            #   @return [Boolean, nil]
+            optional :mark_as_paid, Orb::Internal::Type::Boolean
+
             # @!attribute memo
             #   An optional memo to display on the invoice.
             #
@@ -252,7 +258,8 @@ module Orb
             #   based on the invoice or issuance date, depending on the account's configured due
             #   date calculation method. A value of '0' here represents that the invoice is due
             #   on issue, whereas a value of '30' represents that the customer has 30 days to
-            #   pay the invoice. Do not set this field if you want to set a custom due date.
+            #   pay the invoice. You must set either `net_terms` or `custom_due_date`, but not
+            #   both.
             #
             #   @return [Integer, nil]
             optional :net_terms, Integer, nil?: true
@@ -264,7 +271,7 @@ module Orb
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!method initialize(auto_collection:, custom_due_date: nil, invoice_date: nil, item_id: nil, memo: nil, net_terms: nil, require_successful_payment: nil)
+            # @!method initialize(auto_collection:, custom_due_date: nil, invoice_date: nil, item_id: nil, mark_as_paid: nil, memo: nil, net_terms: nil, require_successful_payment: nil)
             #   Some parameter documentations has been truncated, see
             #   {Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings} for
             #   more details.
@@ -282,6 +289,8 @@ module Orb
             #
             #   @param item_id [String, nil] The ID of the Item to be used for the invoice line item. If not provided, a defa
             #
+            #   @param mark_as_paid [Boolean] If true, the new credits purchase invoice will be marked as paid.
+            #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
             #   @param net_terms [Integer, nil] The net terms determines the due date of the invoice. Due date is calculated bas

data/lib/orb/models/invoice_create_params.rb

@@ -26,6 +26,14 @@ module Orb
       #   @return [Array<Orb::Models::InvoiceCreateParams::LineItem>]
       required :line_items, -> { Orb::Internal::Type::ArrayOf[Orb::InvoiceCreateParams::LineItem] }
 
+      # @!attribute auto_collection
+      #   Determines whether this invoice will automatically attempt to charge a saved
+      #   payment method, if any. If not specified, the invoice inherits the customer's
+      #   auto_collection setting.
+      #
+      #   @return [Boolean, nil]
+      optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
+
       # @!attribute customer_id
       #   The id of the `Customer` to create this invoice for. One of `customer_id` and
       #   `external_customer_id` are required.
@@ -86,7 +94,7 @@ module Orb
       #   @return [Boolean, nil]
       optional :will_auto_issue, Orb::Internal::Type::Boolean
 
-      # @!method initialize(currency:, invoice_date:, line_items:, customer_id: nil, discount: nil, due_date: nil, external_customer_id: nil, memo: nil, metadata: nil, net_terms: nil, will_auto_issue: nil, request_options: {})
+      # @!method initialize(currency:, invoice_date:, line_items:, auto_collection: nil, customer_id: nil, discount: nil, due_date: nil, external_customer_id: nil, memo: nil, metadata: nil, net_terms: nil, will_auto_issue: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::InvoiceCreateParams} for more details.
       #
@@ -96,6 +104,8 @@ module Orb
       #
       #   @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
       #
+      #   @param auto_collection [Boolean, nil] Determines whether this invoice will automatically attempt to charge a saved pay
+      #
       #   @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
       #
       #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice.

data/lib/orb/models/invoice_update_params.rb

@@ -7,6 +7,14 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute auto_collection
+      #   Determines whether this invoice will automatically attempt to charge a saved
+      #   payment method, if any. Can only be modified on draft invoices. If not
+      #   specified, the invoice's existing setting is unchanged.
+      #
+      #   @return [Boolean, nil]
+      optional :auto_collection, Orb::Internal::Type::Boolean, nil?: true
+
       # @!attribute due_date
       #   An optional custom due date for the invoice. If not set, the due date will be
       #   calculated based on the `net_terms` value.
@@ -38,10 +46,12 @@ module Orb
       #   @return [Integer, nil]
       optional :net_terms, Integer, nil?: true
 
-      # @!method initialize(due_date: nil, invoice_date: nil, metadata: nil, net_terms: nil, request_options: {})
+      # @!method initialize(auto_collection: nil, due_date: nil, invoice_date: nil, metadata: nil, net_terms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::InvoiceUpdateParams} for more details.
       #
+      #   @param auto_collection [Boolean, nil] Determines whether this invoice will automatically attempt to charge a saved pay
+      #
       #   @param due_date [Date, Time, nil] An optional custom due date for the invoice. If not set, the due date will be ca
       #
       #   @param invoice_date [Date, Time, nil] The date of the invoice. Can only be modified for one-off draft invoices.

data/lib/orb/models/item.rb

@@ -99,6 +99,7 @@ module Orb
           AVALARA = :avalara
           ANROK = :anrok
           NUMERAL = :numeral
+          STRIPE_TAX = :stripe_tax
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/orb/models/item_update_params.rb

@@ -75,6 +75,7 @@ module Orb
           AVALARA = :avalara
           ANROK = :anrok
           NUMERAL = :numeral
+          STRIPE_TAX = :stripe_tax
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rb

@@ -215,6 +215,12 @@ module Orb
         #   @return [String]
         required :unit_price, String
 
+        # @!attribute grouping_key
+        #   The property used to group this price
+        #
+        #   @return [String, nil]
+        optional :grouping_key, String, nil?: true
+
         # @!attribute prorate
         #   If true, the unit price will be prorated to the billing period
         #
@@ -227,7 +233,7 @@ module Orb
         #   @return [String, nil]
         optional :second_dimension, String, nil?: true
 
-        # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, prorate: nil, second_dimension: nil)
+        # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, grouping_key: nil, prorate: nil, second_dimension: nil)
         #   Configuration for scalable_matrix_with_unit_pricing pricing
         #
         #   @param first_dimension [String] Used to determine the unit rate
@@ -236,6 +242,8 @@ module Orb
         #
         #   @param unit_price [String] The final unit price to rate against the output of the matrix
         #
+        #   @param grouping_key [String, nil] The property used to group this price
+        #
         #   @param prorate [Boolean, nil] If true, the unit price will be prorated to the billing period
         #
         #   @param second_dimension [String, nil] Used to determine the unit rate (optional)

data/lib/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rb

@@ -221,6 +221,12 @@ module Orb
         #   @return [String]
         required :unit_price, String
 
+        # @!attribute grouping_key
+        #   The property used to group this price
+        #
+        #   @return [String, nil]
+        optional :grouping_key, String, nil?: true
+
         # @!attribute prorate
         #   If true, the unit price will be prorated to the billing period
         #
@@ -233,7 +239,7 @@ module Orb
         #   @return [String, nil]
         optional :second_dimension, String, nil?: true
 
-        # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, prorate: nil, second_dimension: nil)
+        # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, grouping_key: nil, prorate: nil, second_dimension: nil)
         #   Configuration for scalable_matrix_with_unit_pricing pricing
         #
         #   @param first_dimension [String] Used to determine the unit rate
@@ -242,6 +248,8 @@ module Orb
         #
         #   @param unit_price [String] The final unit price to rate against the output of the matrix
         #
+        #   @param grouping_key [String, nil] The property used to group this price
+        #
         #   @param prorate [Boolean, nil] If true, the unit price will be prorated to the billing period
         #
         #   @param second_dimension [String, nil] Used to determine the unit rate (optional)

data/lib/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rb

@@ -226,6 +226,12 @@ module Orb
         #   @return [String]
         required :unit_price, String
 
+        # @!attribute grouping_key
+        #   The property used to group this price
+        #
+        #   @return [String, nil]
+        optional :grouping_key, String, nil?: true
+
         # @!attribute prorate
         #   If true, the unit price will be prorated to the billing period
         #
@@ -238,7 +244,7 @@ module Orb
         #   @return [String, nil]
         optional :second_dimension, String, nil?: true
 
-        # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, prorate: nil, second_dimension: nil)
+        # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, grouping_key: nil, prorate: nil, second_dimension: nil)
         #   Configuration for scalable_matrix_with_unit_pricing pricing
         #
         #   @param first_dimension [String] Used to determine the unit rate
@@ -247,6 +253,8 @@ module Orb
         #
         #   @param unit_price [String] The final unit price to rate against the output of the matrix
         #
+        #   @param grouping_key [String, nil] The property used to group this price
+        #
         #   @param prorate [Boolean, nil] If true, the unit price will be prorated to the billing period
         #
         #   @param second_dimension [String, nil] Used to determine the unit rate (optional)

data/lib/orb/models/price.rb

@@ -9916,6 +9916,12 @@ module Orb
           #   @return [String]
           required :unit_price, String
 
+          # @!attribute grouping_key
+          #   The property used to group this price
+          #
+          #   @return [String, nil]
+          optional :grouping_key, String, nil?: true
+
           # @!attribute prorate
           #   If true, the unit price will be prorated to the billing period
           #
@@ -9928,7 +9934,7 @@ module Orb
           #   @return [String, nil]
           optional :second_dimension, String, nil?: true
 
-          # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, prorate: nil, second_dimension: nil)
+          # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, grouping_key: nil, prorate: nil, second_dimension: nil)
           #   Configuration for scalable_matrix_with_unit_pricing pricing
           #
           #   @param first_dimension [String] Used to determine the unit rate
@@ -9937,6 +9943,8 @@ module Orb
           #
           #   @param unit_price [String] The final unit price to rate against the output of the matrix
           #
+          #   @param grouping_key [String, nil] The property used to group this price
+          #
           #   @param prorate [Boolean, nil] If true, the unit price will be prorated to the billing period
           #
           #   @param second_dimension [String, nil] Used to determine the unit rate (optional)

data/lib/orb/models/price_create_params.rb

@@ -1250,6 +1250,12 @@ module Orb
         #   @return [String]
         required :unit_price, String
 
+        # @!attribute grouping_key
+        #   The property used to group this price
+        #
+        #   @return [String, nil]
+        optional :grouping_key, String, nil?: true
+
         # @!attribute prorate
         #   If true, the unit price will be prorated to the billing period
         #
@@ -1262,7 +1268,7 @@ module Orb
         #   @return [String, nil]
         optional :second_dimension, String, nil?: true
 
-        # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, prorate: nil, second_dimension: nil)
+        # @!method initialize(first_dimension:, matrix_scaling_factors:, unit_price:, grouping_key: nil, prorate: nil, second_dimension: nil)
         #   Configuration for scalable_matrix_with_unit_pricing pricing
         #
         #   @param first_dimension [String] Used to determine the unit rate
@@ -1271,6 +1277,8 @@ module Orb
         #
         #   @param unit_price [String] The final unit price to rate against the output of the matrix
         #
+        #   @param grouping_key [String, nil] The property used to group this price
+        #
         #   @param prorate [Boolean, nil] If true, the unit price will be prorated to the billing period
         #
         #   @param second_dimension [String, nil] Used to determine the unit rate (optional)

data/lib/orb/models/price_evaluate_multiple_params.rb

@@ -74,6 +74,15 @@ module Orb
         #   @return [Array<String>, nil]
         optional :grouping_keys, Orb::Internal::Type::ArrayOf[String]
 
+        # @!attribute metric_parameter_overrides
+        #   Optional overrides for parameterized billable metric parameters. If the metric
+        #   has parameter definitions and no overrides are provided, defaults will be used.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute price
         #   New floating price request body params.
         #
@@ -86,7 +95,7 @@ module Orb
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, price: nil, price_id: nil)
+        # @!method initialize(external_price_id: nil, filter: nil, grouping_keys: nil, metric_parameter_overrides: nil, price: nil, price_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation} for more details.
         #
@@ -96,6 +105,8 @@ module Orb
         #
         #   @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
+        #
         #   @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::BulkWithFilters, Orb::Models::NewFloatingPackagePrice, Orb::Models::NewFloatingMatrixPrice, Orb::Models::NewFloatingThresholdTotalAmountPrice, Orb::Models::NewFloatingTieredPackagePrice, Orb::Models::NewFloatingTieredWithMinimumPrice, Orb::Models::NewFloatingGroupedTieredPrice, Orb::Models::NewFloatingTieredPackageWithMinimumPrice, Orb::Models::NewFloatingPackageWithAllocationPrice, Orb::Models::NewFloatingUnitWithPercentPrice, Orb::Models::NewFloatingMatrixWithAllocationPrice, Orb::Models::NewFloatingTieredWithProrationPrice, Orb::Models::NewFloatingUnitWithProrationPrice, Orb::Models::NewFloatingGroupedAllocationPrice, Orb::Models::NewFloatingBulkWithProrationPrice, Orb::Models::NewFloatingGroupedWithProratedMinimumPrice, Orb::Models::NewFloatingGroupedWithMeteredMinimumPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation::Price::EventOutput, nil] New floating price request body params.
         #
         #   @param price_id [String, nil] The ID of a price to evaluate that exists in your Orb account.

data/lib/orb/models/price_evaluate_params.rb

@@ -47,7 +47,16 @@ module Orb
       #   @return [Array<String>, nil]
       optional :grouping_keys, Orb::Internal::Type::ArrayOf[String]
 
-      # @!method initialize(timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {})
+      # @!attribute metric_parameter_overrides
+      #   Optional overrides for parameterized billable metric parameters. If the metric
+      #   has parameter definitions and no overrides are provided, defaults will be used.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metric_parameter_overrides,
+               Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+               nil?: true
+
+      # @!method initialize(timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, metric_parameter_overrides: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PriceEvaluateParams} for more details.
       #
@@ -63,6 +72,8 @@ module Orb
       #
       #   @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
       #
+      #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end