orb-billing 1.0.1 → 1.2.0

data/lib/orb/models/plan_create_params.rb

@@ -23,8 +23,19 @@ module Orb
       #   Prices for this plan. If the plan has phases, this includes prices across all
       #   phases of the plan.
       #
-      #   @return [Array<Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice>]
-      required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::PlanCreateParams::Price] }
+      #   @return [Array<Orb::Models::PlanCreateParams::Price>]
+      required :prices, -> { Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price] }
+
+      # @!attribute adjustments
+      #   Adjustments for this plan. If the plan has phases, this includes adjustments
+      #   across all phases of the plan.
+      #
+      #   @return [Array<Orb::Models::PlanCreateParams::Adjustment>, nil]
+      optional :adjustments,
+               -> {
+                 Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Adjustment]
+               },
+               nil?: true
 
       # @!attribute default_invoice_memo
       #   Free-form text which is available on the invoice PDF and the Orb invoice portal.
@@ -53,6 +64,13 @@ module Orb
       #   @return [Integer, nil]
       optional :net_terms, Integer, nil?: true
 
+      # @!attribute plan_phases
+      #   Configuration of pre-defined phases, each with their own prices and adjustments.
+      #   Leave unspecified for plans with a single phase.
+      #
+      #   @return [Array<Orb::Models::PlanCreateParams::PlanPhase>, nil]
+      optional :plan_phases, -> { Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::PlanPhase] }, nil?: true
+
       # @!attribute status
       #   The status of the plan to create (either active or draft). If not specified,
       #   this defaults to active.
@@ -60,7 +78,7 @@ module Orb
       #   @return [Symbol, Orb::Models::PlanCreateParams::Status, nil]
       optional :status, enum: -> { Orb::PlanCreateParams::Status }
 
-      # @!method initialize(currency:, name:, prices:, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, status: nil, request_options: {})
+      # @!method initialize(currency:, name:, prices:, adjustments: nil, default_invoice_memo: nil, external_plan_id: nil, metadata: nil, net_terms: nil, plan_phases: nil, status: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanCreateParams} for more details.
       #
@@ -68,7 +86,9 @@ module Orb
       #
       #   @param name [String]
       #
-      #   @param prices [Array<Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      #   @param prices [Array<Orb::Models::PlanCreateParams::Price>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      #
+      #   @param adjustments [Array<Orb::Models::PlanCreateParams::Adjustment>, nil] Adjustments for this plan. If the plan has phases, this includes adjustments acr
       #
       #   @param default_invoice_memo [String, nil] Free-form text which is available on the invoice PDF and the Orb invoice portal.
       #
@@ -78,73 +98,201 @@ module Orb
       #
       #   @param net_terms [Integer, nil] The net terms determines the difference between the invoice date and the issue d
       #
+      #   @param plan_phases [Array<Orb::Models::PlanCreateParams::PlanPhase>, nil] Configuration of pre-defined phases, each with their own prices and adjustments.
+      #
       #   @param status [Symbol, Orb::Models::PlanCreateParams::Status] The status of the plan to create (either active or draft). If not specified, thi
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
-      module Price
-        extend Orb::Internal::Type::Union
+      class Price < Orb::Internal::Type::BaseModel
+        # @!attribute allocation_price
+        #   The allocation price to add to the plan.
+        #
+        #   @return [Orb::Models::NewAllocationPrice, nil]
+        optional :allocation_price, -> { Orb::NewAllocationPrice }, nil?: true
+
+        # @!attribute plan_phase_order
+        #   The phase to add this price to.
+        #
+        #   @return [Integer, nil]
+        optional :plan_phase_order, Integer, nil?: true
+
+        # @!attribute price
+        #   The price to add to the plan
+        #
+        #   @return [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice, nil]
+        optional :price, union: -> { Orb::PlanCreateParams::Price::Price }, nil?: true
+
+        # @!method initialize(allocation_price: nil, plan_phase_order: nil, price: nil)
+        #   @param allocation_price [Orb::Models::NewAllocationPrice, nil] The allocation price to add to the plan.
+        #
+        #   @param plan_phase_order [Integer, nil] The phase to add this price to.
+        #
+        #   @param price [Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice, nil] The price to add to the plan
+
+        # The price to add to the plan
+        #
+        # @see Orb::Models::PlanCreateParams::Price#price
+        module Price
+          extend Orb::Internal::Type::Union
+
+          discriminator :model_type
+
+          variant :unit, -> { Orb::NewPlanUnitPrice }
 
