orb-billing 1.13.0 → 1.15.0

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::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>]
+      #   @return [Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>]
       required :adjustments, -> { Orb::Internal::Type::ArrayOf[union: Orb::Plan::Adjustment] }
 
       # @!attribute base_plan
@@ -63,7 +63,7 @@ module Orb
       # @!attribute discount
       #   @deprecated
       #
-      #   @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+      #   @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil]
       required :discount, union: -> { Orb::Discount }, nil?: true
 
       # @!attribute external_plan_id
@@ -138,7 +138,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::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>]
+      #   @return [Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>]
       required :prices, -> { Orb::Internal::Type::ArrayOf[union: Orb::Price] }
 
       # @!attribute product
@@ -172,7 +172,7 @@ module Orb
       #
       #   @param id [String]
       #
-      #   @param adjustments [Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
+      #   @param adjustments [Array<Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment>] Adjustments for this plan. If the plan has phases, this includes adjustments acr
       #
       #   @param base_plan [Orb::Models::Plan::BasePlan, nil] Legacy field representing the parent plan if the current plan is a 'child plan',
       #
@@ -186,7 +186,7 @@ module Orb
       #
       #   @param description [String]
       #
-      #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+      #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil]
       #
       #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
       #
@@ -208,7 +208,7 @@ module Orb
       #
       #   @param plan_phases [Array<Orb::Models::Plan::PlanPhase>, nil]
       #
-      #   @param prices [Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, 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::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>] Prices for this plan. If the plan has phases, this includes prices across all ph
+      #   @param prices [Array<Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput>] Prices for this plan. If the plan has phases, this includes prices across all ph
       #
       #   @param product [Orb::Models::Plan::Product]
       #
@@ -229,12 +229,192 @@ module Orb
 
         variant :percentage_discount, -> { Orb::PlanPhasePercentageDiscountAdjustment }
 
+        variant :tiered_percentage_discount, -> { Orb::Plan::Adjustment::TieredPercentageDiscount }
+
         variant :minimum, -> { Orb::PlanPhaseMinimumAdjustment }
 
         variant :maximum, -> { Orb::PlanPhaseMaximumAdjustment }
 
