orb-billing 1.14.0 → 1.15.0

data/rbi/orb/models/invoice_level_discount.rbi

@@ -10,10 +10,307 @@ module Orb
           T.any(
             Orb::PercentageDiscount,
             Orb::AmountDiscount,
-            Orb::TrialDiscount
+            Orb::TrialDiscount,
+            Orb::InvoiceLevelDiscount::TieredPercentage
           )
         end
 
+      class TieredPercentage < Orb::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Orb::InvoiceLevelDiscount::TieredPercentage,
+              Orb::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Symbol) }
+        attr_accessor :discount_type
+
+        # Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+        # bands of cumulative eligible spend, each discounted at its own percentage
+        # (progressive fill-a-tier).
+        sig do
+          returns(T::Array[Orb::InvoiceLevelDiscount::TieredPercentage::Tier])
+        end
+        attr_accessor :tiers
+
+        # List of price_ids that this discount applies to. For plan/plan phase discounts,
+        # this can be a subset of prices.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :applies_to_price_ids
+
+        # The filters that determine which prices to apply this discount to.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Orb::InvoiceLevelDiscount::TieredPercentage::Filter]
+            )
+          )
+        end
+        attr_accessor :filters
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reason
+
+        sig do
+          params(
+            tiers:
+              T::Array[
+                Orb::InvoiceLevelDiscount::TieredPercentage::Tier::OrHash
+              ],
+            applies_to_price_ids: T.nilable(T::Array[String]),
+            filters:
+              T.nilable(
+                T::Array[
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::OrHash
+                ]
+              ),
+            reason: T.nilable(String),
+            discount_type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Only available if discount_type is `tiered_percentage`. The ordered, contiguous
+          # bands of cumulative eligible spend, each discounted at its own percentage
+          # (progressive fill-a-tier).
+          tiers:,
+          # List of price_ids that this discount applies to. For plan/plan phase discounts,
+          # this can be a subset of prices.
+          applies_to_price_ids: nil,
+          # The filters that determine which prices to apply this discount to.
+          filters: nil,
+          reason: nil,
+          discount_type: :tiered_percentage
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              discount_type: Symbol,
+              tiers:
+                T::Array[Orb::InvoiceLevelDiscount::TieredPercentage::Tier],
+              applies_to_price_ids: T.nilable(T::Array[String]),
+              filters:
+                T.nilable(
+                  T::Array[Orb::InvoiceLevelDiscount::TieredPercentage::Filter]
+                ),
+              reason: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Tier < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceLevelDiscount::TieredPercentage::Tier,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # Exclusive lower bound of cumulative spend for this tier.
+          sig { returns(Float) }
+          attr_accessor :lower_bound
+
+          # The percentage (between 0 and 1) discounted from spend that falls within this
+          # tier.
+          sig { returns(Float) }
+          attr_accessor :percentage
+
+          # Inclusive upper bound of cumulative spend for this tier; null for the final
+          # open-ended tier.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :upper_bound
+
+          # 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.
+          sig do
+            params(
+              lower_bound: Float,
+              percentage: Float,
+              upper_bound: T.nilable(Float)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Exclusive lower bound of cumulative spend for this tier.
+            lower_bound:,
+            # The percentage (between 0 and 1) discounted from spend that falls within this
+            # tier.
+            percentage:,
+            # Inclusive upper bound of cumulative spend for this tier; null for the final
+            # open-ended tier.
+            upper_bound: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                lower_bound: Float,
+                percentage: Float,
+                upper_bound: T.nilable(Float)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Filter < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          # The property of the price to filter on.
+          sig do
+            returns(
+              Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+            )
+          end
+          attr_accessor :field
+
+          # Should prices that match the filter be included or excluded.
+          sig do
+            returns(
+              Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol
+            )
+          end
+          attr_accessor :operator
+
+          # The IDs or values that match this filter.
+          sig { returns(T::Array[String]) }
+          attr_accessor :values
+
+          sig do
+            params(
+              field:
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::OrSymbol,
+              operator:
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::OrSymbol,
+              values: T::Array[String]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The property of the price to filter on.
+            field:,
+            # Should prices that match the filter be included or excluded.
+            operator:,
+            # The IDs or values that match this filter.
+            values:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                field:
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol,
+                operator:
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol,
+                values: T::Array[String]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The property of the price to filter on.
+          module Field
+            extend Orb::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PRICE_ID =
+              T.let(
+                :price_id,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            ITEM_ID =
+              T.let(
+                :item_id,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            PRICE_TYPE =
+              T.let(
+                :price_type,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            CURRENCY =
+              T.let(
+                :currency,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+            PRICING_UNIT_ID =
+              T.let(
+                :pricing_unit_id,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Field::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # Should prices that match the filter be included or excluded.
+          module Operator
+            extend Orb::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INCLUDES =
+              T.let(
+                :includes,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol
+              )
+            EXCLUDES =
+              T.let(
+                :excludes,
+                Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Orb::InvoiceLevelDiscount::TieredPercentage::Filter::Operator::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
       sig { override.returns(T::Array[Orb::InvoiceLevelDiscount::Variants]) }
       def self.variants
       end

data/rbi/orb/models/invoice_line_item_create_response.rbi

@@ -118,6 +118,7 @@ module Orb
                 Orb::MonetaryUsageDiscountAdjustment::OrHash,
                 Orb::MonetaryAmountDiscountAdjustment::OrHash,
                 Orb::MonetaryPercentageDiscountAdjustment::OrHash,
+                Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::OrHash,
                 Orb::MonetaryMinimumAdjustment::OrHash,
                 Orb::MonetaryMaximumAdjustment::OrHash
               )
@@ -145,6 +146,7 @@ module Orb
               Orb::Price::PackageWithAllocation::OrHash,
               Orb::Price::UnitWithPercent::OrHash,
               Orb::Price::MatrixWithAllocation::OrHash,
+              Orb::Price::MatrixWithThresholdDiscounts::OrHash,
               Orb::Price::TieredWithProration::OrHash,
               Orb::Price::UnitWithProration::OrHash,
               Orb::Price::GroupedAllocation::OrHash,
@@ -159,6 +161,8 @@ module Orb
               Orb::Price::ScalableMatrixWithTieredPricing::OrHash,
               Orb::Price::CumulativeGroupedBulk::OrHash,
               Orb::Price::CumulativeGroupedAllocation::OrHash,
+              Orb::Price::DailyCreditAllowance::OrHash,
+              Orb::Price::MeteredAllowance::OrHash,
               Orb::Price::MinimumComposite::OrHash,
               Orb::Price::Percent::OrHash,
               Orb::Price::EventOutput::OrHash
@@ -274,11 +278,346 @@ module Orb
               Orb::MonetaryUsageDiscountAdjustment,
               Orb::MonetaryAmountDiscountAdjustment,
               Orb::MonetaryPercentageDiscountAdjustment,
+              Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount,
               Orb::MonetaryMinimumAdjustment,
               Orb::MonetaryMaximumAdjustment
             )
           end
 
+        class TieredPercentageDiscount < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Symbol) }
+          attr_accessor :adjustment_type
+
+          # The value applied by an adjustment.
+          sig { returns(String) }
+          attr_accessor :amount
+
+          # The price IDs that this adjustment applies to.
+          sig { returns(T::Array[String]) }
+          attr_accessor :applies_to_price_ids
+
+          # The filters that determine which prices to apply this adjustment to.
+          sig do
+            returns(
+              T::Array[
+                Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter
+              ]
+            )
+          end
+          attr_accessor :filters
+
+          # True for adjustments that apply to an entire invoice, false for adjustments that
+          # apply to only one price.
+          sig { returns(T::Boolean) }
+          attr_accessor :is_invoice_level
+
+          # The reason for the adjustment.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :reason
+
+          # The adjustment id this adjustment replaces. This adjustment will take the place
+          # of the replaced adjustment in plan version migrations.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :replaces_adjustment_id
+
+          # 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.
+          sig do
+            returns(
+              T::Array[
+                Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier
+              ]
+            )
+          end
+          attr_accessor :tiers
+
+          sig do
+            params(
+              id: String,
+              amount: String,
+              applies_to_price_ids: T::Array[String],
+              filters:
+                T::Array[
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::OrHash
+                ],
+              is_invoice_level: T::Boolean,
+              reason: T.nilable(String),
+              replaces_adjustment_id: T.nilable(String),
+              tiers:
+                T::Array[
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier::OrHash
+                ],
+              adjustment_type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            # The value applied by an adjustment.
+            amount:,
+            # The price IDs that this adjustment applies to.
+            applies_to_price_ids:,
+            # The filters that determine which prices to apply this adjustment to.
+            filters:,
+            # True for adjustments that apply to an entire invoice, false for adjustments that
+            # apply to only one price.
+            is_invoice_level:,
+            # The reason for the adjustment.
+            reason:,
+            # The adjustment id this adjustment replaces. This adjustment will take the place
+            # of the replaced adjustment in plan version migrations.
+            replaces_adjustment_id:,
+            # 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.
+            tiers:,
+            adjustment_type: :tiered_percentage_discount
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                adjustment_type: Symbol,
+                amount: String,
+                applies_to_price_ids: T::Array[String],
+                filters:
+                  T::Array[
+                    Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter
+                  ],
+                is_invoice_level: T::Boolean,
+                reason: T.nilable(String),
+                replaces_adjustment_id: T.nilable(String),
+                tiers:
+                  T::Array[
+                    Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Filter < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # The property of the price to filter on.
+            sig do
+              returns(
+                Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+              )
+            end
+            attr_accessor :field
+
+            # Should prices that match the filter be included or excluded.
+            sig do
+              returns(
+                Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+              )
+            end
+            attr_accessor :operator
+
+            # The IDs or values that match this filter.
+            sig { returns(T::Array[String]) }
+            attr_accessor :values
+
+            sig do
+              params(
+                field:
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::OrSymbol,
+                operator:
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator::OrSymbol,
+                values: T::Array[String]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The property of the price to filter on.
+              field:,
+              # Should prices that match the filter be included or excluded.
+              operator:,
+              # The IDs or values that match this filter.
+              values:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  field:
+                    Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol,
+                  operator:
+                    Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol,
+                  values: T::Array[String]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The property of the price to filter on.
+            module Field
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PRICE_ID =
+                T.let(
+                  :price_id,
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              ITEM_ID =
+                T.let(
+                  :item_id,
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              PRICE_TYPE =
+                T.let(
+                  :price_type,
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              CURRENCY =
+                T.let(
+                  :currency,
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              PRICING_UNIT_ID =
+                T.let(
+                  :pricing_unit_id,
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # Should prices that match the filter be included or excluded.
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              INCLUDES =
+                T.let(
+                  :includes,
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+                )
+              EXCLUDES =
+                T.let(
+                  :excludes,
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class Tier < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # Exclusive lower bound of cumulative spend for this tier.
+            sig { returns(Float) }
+            attr_accessor :lower_bound
+
+            # The percentage (between 0 and 1) discounted from spend that falls within this
+            # tier.
+            sig { returns(Float) }
+            attr_accessor :percentage
+
+            # Inclusive upper bound of cumulative spend for this tier; null for the final
+            # open-ended tier.
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :upper_bound
+
+            # 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.
+            sig do
+              params(
+                lower_bound: Float,
+                percentage: Float,
+                upper_bound: T.nilable(Float)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Exclusive lower bound of cumulative spend for this tier.
+              lower_bound:,
+              # The percentage (between 0 and 1) discounted from spend that falls within this
+              # tier.
+              percentage:,
+              # Inclusive upper bound of cumulative spend for this tier; null for the final
+              # open-ended tier.
+              upper_bound: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  lower_bound: Float,
+                  percentage: Float,
+                  upper_bound: T.nilable(Float)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
         sig do
           override.returns(
             T::Array[