orb-billing 1.12.0 → 1.13.0

data/lib/orb/models/price_evaluate_preview_events_params.rb

@@ -132,6 +132,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.
         #
@@ -148,7 +157,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::PriceEvaluatePreviewEventsParams::PriceEvaluation} for more
         #   details.
@@ -159,6 +168,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::PriceEvaluatePreviewEventsParams::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::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::PriceEvaluatePreviewEventsParams::PriceEvaluation::Price::Percent, Orb::Models::PriceEvaluatePreviewEventsParams::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_interval.rb

@@ -89,7 +89,16 @@ module Orb
       #   @return [Array<String>, nil]
       required :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
-      # @!method initialize(id:, billing_cycle_day:, can_defer_billing:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:)
+      # @!attribute metric_parameter_overrides
+      #   Override values for parameterized billable metric variables. Keys are parameter
+      #   names, values are the override values.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metric_parameter_overrides,
+               Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+               nil?: true
+
+      # @!method initialize(id:, billing_cycle_day:, can_defer_billing:, current_billing_period_end_date:, current_billing_period_start_date:, end_date:, filter:, fixed_fee_quantity_transitions:, price:, start_date:, usage_customer_ids:, metric_parameter_overrides: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PriceInterval} for more details.
       #
@@ -118,6 +127,8 @@ module Orb
       #   @param start_date [Time] The start date of the price interval. This is the date that Orb starts billing f
       #
       #   @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th
+      #
+      #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
     end
   end
 end

data/lib/orb/models/subscription_create_params.rb

@@ -422,6 +422,15 @@ module Orb
         #   @return [String, nil]
         optional :maximum_amount, String, nil?: true
 
+        # @!attribute metric_parameter_overrides
+        #   Override values for parameterized billable metric variables. Keys are parameter
+        #   names, values are the override values.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute minimum_amount
         #   @deprecated
         #
@@ -457,7 +466,7 @@ module Orb
         #   @return [Time, nil]
         optional :start_date, Time, nil?: true
 
-        # @!method initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil)
+        # @!method initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, metric_parameter_overrides: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionCreateParams::AddPrice} for more details.
         #
@@ -471,6 +480,8 @@ module Orb
         #
         #   @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
+        #
         #   @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         #
         #   @param plan_phase_order [Integer, nil] The phase to add this price to.
@@ -2085,6 +2096,15 @@ module Orb
         #   @return [String, nil]
         optional :maximum_amount, String, nil?: true
 
+        # @!attribute metric_parameter_overrides
+        #   Override values for parameterized billable metric variables. Keys are parameter
+        #   names, values are the override values.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute minimum_amount
         #   @deprecated
         #
@@ -2106,7 +2126,7 @@ module Orb
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(replaces_price_id:, allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil)
+        # @!method initialize(replaces_price_id:, allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, metric_parameter_overrides: nil, minimum_amount: nil, price: nil, price_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionCreateParams::ReplacePrice} for more details.
         #
@@ -2122,6 +2142,8 @@ module Orb
         #
         #   @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
+        #
         #   @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         #
         #   @param price [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionCreateParams::ReplacePrice::Price::EventOutput, nil] New subscription price request body params.

data/lib/orb/models/subscription_price_intervals_params.rb

@@ -137,6 +137,15 @@ module Orb
         #   @return [Float, nil]
         optional :maximum_amount, Float, nil?: true
 
+        # @!attribute metric_parameter_overrides
+        #   Override values for parameterized billable metric variables. Keys are parameter
+        #   names, values are the override values (number or string).
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute minimum_amount
         #   The minimum amount that will be billed for this price interval for a given
         #   billing period.
@@ -167,7 +176,7 @@ module Orb
         #   @return [Array<String>, nil]
         optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
-        # @!method initialize(start_date:, allocation_price: nil, can_defer_billing: nil, discounts: nil, end_date: nil, external_price_id: nil, filter: nil, fixed_fee_quantity_transitions: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil, usage_customer_ids: nil)
+        # @!method initialize(start_date:, allocation_price: nil, can_defer_billing: nil, discounts: nil, end_date: nil, external_price_id: nil, filter: nil, fixed_fee_quantity_transitions: nil, maximum_amount: nil, metric_parameter_overrides: nil, minimum_amount: nil, price: nil, price_id: nil, usage_customer_ids: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionPriceIntervalsParams::Add} for more details.
         #
