orb-billing 1.12.0 → 1.13.0

data/lib/orb/resources/subscriptions.rb

@@ -432,10 +432,11 @@ module Orb
       # @see Orb::Models::SubscriptionListParams
       def list(params = {})
         parsed, options = Orb::SubscriptionListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "subscriptions",
-          query: parsed.transform_keys(
+          query: query.transform_keys(
             created_at_gt: "created_at[gt]",
             created_at_gte: "created_at[gte]",
             created_at_lt: "created_at[lt]",
@@ -591,10 +592,11 @@ module Orb
       # @see Orb::Models::SubscriptionFetchCostsParams
       def fetch_costs(subscription_id, params = {})
         parsed, options = Orb::SubscriptionFetchCostsParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["subscriptions/%1$s/costs", subscription_id],
-          query: parsed,
+          query: query,
           model: Orb::Models::SubscriptionFetchCostsResponse,
           options: options
         )
@@ -631,10 +633,11 @@ module Orb
       # @see Orb::Models::SubscriptionFetchScheduleParams
       def fetch_schedule(subscription_id, params = {})
         parsed, options = Orb::SubscriptionFetchScheduleParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["subscriptions/%1$s/schedule", subscription_id],
-          query: parsed.transform_keys(
+          query: query.transform_keys(
             start_date_gt: "start_date[gt]",
             start_date_gte: "start_date[gte]",
             start_date_lt: "start_date[lt]",
@@ -875,10 +878,11 @@ module Orb
       # @see Orb::Models::SubscriptionFetchUsageParams
       def fetch_usage(subscription_id, params = {})
         parsed, options = Orb::SubscriptionFetchUsageParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["subscriptions/%1$s/usage", subscription_id],
-          query: parsed,
+          query: query,
           model: Orb::SubscriptionUsage,
           options: options
         )

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.12.0"
+  VERSION = "1.13.0"
 end

data/rbi/orb/client.rbi

@@ -16,42 +16,109 @@ module Orb
     sig { returns(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).
     sig { returns(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.
     sig { returns(Orb::Resources::Coupons) }
     attr_reader :coupons
 
+    # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+    # been applied to a particular invoice.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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.
     sig { returns(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).
     sig { returns(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)
     sig { returns(Orb::Resources::Prices) }
     attr_reader :prices
 
     sig { returns(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.
     sig { returns(Orb::Resources::Alerts) }
     attr_reader :alerts
 
@@ -61,9 +128,14 @@ module Orb
     sig { returns(Orb::Resources::SubscriptionChanges) }
     attr_reader :subscription_changes
 
+    # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+    # credits within Orb.
     sig { returns(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.
     sig { returns(Orb::Resources::LicenseTypes) }
     attr_reader :license_types
 

data/rbi/orb/internal/util.rbi

@@ -295,6 +295,24 @@ module Orb
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Orb::Internal::AnyHash).returns(Orb::Internal::AnyHash)
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Orb::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(

data/rbi/orb/models/billable_metric.rbi

@@ -34,6 +34,9 @@ module Orb
       sig { returns(Orb::BillableMetric::Status::TaggedSymbol) }
       attr_accessor :status
 
+      sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+      attr_accessor :parameter_definitions
+
       # 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.
@@ -44,7 +47,9 @@ module Orb
           item: Orb::Item::OrHash,
           metadata: T::Hash[Symbol, String],
           name: String,
-          status: Orb::BillableMetric::Status::OrSymbol
+          status: Orb::BillableMetric::Status::OrSymbol,
+          parameter_definitions:
+            T.nilable(T::Array[T::Hash[Symbol, T.anything]])
         ).returns(T.attached_class)
       end
       def self.new(
@@ -60,7 +65,8 @@ module Orb
         # `null`.
         metadata:,
         name:,
-        status:
+        status:,
+        parameter_definitions: nil
       )
       end
 
@@ -72,7 +78,9 @@ module Orb
             item: Orb::Item,
             metadata: T::Hash[Symbol, String],
             name: String,
-            status: Orb::BillableMetric::Status::TaggedSymbol
+            status: Orb::BillableMetric::Status::TaggedSymbol,
+            parameter_definitions:
+              T.nilable(T::Array[T::Hash[Symbol, T.anything]])
           }
         )
       end

data/rbi/orb/models/customers/credits/ledger_create_entry_by_external_id_params.rbi

@@ -424,6 +424,13 @@ module Orb
             sig { returns(T.nilable(String)) }
             attr_accessor :item_id
 
+            # If true, the new credits purchase invoice will be marked as paid.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :mark_as_paid
+
+            sig { params(mark_as_paid: T::Boolean).void }
+            attr_writer :mark_as_paid
+
             # An optional memo to display on the invoice.
             sig { returns(T.nilable(String)) }
             attr_accessor :memo
@@ -432,7 +439,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.
             sig { returns(T.nilable(Integer)) }
             attr_accessor :net_terms
 
@@ -460,6 +468,7 @@ module Orb
                     Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::InvoiceDate::Variants
                   ),
                 item_id: T.nilable(String),
+                mark_as_paid: T::Boolean,
                 memo: T.nilable(String),
                 net_terms: T.nilable(Integer),
                 require_successful_payment: T::Boolean
@@ -479,13 +488,16 @@ module Orb
               # The ID of the Item to be used for the invoice line item. If not provided, a
               # default 'Credits' item will be used.
               item_id: nil,
+              # If true, the new credits purchase invoice will be marked as paid.
+              mark_as_paid: nil,
               # An optional memo to display on the invoice.
               memo: nil,
               # The net terms determines the due date of the invoice. Due date is calculated
               # 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.
               net_terms: nil,
               # If true, the new credit block will require that the corresponding invoice is
               # paid before it can be drawn down from.
@@ -506,6 +518,7 @@ module Orb
                       Orb::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings::InvoiceDate::Variants
                     ),
                   item_id: T.nilable(String),
+                  mark_as_paid: T::Boolean,
                   memo: T.nilable(String),
                   net_terms: T.nilable(Integer),
                   require_successful_payment: T::Boolean

data/rbi/orb/models/customers/credits/ledger_create_entry_params.rbi

@@ -424,6 +424,13 @@ module Orb
             sig { returns(T.nilable(String)) }
             attr_accessor :item_id
 
+            # If true, the new credits purchase invoice will be marked as paid.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :mark_as_paid
+
+            sig { params(mark_as_paid: T::Boolean).void }
+            attr_writer :mark_as_paid
+
             # An optional memo to display on the invoice.
             sig { returns(T.nilable(String)) }
             attr_accessor :memo
@@ -432,7 +439,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.
             sig { returns(T.nilable(Integer)) }
             attr_accessor :net_terms
 
@@ -460,6 +468,7 @@ module Orb
                     Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::InvoiceDate::Variants
                   ),
                 item_id: T.nilable(String),
+                mark_as_paid: T::Boolean,
                 memo: T.nilable(String),
                 net_terms: T.nilable(Integer),
                 require_successful_payment: T::Boolean
@@ -479,13 +488,16 @@ module Orb
               # The ID of the Item to be used for the invoice line item. If not provided, a
               # default 'Credits' item will be used.
               item_id: nil,
+              # If true, the new credits purchase invoice will be marked as paid.
+              mark_as_paid: nil,
               # An optional memo to display on the invoice.
               memo: nil,
               # The net terms determines the due date of the invoice. Due date is calculated
               # 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.
               net_terms: nil,
               # If true, the new credit block will require that the corresponding invoice is
               # paid before it can be drawn down from.
@@ -506,6 +518,7 @@ module Orb
                       Orb::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings::InvoiceDate::Variants
                     ),
                   item_id: T.nilable(String),
+                  mark_as_paid: T::Boolean,
                   memo: T.nilable(String),
                   net_terms: T.nilable(Integer),
                   require_successful_payment: T::Boolean

data/rbi/orb/models/invoice_create_params.rbi

@@ -22,6 +22,12 @@ module Orb
       sig { returns(T::Array[Orb::InvoiceCreateParams::LineItem]) }
       attr_accessor :line_items
 
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :auto_collection
+
       # The id of the `Customer` to create this invoice for. One of `customer_id` and
       # `external_customer_id` are required.
       sig { returns(T.nilable(String)) }
@@ -85,6 +91,7 @@ module Orb
           currency: String,
           invoice_date: Time,
           line_items: T::Array[Orb::InvoiceCreateParams::LineItem::OrHash],
+          auto_collection: T.nilable(T::Boolean),
           customer_id: T.nilable(String),
           discount:
             T.nilable(
@@ -112,6 +119,10 @@ module Orb
         # set to the current time in the customer's timezone.
         invoice_date:,
         line_items:,
+        # 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.
+        auto_collection: nil,
         # The id of the `Customer` to create this invoice for. One of `customer_id` and
         # `external_customer_id` are required.
         customer_id: nil,
@@ -150,6 +161,7 @@ module Orb
             currency: String,
             invoice_date: Time,
             line_items: T::Array[Orb::InvoiceCreateParams::LineItem],
+            auto_collection: T.nilable(T::Boolean),
             customer_id: T.nilable(String),
             discount:
               T.nilable(

data/rbi/orb/models/invoice_update_params.rbi

@@ -9,6 +9,12 @@ module Orb
       OrHash =
         T.type_alias { T.any(Orb::InvoiceUpdateParams, Orb::Internal::AnyHash) }
 
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :auto_collection
+
       # An optional custom due date for the invoice. If not set, the due date will be
       # calculated based on the `net_terms` value.
       sig { returns(T.nilable(Orb::InvoiceUpdateParams::DueDate::Variants)) }
@@ -36,6 +42,7 @@ module Orb
 
       sig do
         params(
+          auto_collection: T.nilable(T::Boolean),
           due_date: T.nilable(Orb::InvoiceUpdateParams::DueDate::Variants),
           invoice_date:
             T.nilable(Orb::InvoiceUpdateParams::InvoiceDate::Variants),
@@ -45,6 +52,10 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
+        # 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.
+        auto_collection: nil,
         # An optional custom due date for the invoice. If not set, the due date will be
         # calculated based on the `net_terms` value.
         due_date: nil,
@@ -67,6 +78,7 @@ module Orb
       sig do
         override.returns(
           {
+            auto_collection: T.nilable(T::Boolean),
             due_date: T.nilable(Orb::InvoiceUpdateParams::DueDate::Variants),
             invoice_date:
               T.nilable(Orb::InvoiceUpdateParams::InvoiceDate::Variants),

data/rbi/orb/models/item.rbi

@@ -181,6 +181,11 @@ module Orb
               :numeral,
               Orb::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol
             )
+          STRIPE_TAX =
+            T.let(
+              :stripe_tax,
+              Orb::Item::ExternalConnection::ExternalConnectionName::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/orb/models/item_update_params.rbi

@@ -162,6 +162,11 @@ module Orb
               :numeral,
               Orb::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol
             )
+          STRIPE_TAX =
+            T.let(
+              :stripe_tax,
+              Orb::ItemUpdateParams::ExternalConnection::ExternalConnectionName::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/orb/models/new_floating_scalable_matrix_with_unit_pricing_price.rbi

@@ -375,6 +375,10 @@ module Orb
         sig { returns(String) }
         attr_accessor :unit_price
 
+        # The property used to group this price
+        sig { returns(T.nilable(String)) }
+        attr_accessor :grouping_key
+
         # If true, the unit price will be prorated to the billing period
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :prorate
@@ -392,6 +396,7 @@ module Orb
                 Orb::NewFloatingScalableMatrixWithUnitPricingPrice::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor::OrHash
               ],
             unit_price: String,
+            grouping_key: T.nilable(String),
             prorate: T.nilable(T::Boolean),
             second_dimension: T.nilable(String)
           ).returns(T.attached_class)
@@ -403,6 +408,8 @@ module Orb
           matrix_scaling_factors:,
           # The final unit price to rate against the output of the matrix
           unit_price:,
+          # The property used to group this price
+          grouping_key: nil,
           # If true, the unit price will be prorated to the billing period
           prorate: nil,
           # Used to determine the unit rate (optional)
@@ -419,6 +426,7 @@ module Orb
                   Orb::NewFloatingScalableMatrixWithUnitPricingPrice::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor
                 ],
               unit_price: String,
+              grouping_key: T.nilable(String),
               prorate: T.nilable(T::Boolean),
               second_dimension: T.nilable(String)
             }

data/rbi/orb/models/new_plan_scalable_matrix_with_unit_pricing_price.rbi

@@ -387,6 +387,10 @@ module Orb
         sig { returns(String) }
         attr_accessor :unit_price
 
+        # The property used to group this price
+        sig { returns(T.nilable(String)) }
+        attr_accessor :grouping_key
+
         # If true, the unit price will be prorated to the billing period
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :prorate
@@ -404,6 +408,7 @@ module Orb
                 Orb::NewPlanScalableMatrixWithUnitPricingPrice::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor::OrHash
               ],
             unit_price: String,
+            grouping_key: T.nilable(String),
             prorate: T.nilable(T::Boolean),
             second_dimension: T.nilable(String)
           ).returns(T.attached_class)
@@ -415,6 +420,8 @@ module Orb
           matrix_scaling_factors:,
           # The final unit price to rate against the output of the matrix
           unit_price:,
+          # The property used to group this price
+          grouping_key: nil,
           # If true, the unit price will be prorated to the billing period
           prorate: nil,
           # Used to determine the unit rate (optional)
@@ -431,6 +438,7 @@ module Orb
                   Orb::NewPlanScalableMatrixWithUnitPricingPrice::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor
                 ],
               unit_price: String,
+              grouping_key: T.nilable(String),
               prorate: T.nilable(T::Boolean),
               second_dimension: T.nilable(String)
             }

data/rbi/orb/models/new_subscription_scalable_matrix_with_unit_pricing_price.rbi

@@ -387,6 +387,10 @@ module Orb
         sig { returns(String) }
         attr_accessor :unit_price
 
+        # The property used to group this price
+        sig { returns(T.nilable(String)) }
+        attr_accessor :grouping_key
+
         # If true, the unit price will be prorated to the billing period
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :prorate
@@ -404,6 +408,7 @@ module Orb
                 Orb::NewSubscriptionScalableMatrixWithUnitPricingPrice::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor::OrHash
               ],
             unit_price: String,
