orb-billing 0.5.5 → 0.7.0

data/lib/orb/models/trial_discount.rb

@@ -3,18 +3,18 @@
 module Orb
   module Models
     class TrialDiscount < Orb::Internal::Type::BaseModel
-      # @!attribute applies_to_price_ids
-      #   List of price_ids that this discount applies to. For plan/plan phase discounts,
-      #   this can be a subset of prices.
-      #
-      #   @return [Array<String>]
-      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
-
       # @!attribute discount_type
       #
       #   @return [Symbol, Orb::Models::TrialDiscount::DiscountType]
       required :discount_type, enum: -> { Orb::TrialDiscount::DiscountType }
 
+      # @!attribute applies_to_price_ids
+      #   List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #   this can be a subset of prices.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute reason
       #
       #   @return [String, nil]
@@ -32,14 +32,14 @@ module Orb
       #   @return [Float, nil]
       optional :trial_percentage_discount, Float, nil?: true
 
-      # @!method initialize(applies_to_price_ids:, discount_type:, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
+      # @!method initialize(discount_type:, applies_to_price_ids: nil, reason: nil, trial_amount_discount: nil, trial_percentage_discount: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::TrialDiscount} for more details.
       #
-      #   @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
-      #
       #   @param discount_type [Symbol, Orb::Models::TrialDiscount::DiscountType]
       #
+      #   @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #
       #   @param reason [String, nil]
       #
       #   @param trial_amount_discount [String, nil] Only available if discount_type is `trial`

data/lib/orb/models/usage_discount.rb

@@ -3,13 +3,6 @@
 module Orb
   module Models
     class UsageDiscount < Orb::Internal::Type::BaseModel
-      # @!attribute applies_to_price_ids
-      #   List of price_ids that this discount applies to. For plan/plan phase discounts,
-      #   this can be a subset of prices.
-      #
-      #   @return [Array<String>]
-      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
-
       # @!attribute discount_type
       #
       #   @return [Symbol, Orb::Models::UsageDiscount::DiscountType]
@@ -22,21 +15,28 @@ module Orb
       #   @return [Float]
       required :usage_discount, Float
 
+      # @!attribute applies_to_price_ids
+      #   List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #   this can be a subset of prices.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute reason
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(applies_to_price_ids:, discount_type:, usage_discount:, reason: nil)
+      # @!method initialize(discount_type:, usage_discount:, applies_to_price_ids: nil, reason: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::UsageDiscount} for more details.
       #
-      #   @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
-      #
       #   @param discount_type [Symbol, Orb::Models::UsageDiscount::DiscountType]
       #
       #   @param usage_discount [Float] Only available if discount_type is `usage`. Number of usage units that this disc
       #
+      #   @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #
       #   @param reason [String, nil]
 
       # @see Orb::Models::UsageDiscount#discount_type

data/lib/orb/models.rb

@@ -59,6 +59,14 @@ module Orb
 
   AmountDiscount = Orb::Models::AmountDiscount
 
+  Beta = Orb::Models::Beta
+
+  BetaCreatePlanVersionParams = Orb::Models::BetaCreatePlanVersionParams
+
+  BetaFetchPlanVersionParams = Orb::Models::BetaFetchPlanVersionParams
+
+  BetaSetDefaultPlanVersionParams = Orb::Models::BetaSetDefaultPlanVersionParams
+
   BillableMetric = Orb::Models::BillableMetric
 
   BillingCycleRelativeDate = Orb::Models::BillingCycleRelativeDate
@@ -158,6 +166,8 @@ module Orb
 
   Item = Orb::Models::Item
 
+  ItemArchiveParams = Orb::Models::ItemArchiveParams
+
   ItemCreateParams = Orb::Models::ItemCreateParams
 
   ItemFetchParams = Orb::Models::ItemFetchParams
@@ -190,10 +200,16 @@ module Orb
 
   PlanUpdateParams = Orb::Models::PlanUpdateParams
 
+  PlanVersion = Orb::Models::PlanVersion
+
+  PlanVersionPhase = Orb::Models::PlanVersionPhase
+
   Price = Orb::Models::Price
 
   PriceCreateParams = Orb::Models::PriceCreateParams
 