+        class TieredPercentageDiscount < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute adjustment_type
+          #
+          #   @return [Symbol, :tiered_percentage_discount]
+          required :adjustment_type, const: :tiered_percentage_discount
+
+          # @!attribute applies_to_price_ids
+          #   @deprecated
+          #
+          #   The price IDs that this adjustment applies to.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+          # @!attribute filters
+          #   The filters that determine which prices to apply this adjustment to.
+          #
+          #   @return [Array<Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Filter>]
+          required :filters,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Plan::Adjustment::TieredPercentageDiscount::Filter] }
+
+          # @!attribute is_invoice_level
+          #   True for adjustments that apply to an entire invoice, false for adjustments that
+          #   apply to only one price.
+          #
+          #   @return [Boolean]
+          required :is_invoice_level, Orb::Internal::Type::Boolean
+
+          # @!attribute plan_phase_order
+          #   The plan phase in which this adjustment is active.
+          #
+          #   @return [Integer, nil]
+          required :plan_phase_order, Integer, nil?: true
+
+          # @!attribute reason
+          #   The reason for the adjustment.
+          #
+          #   @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 tiers
+          #   The ordered, contiguous bands of cumulative eligible spend, each discounted at
+          #   its own percentage (progressive fill-a-tier), applied to the prices this
+          #   adjustment covers in a given billing period.
+          #
+          #   @return [Array<Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Tier>]
+          required :tiers,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Plan::Adjustment::TieredPercentageDiscount::Tier] }
+
+          # @!method initialize(id:, applies_to_price_ids:, filters:, is_invoice_level:, plan_phase_order:, reason:, replaces_adjustment_id:, tiers:, adjustment_type: :tiered_percentage_discount)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Plan::Adjustment::TieredPercentageDiscount} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+          #
+          #   @param filters [Array<Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
+          #
+          #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invoice, false for adjustments that
+          #
+          #   @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
+          #
+          #   @param tiers [Array<Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Tier>] The ordered, contiguous bands of cumulative eligible spend, each discounted at i
+          #
+          #   @param adjustment_type [Symbol, :tiered_percentage_discount]
+
+          class Filter < Orb::Internal::Type::BaseModel
+            # @!attribute field
+            #   The property of the price to filter on.
+            #
+            #   @return [Symbol, Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Filter::Field]
+            required :field, enum: -> { Orb::Plan::Adjustment::TieredPercentageDiscount::Filter::Field }
+
+            # @!attribute operator
+            #   Should prices that match the filter be included or excluded.
+            #
+            #   @return [Symbol, Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Filter::Operator]
+            required :operator, enum: -> { Orb::Plan::Adjustment::TieredPercentageDiscount::Filter::Operator }
+
+            # @!attribute values
+            #   The IDs or values that match this filter.
+            #
+            #   @return [Array<String>]
+            required :values, Orb::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(field:, operator:, values:)
+            #   @param field [Symbol, Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Filter::Field] The property of the price to filter on.
+            #
+            #   @param operator [Symbol, Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
+            #
+            #   @param values [Array<String>] The IDs or values that match this filter.
+
+            # The property of the price to filter on.
+            #
+            # @see Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Filter#field
+            module Field
+              extend Orb::Internal::Type::Enum
+
+              PRICE_ID = :price_id
+              ITEM_ID = :item_id
+              PRICE_TYPE = :price_type
+              CURRENCY = :currency
+              PRICING_UNIT_ID = :pricing_unit_id
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Should prices that match the filter be included or excluded.
+            #
+            # @see Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Filter#operator
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES = :includes
+              EXCLUDES = :excludes
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Tier < Orb::Internal::Type::BaseModel
+            # @!attribute lower_bound
+            #   Exclusive lower bound of cumulative spend for this tier.
+            #
+            #   @return [Float]
+            required :lower_bound, Float
+
+            # @!attribute percentage
+            #   The percentage (between 0 and 1) discounted from spend that falls within this
+            #   tier.
+            #
+            #   @return [Float]
+            required :percentage, Float
+
+            # @!attribute upper_bound
+            #   Inclusive upper bound of cumulative spend for this tier; null for the final
+            #   open-ended tier.
+            #
+            #   @return [Float, nil]
+            optional :upper_bound, Float, nil?: true
+
+            # @!method initialize(lower_bound:, percentage:, upper_bound: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Plan::Adjustment::TieredPercentageDiscount::Tier} for more
+            #   details.
+            #
+            #   One band of a tiered percentage discount. Bounds are denominated in the
+            #   discount's currency. `lower_bound` is the exclusive start of the band and
+            #   `upper_bound` is the inclusive end; `upper_bound` is null only for the
+            #   open-ended final tier.
+            #
+            #   @param lower_bound [Float] Exclusive lower bound of cumulative spend for this tier.
+            #
+            #   @param percentage [Float] The percentage (between 0 and 1) discounted from spend that falls within this ti
+            #
+            #   @param upper_bound [Float, nil] Inclusive upper bound of cumulative spend for this tier; null for the final open
+          end
+        end
+
         # @!method self.variants
-        #   @return [Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)]
+        #   @return [Array(Orb::Models::PlanPhaseUsageDiscountAdjustment, Orb::Models::PlanPhaseAmountDiscountAdjustment, Orb::Models::PlanPhasePercentageDiscountAdjustment, Orb::Models::Plan::Adjustment::TieredPercentageDiscount, Orb::Models::PlanPhaseMinimumAdjustment, Orb::Models::PlanPhaseMaximumAdjustment)]
       end
 
       # @deprecated
@@ -286,7 +466,7 @@ module Orb
 
         # @!attribute discount
         #
-        #   @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+        #   @return [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil]
         required :discount, union: -> { Orb::Discount }, nil?: true
 
         # @!attribute duration
@@ -340,7 +520,7 @@ module Orb
         #
         #   @param description [String, nil]
         #
-        #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil]
+        #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil]
         #
         #   @param duration [Integer, nil] How many terms of length `duration_unit` this phase is active for. If null, this
         #