orb-billing 0.5.4 → 0.6.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

@@ -158,6 +158,8 @@ module Orb
 
   Item = Orb::Models::Item
 
+  ItemArchiveParams = Orb::Models::ItemArchiveParams
+
   ItemCreateParams = Orb::Models::ItemCreateParams
 
   ItemFetchParams = Orb::Models::ItemFetchParams
@@ -188,6 +190,8 @@ module Orb
 
   Plans = Orb::Models::Plans
 
+  PlanSetDefaultVersionParams = Orb::Models::PlanSetDefaultVersionParams
+
   PlanUpdateParams = Orb::Models::PlanUpdateParams
 
   Price = Orb::Models::Price

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/versions.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Plans
+      class ExternalPlanID
+        class Versions
+          # 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(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::Plans::ExternalPlanID::VersionCreateParams::AddAdjustment>, nil] Additional adjustments to be added to the plan.
+          #
+          # @param add_prices [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::AddPrice>, nil] Additional prices to be added to the plan.
+          #
+          # @param remove_adjustments [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::RemoveAdjustment>, nil] Adjustments to be removed from the plan.
+          #
+          # @param remove_prices [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::RemovePrice>, nil] Prices to be removed from the plan.
+          #
+          # @param replace_adjustments [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::ReplaceAdjustment>, nil] Adjustments to be replaced with additional adjustments on the plan.
+          #
+          # @param replace_prices [Array<Orb::Models::Plans::ExternalPlanID::VersionCreateParams::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::Plans::ExternalPlanID::VersionCreateResponse]
+          #
+          # @see Orb::Models::Plans::ExternalPlanID::VersionCreateParams
+          def create(external_plan_id, params)
+            parsed, options = Orb::Plans::ExternalPlanID::VersionCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: ["plans/external_plan_id/%1$s/versions", external_plan_id],
+              body: parsed,
+              model: Orb::Models::Plans::ExternalPlanID::VersionCreateResponse,
+              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 retrieve(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::Plans::ExternalPlanID::VersionRetrieveResponse]
+          #
+          # @see Orb::Models::Plans::ExternalPlanID::VersionRetrieveParams
+          def retrieve(version, params)
+            parsed, options = Orb::Plans::ExternalPlanID::VersionRetrieveParams.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::Models::Plans::ExternalPlanID::VersionRetrieveResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Orb::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,13 +4,16 @@ module Orb
   module Resources
     class Plans
       class ExternalPlanID
+        # @return [Orb::Resources::Plans::ExternalPlanID::Versions]
+        attr_reader :versions
+
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Plans::ExternalPlanIDUpdateParams} for more details.
         #
         # 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: {})
         #
@@ -70,11 +73,39 @@ module Orb
           )
         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_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::Plans::ExternalPlanIDSetDefaultVersionParams
+        def set_default_version(external_plan_id, params)
+          parsed, options = Orb::Plans::ExternalPlanIDSetDefaultVersionParams.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
+          @versions = Orb::Resources::Plans::ExternalPlanID::Versions.new(client: client)
         end
       end
     end

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Orb
+  module Resources
+    class Plans
+      class Versions
+        # 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_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::Plans::VersionCreateParams::AddAdjustment>, nil] Additional adjustments to be added to the plan.
+        #
+        # @param add_prices [Array<Orb::Models::Plans::VersionCreateParams::AddPrice>, nil] Additional prices to be added to the plan.
+        #
+        # @param remove_adjustments [Array<Orb::Models::Plans::VersionCreateParams::RemoveAdjustment>, nil] Adjustments to be removed from the plan.
+        #
+        # @param remove_prices [Array<Orb::Models::Plans::VersionCreateParams::RemovePrice>, nil] Prices to be removed from the plan.
+        #
+        # @param replace_adjustments [Array<Orb::Models::Plans::VersionCreateParams::ReplaceAdjustment>, nil] Adjustments to be replaced with additional adjustments on the plan.
+        #
+        # @param replace_prices [Array<Orb::Models::Plans::VersionCreateParams::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::Plans::VersionCreateResponse]
+        #
+        # @see Orb::Models::Plans::VersionCreateParams
+        def create(plan_id, params)
+          parsed, options = Orb::Plans::VersionCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["plans/%1$s/versions", plan_id],
+            body: parsed,
+            model: Orb::Models::Plans::VersionCreateResponse,
+            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 retrieve(version, plan_id:, request_options: {})
+        #
+        # @param version [String]
+        # @param plan_id [String]
+        # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Orb::Models::Plans::VersionRetrieveResponse]
+        #
+        # @see Orb::Models::Plans::VersionRetrieveParams
+        def retrieve(version, params)
+          parsed, options = Orb::Plans::VersionRetrieveParams.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::Models::Plans::VersionRetrieveResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Orb::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/orb/resources/plans.rb

@@ -6,6 +6,9 @@ module Orb
       # @return [Orb::Resources::Plans::ExternalPlanID]
       attr_reader :external_plan_id
 
+      # @return [Orb::Resources::Plans::Versions]
+      attr_reader :versions
+
       # Some parameter documentations has been truncated, see
       # {Orb::Models::PlanCreateParams} for more details.
       #
@@ -17,7 +20,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 +48,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: {})
       #
@@ -153,12 +156,40 @@ module Orb
         )
       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_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::PlanSetDefaultVersionParams
+      def set_default_version(plan_id, params)
+        parsed, options = Orb::PlanSetDefaultVersionParams.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::Plans::ExternalPlanID.new(client: client)
+        @versions = Orb::Resources::Plans::Versions.new(client: client)
       end
     end
   end