+  PriceEvaluateMultipleParams = Orb::Models::PriceEvaluateMultipleParams
+
   PriceEvaluateParams = Orb::Models::PriceEvaluateParams
 
   PriceFetchParams = Orb::Models::PriceFetchParams

data/lib/orb/resources/beta/external_plan_id.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Beta
+      class ExternalPlanID
+        # This API endpoint is in beta and its interface may change. It is recommended for
+        # use only in test mode.
+        #
+        # This endpoint allows the creation of a new plan version for an existing plan.
+        #
+        # @overload create_plan_version(external_plan_id, version:, add_adjustments: nil, add_prices: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, set_as_default: nil, request_options: {})
+        #
+        # @param external_plan_id [String]
+        #
+        # @param version [Integer] New version number.
+        #
+        # @param add_adjustments [Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddAdjustment>, nil] Additional adjustments to be added to the plan.
+        #
+        # @param add_prices [Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice>, nil] Additional prices to be added to the plan.
+        #
+        # @param remove_adjustments [Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::RemoveAdjustment>, nil] Adjustments to be removed from the plan.
+        #
+        # @param remove_prices [Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::RemovePrice>, nil] Prices to be removed from the plan.
+        #
+        # @param replace_adjustments [Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplaceAdjustment>, nil] Adjustments to be replaced with additional adjustments on the plan.
+        #
+        # @param replace_prices [Array<Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::ReplacePrice>, nil] Prices to be replaced with additional prices on the plan.
+        #
+        # @param set_as_default [Boolean, nil] Set this new plan version as the default
+        #
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::PlanVersion]
+        #
+        # @see Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams
+        def create_plan_version(external_plan_id, params)
+          parsed, options = Orb::Beta::ExternalPlanIDCreatePlanVersionParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["plans/external_plan_id/%1$s/versions", external_plan_id],
+            body: parsed,
+            model: Orb::PlanVersion,
+            options: options
+          )
+        end
+
+        # This API endpoint is in beta and its interface may change. It is recommended for
+        # use only in test mode.
+        #
+        # This endpoint is used to fetch a plan version. It returns the phases, prices,
+        # and adjustments present on this version of the plan.
+        #
+        # @overload fetch_plan_version(version, external_plan_id:, request_options: {})
+        #
+        # @param version [String]
+        # @param external_plan_id [String]
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::PlanVersion]
+        #
+        # @see Orb::Models::Beta::ExternalPlanIDFetchPlanVersionParams
+        def fetch_plan_version(version, params)
+          parsed, options = Orb::Beta::ExternalPlanIDFetchPlanVersionParams.dump_request(params)
+          external_plan_id =
+            parsed.delete(:external_plan_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["plans/external_plan_id/%1$s/versions/%2$s", external_plan_id, version],
+            model: Orb::PlanVersion,
+            options: options
+          )
+        end
+
+        # This API endpoint is in beta and its interface may change. It is recommended for
+        # use only in test mode.
+        #
+        # This endpoint allows setting the default version of a plan.
+        #
+        # @overload set_default_plan_version(external_plan_id, version:, request_options: {})
+        #
+        # @param external_plan_id [String]
+        #
+        # @param version [Integer] Plan version to set as the default.
+        #
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::Plan]
+        #
+        # @see Orb::Models::Beta::ExternalPlanIDSetDefaultPlanVersionParams
+        def set_default_plan_version(external_plan_id, params)
+          parsed, options = Orb::Beta::ExternalPlanIDSetDefaultPlanVersionParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["plans/external_plan_id/%1$s/set_default_version", external_plan_id],
+            body: parsed,
+            model: Orb::Plan,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Orb::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/orb/resources/beta.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Beta
+      # @return [Orb::Resources::Beta::ExternalPlanID]
+      attr_reader :external_plan_id
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint allows the creation of a new plan version for an existing plan.
+      #
+      # @overload create_plan_version(plan_id, version:, add_adjustments: nil, add_prices: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, set_as_default: nil, request_options: {})
+      #
+      # @param plan_id [String]
+      #
+      # @param version [Integer] New version number.
+      #
+      # @param add_adjustments [Array<Orb::Models::BetaCreatePlanVersionParams::AddAdjustment>, nil] Additional adjustments to be added to the plan.
+      #
+      # @param add_prices [Array<Orb::Models::BetaCreatePlanVersionParams::AddPrice>, nil] Additional prices to be added to the plan.
+      #
+      # @param remove_adjustments [Array<Orb::Models::BetaCreatePlanVersionParams::RemoveAdjustment>, nil] Adjustments to be removed from the plan.
+      #
+      # @param remove_prices [Array<Orb::Models::BetaCreatePlanVersionParams::RemovePrice>, nil] Prices to be removed from the plan.
+      #
+      # @param replace_adjustments [Array<Orb::Models::BetaCreatePlanVersionParams::ReplaceAdjustment>, nil] Adjustments to be replaced with additional adjustments on the plan.
+      #
+      # @param replace_prices [Array<Orb::Models::BetaCreatePlanVersionParams::ReplacePrice>, nil] Prices to be replaced with additional prices on the plan.
+      #
+      # @param set_as_default [Boolean, nil] Set this new plan version as the default
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::PlanVersion]
+      #
+      # @see Orb::Models::BetaCreatePlanVersionParams
+      def create_plan_version(plan_id, params)
+        parsed, options = Orb::BetaCreatePlanVersionParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["plans/%1$s/versions", plan_id],
+          body: parsed,
+          model: Orb::PlanVersion,
+          options: options
+        )
+      end
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint is used to fetch a plan version. It returns the phases, prices,
+      # and adjustments present on this version of the plan.
+      #
+      # @overload fetch_plan_version(version, plan_id:, request_options: {})
+      #
+      # @param version [String]
+      # @param plan_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::PlanVersion]
+      #
+      # @see Orb::Models::BetaFetchPlanVersionParams
+      def fetch_plan_version(version, params)
+        parsed, options = Orb::BetaFetchPlanVersionParams.dump_request(params)
+        plan_id =
+          parsed.delete(:plan_id) do
+            raise ArgumentError.new("missing required path argument #{_1}")
+          end
+        @client.request(
+          method: :get,
+          path: ["plans/%1$s/versions/%2$s", plan_id, version],
+          model: Orb::PlanVersion,
+          options: options
+        )
+      end
+
+      # This API endpoint is in beta and its interface may change. It is recommended for
+      # use only in test mode.
+      #
+      # This endpoint allows setting the default version of a plan.
+      #
+      # @overload set_default_plan_version(plan_id, version:, request_options: {})
+      #
+      # @param plan_id [String]
+      #
+      # @param version [Integer] Plan version to set as the default.
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Plan]
+      #
+      # @see Orb::Models::BetaSetDefaultPlanVersionParams
+      def set_default_plan_version(plan_id, params)
+        parsed, options = Orb::BetaSetDefaultPlanVersionParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["plans/%1$s/set_default_version", plan_id],
+          body: parsed,
+          model: Orb::Plan,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Orb::Client]
+      def initialize(client:)
+        @client = client
+        @external_plan_id = Orb::Resources::Beta::ExternalPlanID.new(client: client)
+      end
+    end
+  end
+end