@@ -189,6 +198,8 @@ module Orb
         #
         #   @param maximum_amount [Float, nil] The maximum amount that will be billed for this price interval for a given billi
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
+        #
         #   @param minimum_amount [Float, nil] The minimum amount that will be billed for this price interval for a given billi
         #
         #   @param price [Orb::Models::NewFloatingUnitPrice, Orb::Models::NewFloatingTieredPrice, Orb::Models::NewFloatingBulkPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::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::SubscriptionPriceIntervalsParams::Add::Price::GroupedWithMinMaxThresholds, Orb::Models::NewFloatingMatrixWithDisplayNamePrice, Orb::Models::NewFloatingGroupedTieredPackagePrice, Orb::Models::NewFloatingMaxGroupTieredPackagePrice, Orb::Models::NewFloatingScalableMatrixWithUnitPricingPrice, Orb::Models::NewFloatingScalableMatrixWithTieredPricingPrice, Orb::Models::NewFloatingCumulativeGroupedBulkPrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::CumulativeGroupedAllocation, Orb::Models::NewFloatingMinimumCompositePrice, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::Percent, Orb::Models::SubscriptionPriceIntervalsParams::Add::Price::EventOutput, nil] New floating price request body params.
@@ -1674,6 +1685,15 @@ module Orb
                  },
                  nil?: true
 
+        # @!attribute metric_parameter_overrides
+        #   Override values for parameterized billable metric variables. Keys are parameter
+        #   names, values are the override values (number or string).
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute start_date
         #   The updated start date of this price interval. If not specified, the start date
         #   will not be updated.
@@ -1692,7 +1712,7 @@ module Orb
         #   @return [Array<String>, nil]
         optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
 
-        # @!method initialize(price_interval_id:, billing_cycle_day: nil, can_defer_billing: nil, end_date: nil, filter: nil, fixed_fee_quantity_transitions: nil, start_date: nil, usage_customer_ids: nil)
+        # @!method initialize(price_interval_id:, billing_cycle_day: nil, can_defer_billing: nil, end_date: nil, filter: nil, fixed_fee_quantity_transitions: nil, metric_parameter_overrides: nil, start_date: nil, usage_customer_ids: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionPriceIntervalsParams::Edit} for more details.
         #
@@ -1708,6 +1728,8 @@ module Orb
         #
         #   @param fixed_fee_quantity_transitions [Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit::FixedFeeQuantityTransition>, nil] A list of fixed fee quantity transitions to use for this price interval. Note th
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
+        #
         #   @param start_date [Time, Symbol, Orb::Models::BillingCycleRelativeDate] The updated start date of this price interval. If not specified, the start date
         #
         #   @param usage_customer_ids [Array<String>, nil] A list of customer IDs whose usage events will be aggregated and billed under th

data/lib/orb/models/subscription_schedule_plan_change_params.rb

@@ -387,6 +387,15 @@ module Orb
         #   @return [String, nil]
         optional :maximum_amount, String, nil?: true
 
+        # @!attribute metric_parameter_overrides
+        #   Override values for parameterized billable metric variables. Keys are parameter
+        #   names, values are the override values.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute minimum_amount
         #   @deprecated
         #
@@ -422,7 +431,7 @@ module Orb
         #   @return [Time, nil]
         optional :start_date, Time, nil?: true
 
-        # @!method initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil)
+        # @!method initialize(allocation_price: nil, discounts: nil, end_date: nil, external_price_id: nil, maximum_amount: nil, metric_parameter_overrides: nil, minimum_amount: nil, plan_phase_order: nil, price: nil, price_id: nil, start_date: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice} for more details.
         #
@@ -436,6 +445,8 @@ module Orb
         #
         #   @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
+        #
         #   @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         #
         #   @param plan_phase_order [Integer, nil] The phase to add this price to.
