orb-billing 1.12.0 → 1.13.0

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

@@ -3,10 +3,16 @@
 module Orb
   module Resources
     class Customers
+      # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+      # credits within Orb.
       class Credits
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        # credits within Orb.
         # @return [Orb::Resources::Customers::Credits::Ledger]
         attr_reader :ledger
 
+        # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+        # credits within Orb.
         # @return [Orb::Resources::Customers::Credits::TopUps]
         attr_reader :top_ups
 
@@ -53,10 +59,11 @@ module Orb
         # @see Orb::Models::Customers::CreditListParams
         def list(customer_id, params = {})
           parsed, options = Orb::Customers::CreditListParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["customers/%1$s/credits", customer_id],
-            query: parsed.transform_keys(
+            query: query.transform_keys(
               effective_date_gt: "effective_date[gt]",
               effective_date_gte: "effective_date[gte]",
               effective_date_lt: "effective_date[lt]",
@@ -111,10 +118,11 @@ module Orb
         # @see Orb::Models::Customers::CreditListByExternalIDParams
         def list_by_external_id(external_customer_id, params = {})
           parsed, options = Orb::Customers::CreditListByExternalIDParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["customers/external_customer_id/%1$s/credits", external_customer_id],
-            query: parsed.transform_keys(
+            query: query.transform_keys(
               effective_date_gt: "effective_date[gt]",
               effective_date_gte: "effective_date[gte]",
               effective_date_lt: "effective_date[lt]",

data/lib/orb/resources/customers.rb

@@ -2,13 +2,69 @@
 
 module Orb
   module Resources
+    # 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 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.
       # @return [Orb::Resources::Customers::Costs]
       attr_reader :costs
 
+      # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+      # credits within Orb.
       # @return [Orb::Resources::Customers::Credits]
       attr_reader :credits
 
+      # A customer is a buyer of your products, and the other party to the billing
+      # relationship.
+      #
+      # In Orb, customers are assigned system generated identifiers automatically, but
+      # it's often desirable to have these match existing identifiers in your system. To
+      # avoid having to denormalize Orb ID information, you can pass in an
+      # `external_customer_id` with your own identifier. See
+      # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      # information about how these aliases work in Orb.
+      #
+      # In addition to having an identifier in your system, a customer may exist in a
+      # payment provider solution like Stripe. Use the `payment_provider_id` and the
+      # `payment_provider` enum field to express this mapping.
+      #
+      # A customer also has a timezone (from the standard
+      # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      # your account's timezone. See [Timezone localization](/essentials/timezones) for
+      # information on what this timezone parameter influences within Orb.
       # @return [Orb::Resources::Customers::BalanceTransactions]
       attr_reader :balance_transactions
 
@@ -184,10 +240,11 @@ module Orb
       # @see Orb::Models::CustomerListParams
       def list(params = {})
         parsed, options = Orb::CustomerListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "customers",
-          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/dimensional_price_groups.rb

@@ -114,10 +114,11 @@ module Orb
       # @see Orb::Models::DimensionalPriceGroupListParams
       def list(params = {})
         parsed, options = Orb::DimensionalPriceGroupListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "dimensional_price_groups",
-          query: parsed,
+          query: query,
           page: Orb::Internal::Page,
           model: Orb::DimensionalPriceGroup,
           options: options

data/lib/orb/resources/events/backfills.rb

@@ -3,6 +3,9 @@
 module Orb
   module Resources
     class Events
+      # 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.
       class Backfills
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Events::BackfillCreateParams} for more details.
@@ -104,10 +107,11 @@ module Orb
         # @see Orb::Models::Events::BackfillListParams
         def list(params = {})
           parsed, options = Orb::Events::BackfillListParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: "events/backfills",
-            query: parsed,
+            query: query,
             page: Orb::Internal::Page,
             model: Orb::Models::Events::BackfillListResponse,
             options: options

data/lib/orb/resources/events/volume.rb

@@ -3,6 +3,9 @@
 module Orb
   module Resources
     class Events
+      # 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.
       class Volume
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Events::VolumeListParams} for more details.
@@ -38,10 +41,11 @@ module Orb
         # @see Orb::Models::Events::VolumeListParams
         def list(params)
           parsed, options = Orb::Events::VolumeListParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: "events/volume",
-            query: parsed,
+            query: query,
             model: Orb::Events::EventVolumes,
             options: options
           )

data/lib/orb/resources/events.rb

@@ -2,10 +2,19 @@
 
 module Orb
   module Resources
+    # 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.
     class Events
+      # The [Event](/core-concepts#event) resource represents a usage event that has
+      # been created for a customer. Events are the core of Orb's usage-based billing
+      # model, and are used to calculate the usage charges for a given billing period.
       # @return [Orb::Resources::Events::Backfills]
       attr_reader :backfills
 
+      # The [Event](/core-concepts#event) resource represents a usage event that has
+      # been created for a customer. Events are the core of Orb's usage-based billing
+      # model, and are used to calculate the usage charges for a given billing period.
       # @return [Orb::Resources::Events::Volume]
       attr_reader :volume
 
@@ -368,12 +377,13 @@ module Orb
       #
       # @see Orb::Models::EventIngestParams
       def ingest(params)
-        parsed, options = Orb::EventIngestParams.dump_request(params)
         query_params = [:backfill_id, :debug]
+        parsed, options = Orb::EventIngestParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :post,
           path: "ingest",
-          query: parsed.slice(*query_params),
+          query: query,
           body: parsed.except(*query_params),
           model: Orb::Models::EventIngestResponse,
           options: options

data/lib/orb/resources/invoice_line_items.rb

@@ -2,6 +2,11 @@
 
 module Orb
   module Resources
+    # 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.
     class InvoiceLineItems
       # Some parameter documentations has been truncated, see
       # {Orb::Models::InvoiceLineItemCreateParams} for more details.

data/lib/orb/resources/invoices.rb

@@ -2,13 +2,18 @@
 
 module Orb
   module Resources
+    # 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.
     class Invoices
       # Some parameter documentations has been truncated, see
       # {Orb::Models::InvoiceCreateParams} for more details.
       #
       # This endpoint is used to create a one-off invoice for a customer.
       #
-      # @overload create(currency:, invoice_date:, line_items:, customer_id: nil, discount: nil, due_date: nil, external_customer_id: nil, memo: nil, metadata: nil, net_terms: nil, will_auto_issue: nil, request_options: {})
+      # @overload create(currency:, invoice_date:, line_items:, auto_collection: nil, customer_id: nil, discount: nil, due_date: nil, external_customer_id: nil, memo: nil, metadata: nil, net_terms: nil, will_auto_issue: nil, request_options: {})
       #
       # @param currency [String] An ISO 4217 currency string. Must be the same as the customer's currency if it i
       #
@@ -16,6 +21,8 @@ module Orb
       #
       # @param line_items [Array<Orb::Models::InvoiceCreateParams::LineItem>]
       #
+      # @param auto_collection [Boolean, nil] Determines whether this invoice will automatically attempt to charge a saved pay
+      #
       # @param customer_id [String, nil] The id of the `Customer` to create this invoice for. One of `customer_id` and `e
       #
       # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil] An optional discount to attach to the invoice.
@@ -45,18 +52,21 @@ module Orb
       # Some parameter documentations has been truncated, see
       # {Orb::Models::InvoiceUpdateParams} for more details.
       #
-      # This endpoint allows you to update the `metadata`, `net_terms`, `due_date`, and
-      # `invoice_date` properties on an invoice. If you pass null for the metadata
-      # value, it will clear any existing metadata for that invoice.
+      # This endpoint allows you to update the `metadata`, `net_terms`, `due_date`,
+      # `invoice_date`, and `auto_collection` properties on an invoice. If you pass null
+      # for the metadata value, it will clear any existing metadata for that invoice.
       #
       # `metadata` can be modified regardless of invoice state. `net_terms`, `due_date`,
-      # and `invoice_date` can only be modified if the invoice is in a `draft` state.
-      # `invoice_date` can only be modified for non-subscription invoices.
+      # `invoice_date`, and `auto_collection` can only be modified if the invoice is in
+      # a `draft` state. `invoice_date` can only be modified for non-subscription
+      # invoices.
       #
-      # @overload update(invoice_id, due_date: nil, invoice_date: nil, metadata: nil, net_terms: nil, request_options: {})
+      # @overload update(invoice_id, auto_collection: nil, due_date: nil, invoice_date: nil, metadata: nil, net_terms: nil, request_options: {})
       #
       # @param invoice_id [String]
       #
+      # @param auto_collection [Boolean, nil] Determines whether this invoice will automatically attempt to charge a saved pay
+      #
       # @param due_date [Date, Time, nil] An optional custom due date for the invoice. If not set, the due date will be ca
       #
       # @param invoice_date [Date, Time, nil] The date of the invoice. Can only be modified for one-off draft invoices.
@@ -145,10 +155,11 @@ module Orb
       # @see Orb::Models::InvoiceListParams
       def list(params = {})
         parsed, options = Orb::InvoiceListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "invoices",
-          query: parsed.transform_keys(
+          query: query.transform_keys(
             amount_gt: "amount[gt]",
             amount_lt: "amount[lt]",
             due_date_gt: "due_date[gt]",
@@ -227,10 +238,11 @@ module Orb
       # @see Orb::Models::InvoiceFetchUpcomingParams
       def fetch_upcoming(params)
         parsed, options = Orb::InvoiceFetchUpcomingParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "invoices/upcoming",
-          query: parsed,
+          query: query,
           model: Orb::Models::InvoiceFetchUpcomingResponse,
           options: options
         )
@@ -370,10 +382,11 @@ module Orb
       # @see Orb::Models::InvoiceListSummaryParams
       def list_summary(params = {})
         parsed, options = Orb::InvoiceListSummaryParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "invoices/summary",
-          query: parsed.transform_keys(
+          query: query.transform_keys(
             amount_gt: "amount[gt]",
             amount_lt: "amount[lt]",
             due_date_gt: "due_date[gt]",

data/lib/orb/resources/items.rb

@@ -2,6 +2,9 @@
 
 module Orb
   module Resources
+    # 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.
     class Items
       # Some parameter documentations has been truncated, see
       # {Orb::Models::ItemCreateParams} for more details.
@@ -74,10 +77,11 @@ module Orb
       # @see Orb::Models::ItemListParams
       def list(params = {})
         parsed, options = Orb::ItemListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "items",
-          query: parsed,
+          query: query,
           page: Orb::Internal::Page,
           model: Orb::Item,
           options: options

data/lib/orb/resources/license_types.rb

@@ -2,6 +2,9 @@
 
 module Orb
   module Resources
+    # 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.
     class LicenseTypes
       # Some parameter documentations has been truncated, see
       # {Orb::Models::LicenseTypeCreateParams} for more details.
@@ -79,10 +82,11 @@ module Orb
       # @see Orb::Models::LicenseTypeListParams
       def list(params = {})
         parsed, options = Orb::LicenseTypeListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "license_types",
-          query: parsed,
+          query: query,
           page: Orb::Internal::Page,
           model: Orb::Models::LicenseTypeListResponse,
           options: options

data/lib/orb/resources/licenses/external_licenses.rb

@@ -37,10 +37,11 @@ module Orb
         # @see Orb::Models::Licenses::ExternalLicenseGetUsageParams
         def get_usage(external_license_id, params)
           parsed, options = Orb::Licenses::ExternalLicenseGetUsageParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["licenses/external_licenses/%1$s/usage", external_license_id],
-            query: parsed,
+            query: query,
             model: Orb::Models::Licenses::ExternalLicenseGetUsageResponse,
             options: options
           )

data/lib/orb/resources/licenses/usage.rb

@@ -35,10 +35,11 @@ module Orb
         # @see Orb::Models::Licenses::UsageGetAllUsageParams
         def get_all_usage(params)
           parsed, options = Orb::Licenses::UsageGetAllUsageParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: "licenses/usage",
-            query: parsed,
+            query: query,
             model: Orb::Models::Licenses::UsageGetAllUsageResponse,
             options: options
           )
@@ -72,10 +73,11 @@ module Orb
         # @see Orb::Models::Licenses::UsageGetUsageParams
         def get_usage(license_id, params = {})
           parsed, options = Orb::Licenses::UsageGetUsageParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["licenses/%1$s/usage", license_id],
-            query: parsed,
+            query: query,
             model: Orb::Models::Licenses::UsageGetUsageResponse,
             options: options
           )

data/lib/orb/resources/licenses.rb

@@ -91,10 +91,11 @@ module Orb
       # @see Orb::Models::LicenseListParams
       def list(params)
         parsed, options = Orb::LicenseListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "licenses",
-          query: parsed,
+          query: query,
           page: Orb::Internal::Page,
           model: Orb::Models::LicenseListResponse,
           options: options
@@ -149,10 +150,11 @@ module Orb
       # @see Orb::Models::LicenseRetrieveByExternalIDParams
       def retrieve_by_external_id(external_license_id, params)
         parsed, options = Orb::LicenseRetrieveByExternalIDParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: ["licenses/external_license_id/%1$s", external_license_id],
-          query: parsed,
+          query: query,
           model: Orb::Models::LicenseRetrieveByExternalIDResponse,
           options: options
         )