data/lib/orb/resources/credit_notes.rb

@@ -6,13 +6,13 @@ module Orb
       # This endpoint is used to create a single
       # [`Credit Note`](/invoicing/credit-notes).
       #
-      # @overload create(line_items:, memo: nil, reason: nil, request_options: {})
+      # @overload create(line_items:, reason:, memo: nil, request_options: {})
       #
       # @param line_items [Array<Orb::Models::CreditNoteCreateParams::LineItem>]
       #
-      # @param memo [String, nil] An optional memo to attach to the credit note.
+      # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason] An optional reason for the credit note.
       #
-      # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason, nil] An optional reason for the credit note.
+      # @param memo [String, nil] An optional memo to attach to the credit note.
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/orb/resources/customers/balance_transactions.rb

@@ -58,13 +58,6 @@ module Orb
         # chronological order for a single customer, providing a complete audit trail of
         # all adjustments and invoice applications.
         #
-        # ## Eligibility
-        #
-        # The customer balance can only be applied to invoices or adjusted manually if
-        # invoices are not synced to a separate invoicing provider. If a payment gateway
-        # such as Stripe is used, the balance will be applied to the invoice before
-        # forwarding payment to the gateway.
-        #
         # @overload list(customer_id, cursor: nil, limit: nil, operation_time_gt: nil, operation_time_gte: nil, operation_time_lt: nil, operation_time_lte: nil, request_options: {})
         #
         # @param customer_id [String]