@@ -2063,6 +2074,15 @@ module Orb
         #   @return [String, nil]
         optional :maximum_amount, String, nil?: true
 
+        # @!attribute metric_parameter_overrides
+        #   Override values for parameterized billable metric variables. Keys are parameter
+        #   names, values are the override values.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :metric_parameter_overrides,
+                 Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown],
+                 nil?: true
+
         # @!attribute minimum_amount
         #   @deprecated
         #
@@ -2088,7 +2108,7 @@ module Orb
         #   @return [String, nil]
         optional :price_id, String, nil?: true
 
-        # @!method initialize(replaces_price_id:, allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, minimum_amount: nil, price: nil, price_id: nil)
+        # @!method initialize(replaces_price_id:, allocation_price: nil, discounts: nil, external_price_id: nil, fixed_price_quantity: nil, maximum_amount: nil, metric_parameter_overrides: nil, minimum_amount: nil, price: nil, price_id: nil)
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice} for more
         #   details.
@@ -2105,6 +2125,8 @@ module Orb
         #
         #   @param maximum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for
         #
+        #   @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Override values for parameterized billable metric variables. Keys are parameter
+        #
         #   @param minimum_amount [String, nil] [DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for
         #
         #   @param price [Orb::Models::NewSubscriptionUnitPrice, Orb::Models::NewSubscriptionTieredPrice, Orb::Models::NewSubscriptionBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::BulkWithFilters, Orb::Models::NewSubscriptionPackagePrice, Orb::Models::NewSubscriptionMatrixPrice, Orb::Models::NewSubscriptionThresholdTotalAmountPrice, Orb::Models::NewSubscriptionTieredPackagePrice, Orb::Models::NewSubscriptionTieredWithMinimumPrice, Orb::Models::NewSubscriptionGroupedTieredPrice, Orb::Models::NewSubscriptionTieredPackageWithMinimumPrice, Orb::Models::NewSubscriptionPackageWithAllocationPrice, Orb::Models::NewSubscriptionUnitWithPercentPrice, Orb::Models::NewSubscriptionMatrixWithAllocationPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::TieredWithProration, Orb::Models::NewSubscriptionUnitWithProrationPrice, Orb::Models::NewSubscriptionGroupedAllocationPrice, Orb::Models::NewSubscriptionBulkWithProrationPrice, Orb::Models::NewSubscriptionGroupedWithProratedMinimumPrice, Orb::Models::NewSubscriptionGroupedWithMeteredMinimumPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::GroupedWithMinMaxThresholds, Orb::Models::NewSubscriptionMatrixWithDisplayNamePrice, Orb::Models::NewSubscriptionGroupedTieredPackagePrice, Orb::Models::NewSubscriptionMaxGroupTieredPackagePrice, Orb::Models::NewSubscriptionScalableMatrixWithUnitPricingPrice, Orb::Models::NewSubscriptionScalableMatrixWithTieredPricingPrice, Orb::Models::NewSubscriptionCumulativeGroupedBulkPrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::CumulativeGroupedAllocation, Orb::Models::NewSubscriptionMinimumCompositePrice, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::Percent, Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice::Price::EventOutput, nil] New subscription price request body params.

data/lib/orb/resources/alerts.rb

@@ -2,6 +2,11 @@
 
 module Orb
   module Resources
+    # [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.
     class Alerts
       # This endpoint retrieves an alert by its ID.
       #
@@ -88,10 +93,11 @@ module Orb
       # @see Orb::Models::AlertListParams
       def list(params = {})
         parsed, options = Orb::AlertListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "alerts",
-          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]",
@@ -228,10 +234,11 @@ module Orb
       # @see Orb::Models::AlertDisableParams
       def disable(alert_configuration_id, params = {})
         parsed, options = Orb::AlertDisableParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :post,
           path: ["alerts/%1$s/disable", alert_configuration_id],
-          query: parsed,
+          query: query,
           model: Orb::Alert,
           options: options
         )