data/lib/orb/resources/metrics.rb

@@ -2,6 +2,9 @@
 
 module Orb
   module Resources
+    # 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.
     class Metrics
       # Some parameter documentations has been truncated, see
       # {Orb::Models::MetricCreateParams} for more details.
@@ -95,10 +98,11 @@ module Orb
       # @see Orb::Models::MetricListParams
       def list(params = {})
         parsed, options = Orb::MetricListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "metrics",
-          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/plans/external_plan_id.rb

@@ -3,6 +3,10 @@
 module Orb
   module Resources
     class Plans
+      # 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
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details.

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

@@ -3,6 +3,10 @@
 module Orb
   module Resources
     class Plans
+      # 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 Migrations
         # Fetch migration
         #
@@ -52,10 +56,11 @@ module Orb
         # @see Orb::Models::Plans::MigrationListParams
         def list(plan_id, params = {})
           parsed, options = Orb::Plans::MigrationListParams.dump_request(params)
+          query = Orb::Internal::Util.encode_query_params(parsed)
           @client.request(
             method: :get,
             path: ["plans/%1$s/migrations", plan_id],
-            query: parsed,
+            query: query,
             page: Orb::Internal::Page,
             model: Orb::Models::Plans::MigrationListResponse,
             options: options

data/lib/orb/resources/plans.rb

@@ -2,10 +2,22 @@
 
 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 Plans
+      # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      # subscribed to by a customer. Plans define the billing behavior of the
+      # subscription. You can see more about how to configure prices in the
+      # [Price resource](/reference/price).
       # @return [Orb::Resources::Plans::ExternalPlanID]
       attr_reader :external_plan_id
 
+      # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      # subscribed to by a customer. Plans define the billing behavior of the
+      # subscription. You can see more about how to configure prices in the
+      # [Price resource](/reference/price).
       # @return [Orb::Resources::Plans::Migrations]
       attr_reader :migrations
 
@@ -110,10 +122,11 @@ module Orb
       # @see Orb::Models::PlanListParams
       def list(params = {})
         parsed, options = Orb::PlanListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "plans",
-          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/prices/external_price_id.rb

@@ -3,6 +3,16 @@
 module Orb
   module Resources
     class Prices
+      # 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)
       class ExternalPriceID
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Prices::ExternalPriceIDUpdateParams} for more details.