data/lib/orb/resources/customers.rb

@@ -60,7 +60,7 @@ module Orb
       #
       # @param shipping_address [Orb::Models::CustomerCreateParams::ShippingAddress, nil]
       #
-      # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, nil]
+      # @param tax_configuration [Orb::Models::CustomerCreateParams::TaxConfiguration::Avalara, Orb::Models::CustomerCreateParams::TaxConfiguration::Taxjar, Orb::Models::CustomerCreateParams::TaxConfiguration::Sphere, nil]
       #
       # @param tax_id [Orb::Models::CustomerCreateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
       #
@@ -125,7 +125,7 @@ module Orb
       #
       # @param shipping_address [Orb::Models::CustomerUpdateParams::ShippingAddress, nil]
       #
-      # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, nil]
+      # @param tax_configuration [Orb::Models::CustomerUpdateParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateParams::TaxConfiguration::Taxjar, Orb::Models::CustomerUpdateParams::TaxConfiguration::Sphere, nil]
       #
       # @param tax_id [Orb::Models::CustomerUpdateParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
       #
@@ -202,10 +202,7 @@ module Orb
       # **Note**: This operation happens asynchronously and can be expected to take a
       # few minutes to propagate to related resources. However, querying for the
       # customer on subsequent GET requests while deletion is in process will reflect
-      # its deletion with a `deleted: true` property. Once the customer deletion has
-      # been fully processed, the customer will not be returned in the API.
-      #
-      # On successful processing, this returns an empty dictionary (`{}`) in the API.
+      # its deletion.
       #
       # @overload delete(customer_id, request_options: {})
       #
@@ -364,7 +361,7 @@ module Orb
       #
       # @param shipping_address [Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress, nil]
       #
-      # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, nil]
+      # @param tax_configuration [Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Avalara, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Taxjar, Orb::Models::CustomerUpdateByExternalIDParams::TaxConfiguration::Sphere, nil]
       #
       # @param tax_id [Orb::Models::CustomerUpdateByExternalIDParams::TaxID, nil] Tax IDs are commonly required to be displayed on customer invoices, which are ad
       #

data/lib/orb/resources/dimensional_price_groups.rb

@@ -16,7 +16,7 @@ module Orb
       # For example, suppose we have a billable metric that measures the number of
       # widgets used and we want to charge differently depending on the color of the
       # widget. We can create a price group with a dimension "color" and two prices: one
-      # that charges $10 per red widget and one that charges $20 per blue widget.
+      # that charges \$10 per red widget and one that charges \$20 per blue widget.
       #
       # @overload create(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
       #

data/lib/orb/resources/items.rb

@@ -3,12 +3,17 @@
 module Orb
   module Resources
     class Items
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::ItemCreateParams} for more details.
+      #
       # This endpoint is used to create an [Item](/core-concepts#item).
       #
-      # @overload create(name:, request_options: {})
+      # @overload create(name:, metadata: nil, request_options: {})
       #
       # @param name [String] The name of the item.
       #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Item]
@@ -19,13 +24,21 @@ module Orb
         @client.request(method: :post, path: "items", body: parsed, model: Orb::Item, options: options)
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Orb::Models::ItemUpdateParams} for more details.
+      #
       # This endpoint can be used to update properties on the Item.
       #
-      # @overload update(item_id, external_connections: nil, name: nil, request_options: {})
+      # @overload update(item_id, external_connections: nil, metadata: nil, name: nil, request_options: {})
       #
       # @param item_id [String]
+      #
       # @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
       # @param name [String, nil]
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::Item]
@@ -71,6 +84,25 @@ module Orb
         )
       end
 
+      # Archive item
+      #
+      # @overload archive(item_id, request_options: {})
+      #
+      # @param item_id [String]
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::Item]
+      #
+      # @see Orb::Models::ItemArchiveParams
+      def archive(item_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["items/%1$s/archive", item_id],
+          model: Orb::Item,
+          options: params[:request_options]
+        )
+      end
+
       # This endpoint returns an item identified by its item_id.
       #
       # @overload fetch(item_id, request_options: {})

data/lib/orb/resources/plans/external_plan_id.rb