@@ -254,10 +261,11 @@ module Orb
       # @see Orb::Models::AlertEnableParams
       def enable(alert_configuration_id, params = {})
         parsed, options = Orb::AlertEnableParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :post,
           path: ["alerts/%1$s/enable", alert_configuration_id],
-          query: parsed,
+          query: query,
           model: Orb::Alert,
           options: options
         )

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

@@ -3,6 +3,10 @@
 module Orb
   module Resources
     class Beta
+      # 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).
       class ExternalPlanID
         # This endpoint allows the creation of a new plan version for an existing plan.
         #

data/lib/orb/resources/beta.rb

@@ -2,7 +2,15 @@
 
 module Orb
   module Resources
+    # 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).
     class Beta
+      # 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::ExternalPlanID]
       attr_reader :external_plan_id
 

data/lib/orb/resources/coupons/subscriptions.rb

@@ -3,6 +3,11 @@
 module Orb
   module Resources
     class Coupons
+      # 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.
       class Subscriptions
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Coupons::SubscriptionListParams} for more details.
@@ -27,10 +32,11 @@ module Orb
         # @see Orb::Models::Coupons::SubscriptionListParams
         def list(coupon_id, params = {})
           parsed, options = Orb::Coupons::SubscriptionListParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["coupons/%1$s/subscriptions", coupon_id],
-            query: parsed,
+            query: query,
             page: Orb::Internal::Page,
             model: Orb::Subscription,
             options: options

data/lib/orb/resources/coupons.rb

@@ -2,7 +2,17 @@
 
 module Orb
   module Resources
+    # 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.
     class Coupons
+      # 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::Subscriptions]
       attr_reader :subscriptions
 
@@ -59,10 +69,11 @@ module Orb
       # @see Orb::Models::CouponListParams
       def list(params = {})
         parsed, options = Orb::CouponListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "coupons",
-          query: parsed,
+          query: query,
           page: Orb::Internal::Page,
           model: Orb::Coupon,
           options: options

data/lib/orb/resources/credit_blocks.rb

@@ -2,6 +2,8 @@
 
 module Orb
   module Resources
+    # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+    # credits within Orb.
     class CreditBlocks
       # This endpoint returns a credit block identified by its block_id.
       #

data/lib/orb/resources/credit_notes.rb

@@ -2,6 +2,8 @@
 
 module Orb
   module Resources
+    # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+    # been applied to a particular invoice.
     class CreditNotes
       # Some parameter documentations has been truncated, see
       # {Orb::Models::CreditNoteCreateParams} for more details.
@@ -90,10 +92,11 @@ module Orb
       # @see Orb::Models::CreditNoteListParams
       def list(params = {})
         parsed, options = Orb::CreditNoteListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "credit_notes",
-          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]",

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

@@ -3,6 +3,24 @@
 module Orb
   module Resources
     class Customers
+      # 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.
       class BalanceTransactions
         # Creates an immutable balance transaction that updates the customer's balance and
         # returns back the newly created transaction.
@@ -81,10 +99,11 @@ module Orb
         # @see Orb::Models::Customers::BalanceTransactionListParams
         def list(customer_id, params = {})
           parsed, options = Orb::Customers::BalanceTransactionListParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["customers/%1$s/balance_transactions", customer_id],
-            query: parsed.transform_keys(
+            query: query.transform_keys(
               operation_time_gt: "operation_time[gt]",
               operation_time_gte: "operation_time[gte]",
               operation_time_lt: "operation_time[lt]",

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

@@ -3,6 +3,24 @@
 module Orb
   module Resources
     class Customers
+      # 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.
       class Costs
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Customers::CostListParams} for more details.
@@ -144,10 +162,11 @@ module Orb
         # @see Orb::Models::Customers::CostListParams
         def list(customer_id, params = {})
           parsed, options = Orb::Customers::CostListParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["customers/%1$s/costs", customer_id],
-            query: parsed,
+            query: query,
             model: Orb::Models::Customers::CostListResponse,
             options: options
           )
@@ -293,10 +312,11 @@ module Orb
         # @see Orb::Models::Customers::CostListByExternalIDParams
         def list_by_external_id(external_customer_id, params = {})
           parsed, options = Orb::Customers::CostListByExternalIDParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["customers/external_customer_id/%1$s/costs", external_customer_id],