-        discriminator :model_type
+          variant :package, -> { Orb::NewPlanPackagePrice }
 
-        variant :unit, -> { Orb::NewPlanUnitPrice }
+          variant :matrix, -> { Orb::NewPlanMatrixPrice }
 
-        variant :package, -> { Orb::NewPlanPackagePrice }
+          variant :tiered, -> { Orb::NewPlanTieredPrice }
 
-        variant :matrix, -> { Orb::NewPlanMatrixPrice }
+          variant :tiered_bps, -> { Orb::NewPlanTieredBPSPrice }
 
-        variant :tiered, -> { Orb::NewPlanTieredPrice }
+          variant :bps, -> { Orb::NewPlanBPSPrice }
 
-        variant :tiered_bps, -> { Orb::NewPlanTieredBPSPrice }
+          variant :bulk_bps, -> { Orb::NewPlanBulkBPSPrice }
 
-        variant :bps, -> { Orb::NewPlanBPSPrice }
+          variant :bulk, -> { Orb::NewPlanBulkPrice }
 
-        variant :bulk_bps, -> { Orb::NewPlanBulkBPSPrice }
+          variant :threshold_total_amount, -> { Orb::NewPlanThresholdTotalAmountPrice }
 
-        variant :bulk, -> { Orb::NewPlanBulkPrice }
+          variant :tiered_package, -> { Orb::NewPlanTieredPackagePrice }
 
-        variant :threshold_total_amount, -> { Orb::NewPlanThresholdTotalAmountPrice }
+          variant :tiered_with_minimum, -> { Orb::NewPlanTieredWithMinimumPrice }
 
-        variant :tiered_package, -> { Orb::NewPlanTieredPackagePrice }
+          variant :unit_with_percent, -> { Orb::NewPlanUnitWithPercentPrice }
 
-        variant :tiered_with_minimum, -> { Orb::NewPlanTieredWithMinimumPrice }
+          variant :package_with_allocation, -> { Orb::NewPlanPackageWithAllocationPrice }
 
-        variant :unit_with_percent, -> { Orb::NewPlanUnitWithPercentPrice }
+          variant :tiered_with_proration, -> { Orb::NewPlanTierWithProrationPrice }
 
-        variant :package_with_allocation, -> { Orb::NewPlanPackageWithAllocationPrice }
+          variant :unit_with_proration, -> { Orb::NewPlanUnitWithProrationPrice }
 
-        variant :tiered_with_proration, -> { Orb::NewPlanTierWithProrationPrice }
+          variant :grouped_allocation, -> { Orb::NewPlanGroupedAllocationPrice }
 
-        variant :unit_with_proration, -> { Orb::NewPlanUnitWithProrationPrice }
+          variant :grouped_with_prorated_minimum, -> { Orb::NewPlanGroupedWithProratedMinimumPrice }
 
-        variant :grouped_allocation, -> { Orb::NewPlanGroupedAllocationPrice }
+          variant :grouped_with_metered_minimum, -> { Orb::NewPlanGroupedWithMeteredMinimumPrice }
 
-        variant :grouped_with_prorated_minimum, -> { Orb::NewPlanGroupedWithProratedMinimumPrice }
+          variant :matrix_with_display_name, -> { Orb::NewPlanMatrixWithDisplayNamePrice }
 
-        variant :grouped_with_metered_minimum, -> { Orb::NewPlanGroupedWithMeteredMinimumPrice }
+          variant :bulk_with_proration, -> { Orb::NewPlanBulkWithProrationPrice }
 
-        variant :matrix_with_display_name, -> { Orb::NewPlanMatrixWithDisplayNamePrice }
+          variant :grouped_tiered_package, -> { Orb::NewPlanGroupedTieredPackagePrice }
 
-        variant :bulk_with_proration, -> { Orb::NewPlanBulkWithProrationPrice }
+          variant :max_group_tiered_package, -> { Orb::NewPlanMaxGroupTieredPackagePrice }
 
-        variant :grouped_tiered_package, -> { Orb::NewPlanGroupedTieredPackagePrice }
+          variant :scalable_matrix_with_unit_pricing, -> { Orb::NewPlanScalableMatrixWithUnitPricingPrice }
 