@@ -10,7 +10,7 @@ module Orb
         # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
         # existing plan.
         #
-        # Other fields on a customer are currently immutable.
+        # Other fields on a plan are currently immutable.
         #
         # @overload update(other_external_plan_id, external_plan_id: nil, metadata: nil, request_options: {})
         #

data/lib/orb/resources/plans.rb

@@ -17,7 +17,7 @@ module Orb
       #
       # @param name [String]
       #
-      # @param prices [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      # @param prices [Array<Orb::Models::PlanCreateParams::Price::Unit, Orb::Models::PlanCreateParams::Price::Package, Orb::Models::PlanCreateParams::Price::Matrix, Orb::Models::PlanCreateParams::Price::Tiered, Orb::Models::PlanCreateParams::Price::TieredBps, Orb::Models::PlanCreateParams::Price::Bps, Orb::Models::PlanCreateParams::Price::BulkBps, Orb::Models::PlanCreateParams::Price::Bulk, Orb::Models::PlanCreateParams::Price::ThresholdTotalAmount, Orb::Models::PlanCreateParams::Price::TieredPackage, Orb::Models::PlanCreateParams::Price::TieredWithMinimum, Orb::Models::PlanCreateParams::Price::UnitWithPercent, Orb::Models::PlanCreateParams::Price::PackageWithAllocation, Orb::Models::PlanCreateParams::Price::TieredWithProration, Orb::Models::PlanCreateParams::Price::UnitWithProration, Orb::Models::PlanCreateParams::Price::GroupedAllocation, Orb::Models::PlanCreateParams::Price::GroupedWithProratedMinimum, Orb::Models::PlanCreateParams::Price::GroupedWithMeteredMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithDisplayName, Orb::Models::PlanCreateParams::Price::BulkWithProration, Orb::Models::PlanCreateParams::Price::GroupedTieredPackage, Orb::Models::PlanCreateParams::Price::MaxGroupTieredPackage, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithUnitPricing, Orb::Models::PlanCreateParams::Price::ScalableMatrixWithTieredPricing, Orb::Models::PlanCreateParams::Price::CumulativeGroupedBulk, Orb::Models::PlanCreateParams::Price::TieredPackageWithMinimum, Orb::Models::PlanCreateParams::Price::MatrixWithAllocation, Orb::Models::PlanCreateParams::Price::GroupedTiered>] Prices for this plan. If the plan has phases, this includes prices across all ph
       #
       # @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
       #
@@ -45,7 +45,7 @@ module Orb
       # This endpoint can be used to update the `external_plan_id`, and `metadata` of an
       # existing plan.
       #
-      # Other fields on a customer are currently immutable.
+      # Other fields on a plan are currently immutable.
       #
       # @overload update(plan_id, external_plan_id: nil, metadata: nil, request_options: {})
       #

data/lib/orb/resources/prices.rb

@@ -10,7 +10,7 @@ module Orb
       # {Orb::Models::PriceCreateParams} for more details.
       #
       # This endpoint is used to create a [price](/product-catalog/price-configuration).
-      # A price created using this endpoint is always an add-on, meaning that it’s not
+      # A price created using this endpoint is always an add-on, meaning that it's not
       # associated with a specific plan and can instead be individually added to
       # subscriptions, including subscriptions on different plans.
       #
@@ -20,7 +20,7 @@ module Orb
       # See the [Price resource](/product-catalog/price-configuration) for the
       # specification of different price model configurations possible in this endpoint.
       #
-      # @overload create(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {})
+      # @overload create(cadence:, currency:, item_id:, model_type:, name:, unit_config:, package_config:, matrix_config:, matrix_with_allocation_config:, tiered_config:, tiered_bps_config:, bps_config:, bulk_bps_config:, bulk_config:, threshold_total_amount_config:, tiered_package_config:, grouped_tiered_config:, max_group_tiered_package_config:, tiered_with_minimum_config:, package_with_allocation_config:, tiered_package_with_minimum_config:, unit_with_percent_config:, tiered_with_proration_config:, unit_with_proration_config:, grouped_allocation_config:, grouped_with_prorated_minimum_config:, grouped_with_metered_minimum_config:, matrix_with_display_name_config:, bulk_with_proration_config:, grouped_tiered_package_config:, scalable_matrix_with_unit_pricing_config:, scalable_matrix_with_tiered_pricing_config:, cumulative_grouped_bulk_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {})
       #
       # @param cadence [Symbol, Orb::Models::PriceCreateParams::Cadence] The cadence to bill for this price on.
       #
