orb-billing 0.2.0 → 0.3.1

data/lib/orb/models/plan.rb

@@ -13,7 +13,7 @@ module Orb
       #   Adjustments for this plan. If the plan has phases, this includes adjustments
       #   across all phases of the plan.
       #
-      #   @return [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>]
+      #   @return [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>]
       required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Plan::Adjustment] }
 
       # @!attribute base_plan
@@ -34,6 +34,8 @@ module Orb
       required :created_at, Time
 
       # @!attribute currency
+      #   @deprecated
+      #
       #   An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's
       #   prices.
       #
@@ -125,7 +127,7 @@ module Orb
       #   Prices for this plan. If the plan has phases, this includes prices across all
       #   phases of the plan.
       #
-      #   @return [Array<Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice>]
+      #   @return [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>]
       required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::Price] }
 
       # @!attribute product
@@ -148,85 +150,88 @@ module Orb
       #   @return [Integer]
       required :version, Integer
 
-      # @!parse
-      #   # 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).
-      #   #
-      #   # @param id [String]
-      #   # @param adjustments [Array<Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment>]
-      #   # @param base_plan [Orb::Models::Plan::BasePlan, nil]
-      #   # @param base_plan_id [String, nil]
-      #   # @param created_at [Time]
-      #   # @param currency [String]
-      #   # @param default_invoice_memo [String, nil]
-      #   # @param description [String]
-      #   # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
-      #   # @param external_plan_id [String, nil]
-      #   # @param invoicing_currency [String]
-      #   # @param maximum [Orb::Models::Plan::Maximum, nil]
-      #   # @param maximum_amount [String, nil]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param minimum [Orb::Models::Plan::Minimum, nil]
-      #   # @param minimum_amount [String, nil]
-      #   # @param name [String]
-      #   # @param net_terms [Integer, nil]
-      #   # @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
-      #   # @param prices [Array<Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice>]
-      #   # @param product [Orb::Models::Plan::Product]
-      #   # @param status [Symbol, Orb::Models::Plan::Status]
-      #   # @param trial_config [Orb::Models::Plan::TrialConfig]
-      #   # @param version [Integer]
-      #   #
-      #   def initialize(
-      #     id:,
-      #     adjustments:,
-      #     base_plan:,
-      #     base_plan_id:,
-      #     created_at:,
-      #     currency:,
-      #     default_invoice_memo:,
-      #     description:,
-      #     discount:,
-      #     external_plan_id:,
-      #     invoicing_currency:,
-      #     maximum:,
-      #     maximum_amount:,
-      #     metadata:,
-      #     minimum:,
-      #     minimum_amount:,
-      #     name:,
-      #     net_terms:,
-      #     plan_phases:,
-      #     prices:,
-      #     product:,
-      #     status:,
-      #     trial_config:,
-      #     version:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, adjustments:, base_plan:, base_plan_id:, created_at:, currency:, default_invoice_memo:, description:, discount:, external_plan_id:, invoicing_currency:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, net_terms:, plan_phases:, prices:, product:, status:, trial_config:, version:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::Plan} for
+      #   more details.
+      #
+      #   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).
+      #
+      #   @param id [String]
+      #
+      #   @param adjustments [Array<Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
+      #   ...
+      #
+      #   @param base_plan [Orb::Models::Plan::BasePlan, nil]
+      #
+      #   @param base_plan_id [String, nil] The parent plan id if the given plan was created by overriding one or more of th
+      #   ...
+      #
+      #   @param created_at [Time]
+      #
+      #   @param currency [String] An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's p
+      #   ...
+      #
+      #   @param default_invoice_memo [String, nil] The default memo text on the invoices corresponding to subscriptions on this pla
+      #   ...
+      #
+      #   @param description [String]
+      #
+      #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+      #
+      #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+      #   ...
+      #
+      #   @param invoicing_currency [String] An ISO 4217 currency string for which this plan is billed in. Matches `currency`
+      #   ...
+      #
+      #   @param maximum [Orb::Models::Plan::Maximum, nil]
+      #
+      #   @param maximum_amount [String, nil]
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #   ...
+      #
+      #   @param minimum [Orb::Models::Plan::Minimum, nil]
+      #
+      #   @param minimum_amount [String, nil]
+      #
+      #   @param name [String]
+      #
+      #   @param net_terms [Integer, nil] Determines the difference between the invoice issue date and the due date. A val
+      #   ...
+      #
+      #   @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
+      #
+      #   @param prices [Array<Orb::Models::Price::Unit, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::Tiered, Orb::Models::Price::TieredBps, Orb::Models::Price::Bps, Orb::Models::Price::BulkBps, Orb::Models::Price::Bulk, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      #   ...
+      #
+      #   @param product [Orb::Models::Plan::Product]
+      #
+      #   @param status [Symbol, Orb::Models::Plan::Status]
+      #
+      #   @param trial_config [Orb::Models::Plan::TrialConfig]
+      #
+      #   @param version [Integer]
 
       module Adjustment
         extend Orb::Internal::Type::Union
 
         discriminator :adjustment_type
 