-        variant :max_group_tiered_package, -> { Orb::NewPlanMaxGroupTieredPackagePrice }
+          variant :scalable_matrix_with_tiered_pricing,
+                  -> {
+                    Orb::NewPlanScalableMatrixWithTieredPricingPrice
+                  }
 
-        variant :scalable_matrix_with_unit_pricing, -> { Orb::NewPlanScalableMatrixWithUnitPricingPrice }
+          variant :cumulative_grouped_bulk, -> { Orb::NewPlanCumulativeGroupedBulkPrice }
 
-        variant :scalable_matrix_with_tiered_pricing, -> { Orb::NewPlanScalableMatrixWithTieredPricingPrice }
+          variant :tiered_package_with_minimum, -> { Orb::NewPlanTieredPackageWithMinimumPrice }
 
-        variant :cumulative_grouped_bulk, -> { Orb::NewPlanCumulativeGroupedBulkPrice }
+          variant :matrix_with_allocation, -> { Orb::NewPlanMatrixWithAllocationPrice }
 
-        variant :tiered_package_with_minimum, -> { Orb::NewPlanTieredPackageWithMinimumPrice }
+          variant :grouped_tiered, -> { Orb::NewPlanGroupedTieredPrice }
 
-        variant :matrix_with_allocation, -> { Orb::NewPlanMatrixWithAllocationPrice }
+          # @!method self.variants
+          #   @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice)]
+        end
+      end
+
+      class Adjustment < Orb::Internal::Type::BaseModel
+        # @!attribute adjustment
+        #   The definition of a new adjustment to create and add to the plan.
+        #
+        #   @return [Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum]
+        required :adjustment, union: -> { Orb::PlanCreateParams::Adjustment::Adjustment }
+
+        # @!attribute plan_phase_order
+        #   The phase to add this adjustment to.
+        #
+        #   @return [Integer, nil]
+        optional :plan_phase_order, Integer, nil?: true
+
+        # @!method initialize(adjustment:, plan_phase_order: nil)
+        #   @param adjustment [Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum] The definition of a new adjustment to create and add to the plan.
+        #
+        #   @param plan_phase_order [Integer, nil] The phase to add this adjustment to.
+
+        # The definition of a new adjustment to create and add to the plan.
+        #
+        # @see Orb::Models::PlanCreateParams::Adjustment#adjustment
+        module Adjustment
+          extend Orb::Internal::Type::Union
+
+          discriminator :adjustment_type
 
-        variant :grouped_tiered, -> { Orb::NewPlanGroupedTieredPrice }
+          variant :percentage_discount, -> { Orb::NewPercentageDiscount }
+
+          variant :usage_discount, -> { Orb::NewUsageDiscount }
+
+          variant :amount_discount, -> { Orb::NewAmountDiscount }
+
+          variant :minimum, -> { Orb::NewMinimum }
+
+          variant :maximum, -> { Orb::NewMaximum }
+
+          # @!method self.variants
+          #   @return [Array(Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum)]
+        end
+      end
 