-            query: parsed,
+            query: query,
             model: Orb::Models::Customers::CostListByExternalIDResponse,
             options: options
           )

data/lib/orb/resources/customers/credits/ledger.rb

@@ -4,6 +4,8 @@ module Orb
   module Resources
     class Customers
       class Credits
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        # credits within Orb.
         class Ledger
           # Some parameter documentations has been truncated, see
           # {Orb::Models::Customers::Credits::LedgerListParams} for more details.
@@ -119,10 +121,11 @@ module Orb
           # @see Orb::Models::Customers::Credits::LedgerListParams
           def list(customer_id, params = {})
             parsed, options = Orb::Customers::Credits::LedgerListParams.dump_request(params)
+            query = Orb::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["customers/%1$s/credits/ledger", customer_id],
-              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]",
@@ -187,8 +190,12 @@ module Orb
           # also generate a one-off invoice for the customer for the credits pre-purchase.
           # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
           # on the invoice are calculated by multiplying the cost basis with the number of
-          # credit units added. Additionally, Orb also enforces invoice generation when a
-          # non-zero `per_unit_cost_basis` value is provided.
+          # credit units added.
+          #
+          # - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
+          #   and `invoice_settings` must be included
+          # - if `invoice_settings` is passed, one of either `custom_due_date` or
+          #   `net_terms` is required to determine the due date
           #
           # ## Deducting Credits
           #
@@ -349,8 +356,12 @@ module Orb
           # also generate a one-off invoice for the customer for the credits pre-purchase.
           # Note that you _must_ provide the `per_unit_cost_basis`, since the total charges
           # on the invoice are calculated by multiplying the cost basis with the number of
-          # credit units added. Additionally, Orb also enforces invoice generation when a
-          # non-zero `per_unit_cost_basis` value is provided.
+          # credit units added.
+          #
+          # - if `per_unit_cost_basis` is greater than zero, an invoice will be generated
+          #   and `invoice_settings` must be included
+          # - if `invoice_settings` is passed, one of either `custom_due_date` or
+          #   `net_terms` is required to determine the due date
           #
           # ## Deducting Credits
           #
@@ -572,10 +583,11 @@ module Orb
           # @see Orb::Models::Customers::Credits::LedgerListByExternalIDParams
           def list_by_external_id(external_customer_id, params = {})
             parsed, options = Orb::Customers::Credits::LedgerListByExternalIDParams.dump_request(params)
+            query = Orb::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["customers/external_customer_id/%1$s/credits/ledger", external_customer_id],
-              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]",

data/lib/orb/resources/customers/credits/top_ups.rb

@@ -4,6 +4,8 @@ module Orb
   module Resources
     class Customers
       class Credits
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        # credits within Orb.
         class TopUps
           # Some parameter documentations has been truncated, see
           # {Orb::Models::Customers::Credits::TopUpCreateParams} for more details.
@@ -72,10 +74,11 @@ module Orb
           # @see Orb::Models::Customers::Credits::TopUpListParams
           def list(customer_id, params = {})
             parsed, options = Orb::Customers::Credits::TopUpListParams.dump_request(params)
+            query = Orb::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["customers/%1$s/credits/top_ups", customer_id],
-              query: parsed,
+              query: query,
               page: Orb::Internal::Page,
               model: Orb::Models::Customers::Credits::TopUpListResponse,
               options: options
@@ -206,10 +209,11 @@ module Orb
           # @see Orb::Models::Customers::Credits::TopUpListByExternalIDParams
           def list_by_external_id(external_customer_id, params = {})
             parsed, options = Orb::Customers::Credits::TopUpListByExternalIDParams.dump_request(params)
+            query = Orb::Internal::Util.encode_query_params(parsed)
             @client.request(
               method: :get,
               path: ["customers/external_customer_id/%1$s/credits/top_ups", external_customer_id],
-              query: parsed,
+              query: query,
               page: Orb::Internal::Page,
               model: Orb::Models::Customers::Credits::TopUpListByExternalIDResponse,
               options: options