-        variant :usage_discount, -> { Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment }
+        variant :usage_discount, -> { Orb::Models::Plan::Adjustment::UsageDiscount }
 
-        variant :amount_discount, -> { Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment }
+        variant :amount_discount, -> { Orb::Models::Plan::Adjustment::AmountDiscount }
 
-        variant :percentage_discount, -> { Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment }
+        variant :percentage_discount, -> { Orb::Models::Plan::Adjustment::PercentageDiscount }
 
-        variant :minimum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment }
+        variant :minimum, -> { Orb::Models::Plan::Adjustment::Minimum }
 
-        variant :maximum, -> { Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment }
+        variant :maximum, -> { Orb::Models::Plan::Adjustment::Maximum }
 
-        class PlanPhaseUsageDiscountAdjustment < Orb::Internal::Type::BaseModel
+        class UsageDiscount < Orb::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -269,32 +274,28 @@ module Orb
           #   @return [Float]
           required :usage_discount, Float
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param is_invoice_level [Boolean]
-          #   # @param plan_phase_order [Integer, nil]
-          #   # @param reason [String, nil]
-          #   # @param usage_discount [Float]
-          #   # @param adjustment_type [Symbol, :usage_discount]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     applies_to_price_ids:,
-          #     is_invoice_level:,
-          #     plan_phase_order:,
-          #     reason:,
-          #     usage_discount:,
-          #     adjustment_type: :usage_discount,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:, adjustment_type: :usage_discount)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Plan::Adjustment::UsageDiscount} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+          #
+          #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+          #   ...
+          #
+          #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+          #
+          #   @param reason [String, nil] The reason for the adjustment.
+          #
+          #   @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
+          #   ...
+          #
+          #   @param adjustment_type [Symbol, :usage_discount]
         end
 
-        class PlanPhaseAmountDiscountAdjustment < Orb::Internal::Type::BaseModel
+        class AmountDiscount < Orb::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -337,32 +338,28 @@ module Orb
           #   @return [String, nil]
           required :reason, String, nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param amount_discount [String]
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param is_invoice_level [Boolean]
-          #   # @param plan_phase_order [Integer, nil]
-          #   # @param reason [String, nil]
-          #   # @param adjustment_type [Symbol, :amount_discount]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     amount_discount:,
-          #     applies_to_price_ids:,
-          #     is_invoice_level:,
-          #     plan_phase_order:,
-          #     reason:,
-          #     adjustment_type: :amount_discount,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, amount_discount:, applies_to_price_ids:, is_invoice_level:, plan_phase_order:, reason:, adjustment_type: :amount_discount)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Plan::Adjustment::AmountDiscount} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param amount_discount [String] The amount by which to discount the prices this adjustment applies to in a given
+          #   ...
+          #
+          #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+          #
+          #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+          #   ...
+          #
+          #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+          #
+          #   @param reason [String, nil] The reason for the adjustment.
+          #
+          #   @param adjustment_type [Symbol, :amount_discount]
         end
 
-        class PlanPhasePercentageDiscountAdjustment < Orb::Internal::Type::BaseModel
+        class PercentageDiscount < Orb::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -405,32 +402,28 @@ module Orb
           #   @return [String, nil]
           required :reason, String, nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param is_invoice_level [Boolean]
-          #   # @param percentage_discount [Float]
-          #   # @param plan_phase_order [Integer, nil]
-          #   # @param reason [String, nil]
-          #   # @param adjustment_type [Symbol, :percentage_discount]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     applies_to_price_ids:,
-          #     is_invoice_level:,
-          #     percentage_discount:,
-          #     plan_phase_order:,
-          #     reason:,
-          #     adjustment_type: :percentage_discount,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, adjustment_type: :percentage_discount)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Plan::Adjustment::PercentageDiscount} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+          #
+          #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+          #   ...
+          #
+          #   @param percentage_discount [Float] The percentage (as a value between 0 and 1) by which to discount the price inter
+          #   ...
+          #
+          #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+          #
+          #   @param reason [String, nil] The reason for the adjustment.
+          #
+          #   @param adjustment_type [Symbol, :percentage_discount]
         end
 