+            grouping_key: T.nilable(String),
             prorate: T.nilable(T::Boolean),
             second_dimension: T.nilable(String)
           ).returns(T.attached_class)
@@ -415,6 +420,8 @@ module Orb
           matrix_scaling_factors:,
           # The final unit price to rate against the output of the matrix
           unit_price:,
+          # The property used to group this price
+          grouping_key: nil,
           # If true, the unit price will be prorated to the billing period
           prorate: nil,
           # Used to determine the unit rate (optional)
@@ -431,6 +438,7 @@ module Orb
                   Orb::NewSubscriptionScalableMatrixWithUnitPricingPrice::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor
                 ],
               unit_price: String,
+              grouping_key: T.nilable(String),
               prorate: T.nilable(T::Boolean),
               second_dimension: T.nilable(String)
             }

data/rbi/orb/models/price.rbi

@@ -17378,6 +17378,10 @@ module Orb
           sig { returns(String) }
           attr_accessor :unit_price
 
+          # The property used to group this price
+          sig { returns(T.nilable(String)) }
+          attr_accessor :grouping_key
+
           # If true, the unit price will be prorated to the billing period
           sig { returns(T.nilable(T::Boolean)) }
           attr_accessor :prorate
@@ -17395,6 +17399,7 @@ module Orb
                   Orb::Price::ScalableMatrixWithUnitPricing::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor::OrHash
                 ],
               unit_price: String,