@@ -96,6 +96,8 @@ module Orb
       #
       # @param conversion_rate [Float, nil] The per unit conversion rate of the price currency to the invoicing currency.
       #
+      # @param dimensional_price_configuration [Orb::Models::PriceCreateParams::DimensionalPriceConfiguration, nil] For dimensional price: specifies a price group and dimension values
+      #
       # @param external_price_id [String, nil] An alias for the price.
       #
       # @param fixed_price_quantity [Float, nil] If the Price represents a fixed cost, this represents the quantity of units appl
@@ -177,6 +179,10 @@ module Orb
       # Some parameter documentations has been truncated, see
       # {Orb::Models::PriceEvaluateParams} for more details.
       #
+      # [NOTE] It is recommended to use the `/v1/prices/evaluate` which offers further
+      # functionality, such as multiple prices, inline price definitions, and querying
+      # over preview events.
+      #
       # This endpoint is used to evaluate the output of a price for a given customer and
       # time range. It enables filtering and grouping the output using
       # [computed properties](/extensibility/advanced-metrics#computed-properties),
@@ -231,6 +237,67 @@ module Orb
         )
       end
 
+      # This endpoint is used to evaluate the output of price(s) for a given customer
+      # and time range over either ingested events or preview events. It enables
+      # filtering and grouping the output using
+      # [computed properties](/extensibility/advanced-metrics#computed-properties),
+      # supporting the following workflows:
+      #
+      # 1. Showing detailed usage and costs to the end customer.
+      # 2. Auditing subtotals on invoice line items.
+      #
+      # Prices may either reference existing prices in your Orb account or be defined
+      # inline in the request body. Up to 100 prices can be evaluated in a single
+      # request.
+      #
+      # Price evaluation by default uses ingested events, but you can also provide a
+      # list of preview events to use instead. Up to 500 preview events can be provided
+      # in a single request. When using ingested events, the start of the time range
+      # must be no more than 100 days ago.
+      #
+      # For these workflows, the expressiveness of computed properties in both the
+      # filters and grouping is critical. For example, if you'd like to show your
+      # customer their usage grouped by hour and another property, you can do so with
+      # the following `grouping_keys`:
+      # `["hour_floor_timestamp_millis(timestamp_millis)", "my_property"]`. If you'd
+      # like to examine a customer's usage for a specific property value, you can do so
+      # with the following `filter`:
+      # `my_property = 'foo' AND my_other_property = 'bar'`.
+      #
+      # The length of the results must be no greater than 1000. Note that this is a POST
+      # endpoint rather than a GET endpoint because it employs a JSON body rather than
+      # query parameters.
+      #
+      # @overload evaluate_multiple(timeframe_end:, timeframe_start:, customer_id: nil, events: nil, external_customer_id: nil, price_evaluations: nil, request_options: {})
+      #
+      # @param timeframe_end [Time] The exclusive upper bound for event timestamps
+      #
+      # @param timeframe_start [Time] The inclusive lower bound for event timestamps
+      #
+      # @param customer_id [String, nil] The ID of the customer to which this evaluation is scoped.
+      #
+      # @param events [Array<Orb::Models::PriceEvaluateMultipleParams::Event>, nil] Optional list of preview events to use instead of actual usage data (max 500)
+      #
+      # @param external_customer_id [String, nil] The external customer ID of the customer to which this evaluation is scoped.
+      #
+      # @param price_evaluations [Array<Orb::Models::PriceEvaluateMultipleParams::PriceEvaluation>] List of prices to evaluate (max 100)
+      #
+      # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Orb::Models::PriceEvaluateMultipleResponse]
+      #
+      # @see Orb::Models::PriceEvaluateMultipleParams
+      def evaluate_multiple(params)
+        parsed, options = Orb::PriceEvaluateMultipleParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "prices/evaluate",
+          body: parsed,
+          model: Orb::Models::PriceEvaluateMultipleResponse,
+          options: options
+        )
+      end
+
       # This endpoint returns a price given an identifier.
       #
       # @overload fetch(price_id, request_options: {})