-        # @!method self.variants
-        #   @return [Array(Orb::Models::NewPlanUnitPrice, Orb::Models::NewPlanPackagePrice, Orb::Models::NewPlanMatrixPrice, Orb::Models::NewPlanTieredPrice, Orb::Models::NewPlanTieredBPSPrice, Orb::Models::NewPlanBPSPrice, Orb::Models::NewPlanBulkBPSPrice, Orb::Models::NewPlanBulkPrice, Orb::Models::NewPlanThresholdTotalAmountPrice, Orb::Models::NewPlanTieredPackagePrice, Orb::Models::NewPlanTieredWithMinimumPrice, Orb::Models::NewPlanUnitWithPercentPrice, Orb::Models::NewPlanPackageWithAllocationPrice, Orb::Models::NewPlanTierWithProrationPrice, Orb::Models::NewPlanUnitWithProrationPrice, Orb::Models::NewPlanGroupedAllocationPrice, Orb::Models::NewPlanGroupedWithProratedMinimumPrice, Orb::Models::NewPlanGroupedWithMeteredMinimumPrice, Orb::Models::NewPlanMatrixWithDisplayNamePrice, Orb::Models::NewPlanBulkWithProrationPrice, Orb::Models::NewPlanGroupedTieredPackagePrice, Orb::Models::NewPlanMaxGroupTieredPackagePrice, Orb::Models::NewPlanScalableMatrixWithUnitPricingPrice, Orb::Models::NewPlanScalableMatrixWithTieredPricingPrice, Orb::Models::NewPlanCumulativeGroupedBulkPrice, Orb::Models::NewPlanTieredPackageWithMinimumPrice, Orb::Models::NewPlanMatrixWithAllocationPrice, Orb::Models::NewPlanGroupedTieredPrice)]
+      class PlanPhase < Orb::Internal::Type::BaseModel
+        # @!attribute order
+        #   Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
+        #
+        #   @return [Integer]
+        required :order, Integer
+
+        # @!attribute align_billing_with_phase_start_date
+        #   Align billing cycle day with phase start date.
+        #
+        #   @return [Boolean, nil]
+        optional :align_billing_with_phase_start_date, Orb::Internal::Type::Boolean, nil?: true
+
+        # @!attribute duration
+        #   How many terms of length `duration_unit` this phase is active for. If null, this
+        #   phase is evergreen and active indefinitely
+        #
+        #   @return [Integer, nil]
+        optional :duration, Integer, nil?: true
+
+        # @!attribute duration_unit
+        #
+        #   @return [Symbol, Orb::Models::PlanCreateParams::PlanPhase::DurationUnit, nil]
+        optional :duration_unit, enum: -> { Orb::PlanCreateParams::PlanPhase::DurationUnit }, nil?: true
+
+        # @!method initialize(order:, align_billing_with_phase_start_date: nil, duration: nil, duration_unit: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::PlanCreateParams::PlanPhase} for more details.
+        #
+        #   @param order [Integer] Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.
+        #
+        #   @param align_billing_with_phase_start_date [Boolean, nil] Align billing cycle day with phase start date.
+        #
+        #   @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::PlanCreateParams::PlanPhase::DurationUnit, nil]
+
+        # @see Orb::Models::PlanCreateParams::PlanPhase#duration_unit
+        module DurationUnit
+          extend Orb::Internal::Type::Enum
+
+          DAILY = :daily
+          MONTHLY = :monthly
+          QUARTERLY = :quarterly
+          SEMI_ANNUAL = :semi_annual
+          ANNUAL = :annual
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
 
       # The status of the plan to create (either active or draft). If not specified,

data/lib/orb/models/plan_phase_amount_discount_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, amount_discount:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhaseAmountDiscountAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @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 replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::PlanPhaseAmountDiscountAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/plan_phase_maximum_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, maximum_amount:, plan_phase_order:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhaseMaximumAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @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 replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::PlanPhaseMaximumAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/plan_phase_minimum_adjustment.rb

@@ -59,7 +59,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, item_id:, minimum_amount:, plan_phase_order:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhaseMinimumAdjustment} for more details.
       #
@@ -80,6 +87,8 @@ module Orb
       #   @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 replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::PlanPhaseMinimumAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/plan_phase_percentage_discount_adjustment.rb

@@ -53,7 +53,14 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
-      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:)
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
+      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, percentage_discount:, plan_phase_order:, reason:, replaces_adjustment_id:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhasePercentageDiscountAdjustment} for more details.
       #
@@ -72,6 +79,8 @@ module Orb
       #   @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 replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
 
       # @see Orb::Models::PlanPhasePercentageDiscountAdjustment#adjustment_type
       module AdjustmentType

data/lib/orb/models/plan_phase_usage_discount_adjustment.rb

@@ -46,6 +46,13 @@ module Orb
       #   @return [String, nil]
       required :reason, String, nil?: true
 
+      # @!attribute replaces_adjustment_id
+      #   The adjustment id this adjustment replaces. This adjustment will take the place
+      #   of the replaced adjustment in plan version migrations.
+      #
+      #   @return [String, nil]
+      required :replaces_adjustment_id, String, nil?: true
+
       # @!attribute usage_discount
       #   The number of usage units by which to discount the price this adjustment applies
       #   to in a given billing period.
@@ -53,7 +60,7 @@ module Orb
       #   @return [Float]
       required :usage_discount, Float
 
-      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, usage_discount:)
+      # @!method initialize(id:, adjustment_type:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, replaces_adjustment_id:, usage_discount:)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PlanPhaseUsageDiscountAdjustment} for more details.
       #
@@ -71,6 +78,8 @@ module Orb
       #
       #   @param reason [String, nil] The reason for the adjustment.
       #
+      #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
+      #
       #   @param usage_discount [Float] The number of usage units by which to discount the price this adjustment applies
 
       # @see Orb::Models::PlanPhaseUsageDiscountAdjustment#adjustment_type