data/lib/orb/resources/prices.rb

@@ -2,7 +2,27 @@
 
 module Orb
   module Resources
+    # 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)
     class Prices
+      # The Price resource represents a price that can be billed on a subscription,
+      # resulting in a charge on an invoice in the form of an invoice line item. Prices
+      # take a quantity and determine an amount to bill.
+      #
+      # Orb supports a few different pricing models out of the box. Each of these models
+      # is serialized differently in a given Price object. The model_type field
+      # determines the key for the configuration object that is present.
+      #
+      # For more on the types of prices, see
+      # [the core concepts documentation](/core-concepts#plan-and-price)
       # @return [Orb::Resources::Prices::ExternalPriceID]
       attr_reader :external_price_id
 
@@ -176,10 +196,11 @@ module Orb
       # @see Orb::Models::PriceListParams
       def list(params = {})
         parsed, options = Orb::PriceListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "prices",
-          query: parsed,
+          query: query,
           page: Orb::Internal::Page,
           model: Orb::Price,
           options: options
@@ -215,7 +236,7 @@ module Orb
       # endpoint rather than a GET endpoint because it employs a JSON body rather than
       # query parameters.
       #
-      # @overload evaluate(price_id, timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, request_options: {})
+      # @overload evaluate(price_id, timeframe_end:, timeframe_start:, customer_id: nil, external_customer_id: nil, filter: nil, grouping_keys: nil, metric_parameter_overrides: nil, request_options: {})
       #
       # @param price_id [String]
       #
@@ -231,6 +252,8 @@ module Orb
       #
       # @param grouping_keys [Array<String>] Properties (or [computed properties](/extensibility/advanced-metrics#computed-pr
       #
+      # @param metric_parameter_overrides [Hash{Symbol=>Object}, nil] Optional overrides for parameterized billable metric parameters. If the metric h
+      #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Orb::Models::PriceEvaluateResponse]

data/lib/orb/resources/subscription_changes.rb

@@ -56,10 +56,11 @@ module Orb
       # @see Orb::Models::SubscriptionChangeListParams
       def list(params = {})
         parsed, options = Orb::SubscriptionChangeListParams.dump_request(params)
+        query = Orb::Internal::Util.encode_query_params(parsed)
         @client.request(
           method: :get,
           path: "subscription_changes",
-          query: parsed,
+          query: query,
           page: Orb::Internal::Page,
           model: Orb::Models::SubscriptionChangeListResponse,
           options: options