+              grouping_key: T.nilable(String),
               prorate: T.nilable(T::Boolean),
               second_dimension: T.nilable(String)
             ).returns(T.attached_class)
@@ -17406,6 +17411,8 @@ module Orb
             matrix_scaling_factors:,
             # The final unit price to rate against the output of the matrix
             unit_price:,
+            # The property used to group this price
+            grouping_key: nil,
             # If true, the unit price will be prorated to the billing period
             prorate: nil,
             # Used to determine the unit rate (optional)
@@ -17422,6 +17429,7 @@ module Orb
                     Orb::Price::ScalableMatrixWithUnitPricing::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor
                   ],
                 unit_price: String,
+                grouping_key: T.nilable(String),
                 prorate: T.nilable(T::Boolean),
                 second_dimension: T.nilable(String)
               }

data/rbi/orb/models/price_create_params.rbi

@@ -2343,6 +2343,10 @@ module Orb
         sig { returns(String) }
         attr_accessor :unit_price
 
+        # The property used to group this price
+        sig { returns(T.nilable(String)) }
+        attr_accessor :grouping_key
+
         # If true, the unit price will be prorated to the billing period
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :prorate
@@ -2360,6 +2364,7 @@ module Orb
                 Orb::PriceCreateParams::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor::OrHash
               ],
             unit_price: String,
+            grouping_key: T.nilable(String),
             prorate: T.nilable(T::Boolean),
             second_dimension: T.nilable(String)
           ).returns(T.attached_class)
@@ -2371,6 +2376,8 @@ module Orb
           matrix_scaling_factors:,
           # The final unit price to rate against the output of the matrix
           unit_price:,
+          # The property used to group this price
+          grouping_key: nil,
           # If true, the unit price will be prorated to the billing period
           prorate: nil,
           # Used to determine the unit rate (optional)
@@ -2387,6 +2394,7 @@ module Orb
                   Orb::PriceCreateParams::ScalableMatrixWithUnitPricingConfig::MatrixScalingFactor
                 ],
               unit_price: String,
+              grouping_key: T.nilable(String),
               prorate: T.nilable(T::Boolean),
               second_dimension: T.nilable(String)
             }