-        class PlanPhaseMinimumAdjustment < Orb::Internal::Type::BaseModel
+        class Minimum < Orb::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -479,34 +472,30 @@ module Orb
           #   @return [String, nil]
           required :reason, String, nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param is_invoice_level [Boolean]
-          #   # @param item_id [String]
-          #   # @param minimum_amount [String]
-          #   # @param plan_phase_order [Integer, nil]
-          #   # @param reason [String, nil]
-          #   # @param adjustment_type [Symbol, :minimum]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     applies_to_price_ids:,
-          #     is_invoice_level:,
-          #     item_id:,
-          #     minimum_amount:,
-          #     plan_phase_order:,
-          #     reason:,
-          #     adjustment_type: :minimum,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, adjustment_type: :minimum)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Plan::Adjustment::Minimum} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+          #
+          #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+          #   ...
+          #
+          #   @param item_id [String] The item ID that revenue from this minimum will be attributed to.
+          #
+          #   @param minimum_amount [String] The minimum amount to charge in a given billing period for the prices this adjus
+          #   ...
+          #
+          #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+          #
+          #   @param reason [String, nil] The reason for the adjustment.
+          #
+          #   @param adjustment_type [Symbol, :minimum]
         end
 
-        class PlanPhaseMaximumAdjustment < Orb::Internal::Type::BaseModel
+        class Maximum < Orb::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -549,34 +538,29 @@ module Orb
           #   @return [String, nil]
           required :reason, String, nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param is_invoice_level [Boolean]
-          #   # @param maximum_amount [String]
-          #   # @param plan_phase_order [Integer, nil]
-          #   # @param reason [String, nil]
-          #   # @param adjustment_type [Symbol, :maximum]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     applies_to_price_ids:,
-          #     is_invoice_level:,
-          #     maximum_amount:,
-          #     plan_phase_order:,
-          #     reason:,
-          #     adjustment_type: :maximum,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, applies_to_price_ids:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, adjustment_type: :maximum)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Plan::Adjustment::Maximum} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+          #
+          #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invocice, false for adjustments tha
+          #   ...
+          #
+          #   @param maximum_amount [String] The maximum amount to charge in a given billing period for the prices this adjus
+          #   ...
+          #
+          #   @param plan_phase_order [Integer, nil] The plan phase in which this adjustment is active.
+          #
+          #   @param reason [String, nil] The reason for the adjustment.
+          #
+          #   @param adjustment_type [Symbol, :maximum]
         end
 
-        # @!parse
-        #   # @return [Array(Orb::Models::Plan::Adjustment::PlanPhaseUsageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseAmountDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMinimumAdjustment, Orb::Models::Plan::Adjustment::PlanPhaseMaximumAdjustment)]
-        #   def self.variants; end
+        # @!method self.variants
+        #   @return [Array(Orb::Models::Plan::Adjustment::UsageDiscount, Orb::Models::Plan::Adjustment::AmountDiscount, Orb::Models::Plan::Adjustment::PercentageDiscount, Orb::Models::Plan::Adjustment::Minimum, Orb::Models::Plan::Adjustment::Maximum)]
       end
 
       # @see Orb::Models::Plan#base_plan
@@ -599,14 +583,16 @@ module Orb
         #   @return [String, nil]
         required :name, String, nil?: true
 
-        # @!parse
-        #   # @param id [String, nil]
-        #   # @param external_plan_id [String, nil]
-        #   # @param name [String, nil]
-        #   #
-        #   def initialize(id:, external_plan_id:, name:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, external_plan_id:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Plan::BasePlan} for more details.
+        #
+        #   @param id [String, nil]
+        #
+        #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+        #   ...
+        #
+        #   @param name [String, nil]
       end
 
       # @see Orb::Models::Plan#maximum
@@ -624,13 +610,14 @@ module Orb
         #   @return [String]
         required :maximum_amount, String
 
-        # @!parse
-        #   # @param applies_to_price_ids [Array<String>]
-        #   # @param maximum_amount [String]
-        #   #
-        #   def initialize(applies_to_price_ids:, maximum_amount:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(applies_to_price_ids:, maximum_amount:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Plan::Maximum} for more details.
+        #
+        #   @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
+        #   ...
+        #
+        #   @param maximum_amount [String] Maximum amount applied
       end
 
       # @see Orb::Models::Plan#minimum
@@ -648,13 +635,14 @@ module Orb
         #   @return [String]
         required :minimum_amount, String
 
-        # @!parse
-        #   # @param applies_to_price_ids [Array<String>]
-        #   # @param minimum_amount [String]
-        #   #
-        #   def initialize(applies_to_price_ids:, minimum_amount:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(applies_to_price_ids:, minimum_amount:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Plan::Minimum} for more details.
+        #
+        #   @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
+        #   ...
+        #
+        #   @param minimum_amount [String] Minimum amount applied
       end
 
       class PlanPhase < Orb::Internal::Type::BaseModel
@@ -716,37 +704,32 @@ module Orb
         #   @return [Integer]
         required :order, Integer
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param description [String, nil]
-        #   # @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
-        #   # @param duration [Integer, nil]
-        #   # @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
-        #   # @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
-        #   # @param maximum_amount [String, nil]
-        #   # @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
-        #   # @param minimum_amount [String, nil]
-        #   # @param name [String]
-        #   # @param order [Integer]
-        #   #
-        #   def initialize(
-        #     id:,
-        #     description:,
-        #     discount:,
-        #     duration:,
-        #     duration_unit:,
-        #     maximum:,
-        #     maximum_amount:,
-        #     minimum:,
-        #     minimum_amount:,
-        #     name:,
-        #     order:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Plan::PlanPhase} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param description [String, nil]
+        #
+        #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+        #
+        #   @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this
+        #   ...
+        #
+        #   @param duration_unit [Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil]
+        #
+        #   @param maximum [Orb::Models::Plan::PlanPhase::Maximum, nil]
+        #
+        #   @param maximum_amount [String, nil]
+        #
+        #   @param minimum [Orb::Models::Plan::PlanPhase::Minimum, nil]
+        #
+        #   @param minimum_amount [String, nil]
+        #
+        #   @param name [String]
+        #
+        #   @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
 
         # @see Orb::Models::Plan::PlanPhase#duration_unit
         module DurationUnit
@@ -758,11 +741,8 @@ module Orb
           SEMI_ANNUAL = :semi_annual
           ANNUAL = :annual
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
 
         # @see Orb::Models::Plan::PlanPhase#maximum
@@ -780,13 +760,14 @@ module Orb
           #   @return [String]
           required :maximum_amount, String
 
-          # @!parse
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param maximum_amount [String]
-          #   #
-          #   def initialize(applies_to_price_ids:, maximum_amount:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(applies_to_price_ids:, maximum_amount:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Plan::PlanPhase::Maximum} for more details.
+          #
+          #   @param applies_to_price_ids [Array<String>] List of price_ids that this maximum amount applies to. For plan/plan phase maxim
+          #   ...
+          #
+          #   @param maximum_amount [String] Maximum amount applied
         end
 
         # @see Orb::Models::Plan::PlanPhase#minimum
@@ -804,13 +785,14 @@ module Orb
           #   @return [String]
           required :minimum_amount, String
 
-          # @!parse
-          #   # @param applies_to_price_ids [Array<String>]
-          #   # @param minimum_amount [String]
-          #   #
-          #   def initialize(applies_to_price_ids:, minimum_amount:, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(applies_to_price_ids:, minimum_amount:)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Plan::PlanPhase::Minimum} for more details.
+          #
+          #   @param applies_to_price_ids [Array<String>] List of price_ids that this minimum amount applies to. For plan/plan phase minim
+          #   ...
+          #
+          #   @param minimum_amount [String] Minimum amount applied
         end
       end
 
@@ -831,14 +813,10 @@ module Orb
         #   @return [String]
         required :name, String
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param created_at [Time]
-        #   # @param name [String]
-        #   #
-        #   def initialize(id:, created_at:, name:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, created_at:, name:)
+        #   @param id [String]
+        #   @param created_at [Time]
+        #   @param name [String]
       end
 
       # @see Orb::Models::Plan#status
@@ -849,11 +827,8 @@ module Orb
         ARCHIVED = :archived
         DRAFT = :draft
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # @see Orb::Models::Plan#trial_config
@@ -868,13 +843,9 @@ module Orb
         #   @return [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
         required :trial_period_unit, enum: -> { Orb::Models::Plan::TrialConfig::TrialPeriodUnit }
 
-        # @!parse
-        #   # @param trial_period [Integer, nil]
-        #   # @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
-        #   #
-        #   def initialize(trial_period:, trial_period_unit:, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(trial_period:, trial_period_unit:)
+        #   @param trial_period [Integer, nil]
+        #   @param trial_period_unit [Symbol, Orb::Models::Plan::TrialConfig::TrialPeriodUnit]
 
         # @see Orb::Models::Plan::TrialConfig#trial_period_unit
         module TrialPeriodUnit
@@ -882,11 +853,8 @@ module Orb
 
           DAYS = :days
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
     end