orb-billing 1.14.0 → 1.15.0

data/rbi/orb/models/plan_update_params.rbi

@@ -12,6 +12,10 @@ module Orb
       sig { returns(String) }
       attr_accessor :plan_id
 
+      # An optional user-defined description of the plan.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
       # An optional user-defined ID for this plan resource, used throughout the system
       # as an alias for this Plan. Use this field to identify a plan by an existing
       # identifier in your system.
@@ -27,6 +31,7 @@ module Orb
       sig do
         params(
           plan_id: String,
+          description: T.nilable(String),
           external_plan_id: T.nilable(String),
           metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
           request_options: Orb::RequestOptions::OrHash
@@ -34,6 +39,8 @@ module Orb
       end
       def self.new(
         plan_id:,
+        # An optional user-defined description of the plan.
+        description: nil,
         # An optional user-defined ID for this plan resource, used throughout the system
         # as an alias for this Plan. Use this field to identify a plan by an existing
         # identifier in your system.
@@ -50,6 +57,7 @@ module Orb
         override.returns(
           {
             plan_id: String,
+            description: T.nilable(String),
             external_plan_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
             request_options: Orb::RequestOptions

data/rbi/orb/models/plan_version.rbi

@@ -34,6 +34,7 @@ module Orb
                 Orb::PlanPhaseUsageDiscountAdjustment::OrHash,
                 Orb::PlanPhaseAmountDiscountAdjustment::OrHash,
                 Orb::PlanPhasePercentageDiscountAdjustment::OrHash,
+                Orb::PlanVersion::Adjustment::TieredPercentageDiscount::OrHash,
                 Orb::PlanPhaseMinimumAdjustment::OrHash,
                 Orb::PlanPhaseMaximumAdjustment::OrHash
               )
@@ -57,6 +58,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,
@@ -71,6 +73,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
@@ -115,11 +119,346 @@ module Orb
               Orb::PlanPhaseUsageDiscountAdjustment,
               Orb::PlanPhaseAmountDiscountAdjustment,
               Orb::PlanPhasePercentageDiscountAdjustment,
+              Orb::PlanVersion::Adjustment::TieredPercentageDiscount,
               Orb::PlanPhaseMinimumAdjustment,
               Orb::PlanPhaseMaximumAdjustment
             )
           end
 
+        class TieredPercentageDiscount < Orb::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Orb::PlanVersion::Adjustment::TieredPercentageDiscount,
+                Orb::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(Symbol) }
+          attr_accessor :adjustment_type
+
+          # 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::PlanVersion::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 plan phase in which this adjustment is active.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :plan_phase_order
+
+          # 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::PlanVersion::Adjustment::TieredPercentageDiscount::Tier
+              ]
+            )
+          end
+          attr_accessor :tiers
+
+          sig do
+            params(
+              id: String,
+              applies_to_price_ids: T::Array[String],
+              filters:
+                T::Array[
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::OrHash
+                ],
+              is_invoice_level: T::Boolean,
+              plan_phase_order: T.nilable(Integer),
+              reason: T.nilable(String),
+              replaces_adjustment_id: T.nilable(String),
+              tiers:
+                T::Array[
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Tier::OrHash
+                ],
+              adjustment_type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            # 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 plan phase in which this adjustment is active.
+            plan_phase_order:,
+            # 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,
+                applies_to_price_ids: T::Array[String],
+                filters:
+                  T::Array[
+                    Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter
+                  ],
+                is_invoice_level: T::Boolean,
+                plan_phase_order: T.nilable(Integer),
+                reason: T.nilable(String),
+                replaces_adjustment_id: T.nilable(String),
+                tiers:
+                  T::Array[
+                    Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Tier
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Filter < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # The property of the price to filter on.
+            sig do
+              returns(
+                Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+              )
+            end
+            attr_accessor :field
+
+            # Should prices that match the filter be included or excluded.
+            sig do
+              returns(
+                Orb::PlanVersion::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::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field::OrSymbol,
+                operator:
+                  Orb::PlanVersion::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::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol,
+                  operator:
+                    Orb::PlanVersion::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::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PRICE_ID =
+                T.let(
+                  :price_id,
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              ITEM_ID =
+                T.let(
+                  :item_id,
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              PRICE_TYPE =
+                T.let(
+                  :price_type,
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              CURRENCY =
+                T.let(
+                  :currency,
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+              PRICING_UNIT_ID =
+                T.let(
+                  :pricing_unit_id,
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Field::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::PlanVersion::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::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Operator
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              INCLUDES =
+                T.let(
+                  :includes,
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+                )
+              EXCLUDES =
+                T.let(
+                  :excludes,
+                  Orb::PlanVersion::Adjustment::TieredPercentageDiscount::Filter::Operator::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::PlanVersion::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::PlanVersion::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[Orb::PlanVersion::Adjustment::Variants])
         end

data/rbi/orb/models/plans/external_plan_id_update_params.rbi

@@ -18,6 +18,10 @@ module Orb
         sig { returns(String) }
         attr_accessor :other_external_plan_id
 
+        # An optional user-defined description of the plan.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
         # An optional user-defined ID for this plan resource, used throughout the system
         # as an alias for this Plan. Use this field to identify a plan by an existing
         # identifier in your system.
@@ -33,6 +37,7 @@ module Orb
         sig do
           params(
             other_external_plan_id: String,
+            description: T.nilable(String),
             external_plan_id: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
             request_options: Orb::RequestOptions::OrHash
@@ -40,6 +45,8 @@ module Orb
         end
         def self.new(
           other_external_plan_id:,
+          # An optional user-defined description of the plan.
+          description: nil,
           # An optional user-defined ID for this plan resource, used throughout the system
           # as an alias for this Plan. Use this field to identify a plan by an existing
           # identifier in your system.
@@ -56,6 +63,7 @@ module Orb
           override.returns(
             {
               other_external_plan_id: String,
+              description: T.nilable(String),
               external_plan_id: T.nilable(String),
               metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
               request_options: Orb::RequestOptions

data/rbi/orb/models/plans/migration_cancel_response.rbi

@@ -12,9 +12,12 @@ module Orb
             )
           end
 
+        # Unique identifier for this plan version change.
         sig { returns(String) }
         attr_accessor :id
 
+        # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+        # when scheduled to be at the end of the current billing period.
         sig do
           returns(
             T.nilable(
@@ -24,9 +27,12 @@ module Orb
         end
         attr_accessor :effective_time
 
+        # The ID of the plan being migrated.
         sig { returns(String) }
         attr_accessor :plan_id
 
+        # Current status of the migration: 'not_started', 'in_progress', 'completed',
+        # 'action_needed', or 'canceled'.
         sig do
           returns(
             Orb::Models::Plans::MigrationCancelResponse::Status::TaggedSymbol
@@ -50,7 +56,18 @@ module Orb
               Orb::Models::Plans::MigrationCancelResponse::Status::OrSymbol
           ).returns(T.attached_class)
         end
-        def self.new(id:, effective_time:, plan_id:, status:)
+        def self.new(
+          # Unique identifier for this plan version change.
+          id:,
+          # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+          # when scheduled to be at the end of the current billing period.
+          effective_time:,
+          # The ID of the plan being migrated.
+          plan_id:,
+          # Current status of the migration: 'not_started', 'in_progress', 'completed',
+          # 'action_needed', or 'canceled'.
+          status:
+        )
         end
 
         sig do
@@ -70,6 +87,8 @@ module Orb
         def to_hash
         end
 
+        # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+        # when scheduled to be at the end of the current billing period.
         module EffectiveTime
           extend Orb::Internal::Type::Union
 
@@ -108,6 +127,8 @@ module Orb
             )
         end
 
+        # Current status of the migration: 'not_started', 'in_progress', 'completed',
+        # 'action_needed', or 'canceled'.
         module Status
           extend Orb::Internal::Type::Enum
 

data/rbi/orb/models/plans/migration_list_response.rbi

@@ -12,9 +12,12 @@ module Orb
             )
           end
 
+        # Unique identifier for this plan version change.
         sig { returns(String) }
         attr_accessor :id
 
+        # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+        # when scheduled to be at the end of the current billing period.
         sig do
           returns(
             T.nilable(
@@ -24,9 +27,12 @@ module Orb
         end
         attr_accessor :effective_time
 
+        # The ID of the plan being migrated.
         sig { returns(String) }
         attr_accessor :plan_id
 
+        # Current status of the migration: 'not_started', 'in_progress', 'completed',
+        # 'action_needed', or 'canceled'.
         sig do
           returns(
             Orb::Models::Plans::MigrationListResponse::Status::TaggedSymbol
@@ -49,7 +55,18 @@ module Orb
             status: Orb::Models::Plans::MigrationListResponse::Status::OrSymbol
           ).returns(T.attached_class)
         end
-        def self.new(id:, effective_time:, plan_id:, status:)
+        def self.new(
+          # Unique identifier for this plan version change.
+          id:,
+          # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+          # when scheduled to be at the end of the current billing period.
+          effective_time:,
+          # The ID of the plan being migrated.
+          plan_id:,
+          # Current status of the migration: 'not_started', 'in_progress', 'completed',
+          # 'action_needed', or 'canceled'.
+          status:
+        )
         end
 
         sig do
@@ -69,6 +86,8 @@ module Orb
         def to_hash
         end
 
+        # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+        # when scheduled to be at the end of the current billing period.
         module EffectiveTime
           extend Orb::Internal::Type::Union
 
@@ -107,6 +126,8 @@ module Orb
             )
         end
 
+        # Current status of the migration: 'not_started', 'in_progress', 'completed',
+        # 'action_needed', or 'canceled'.
         module Status
           extend Orb::Internal::Type::Enum
 

data/rbi/orb/models/plans/migration_retrieve_response.rbi

@@ -12,9 +12,12 @@ module Orb
             )
           end
 
+        # Unique identifier for this plan version change.
         sig { returns(String) }
         attr_accessor :id
 
+        # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+        # when scheduled to be at the end of the current billing period.
         sig do
           returns(
             T.nilable(
@@ -24,9 +27,12 @@ module Orb
         end
         attr_accessor :effective_time
 
+        # The ID of the plan being migrated.
         sig { returns(String) }
         attr_accessor :plan_id
 
+        # Current status of the migration: 'not_started', 'in_progress', 'completed',
+        # 'action_needed', or 'canceled'.
         sig do
           returns(
             Orb::Models::Plans::MigrationRetrieveResponse::Status::TaggedSymbol
@@ -50,7 +56,18 @@ module Orb
               Orb::Models::Plans::MigrationRetrieveResponse::Status::OrSymbol
           ).returns(T.attached_class)
         end
-        def self.new(id:, effective_time:, plan_id:, status:)
+        def self.new(
+          # Unique identifier for this plan version change.
+          id:,
+          # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+          # when scheduled to be at the end of the current billing period.
+          effective_time:,
+          # The ID of the plan being migrated.
+          plan_id:,
+          # Current status of the migration: 'not_started', 'in_progress', 'completed',
+          # 'action_needed', or 'canceled'.
+          status:
+        )
         end
 
         sig do
@@ -70,6 +87,8 @@ module Orb
         def to_hash
         end
 
+        # When the migration takes effect. Can be a specific date/time, or 'end_of_term'
+        # when scheduled to be at the end of the current billing period.
         module EffectiveTime
           extend Orb::Internal::Type::Union
 
@@ -108,6 +127,8 @@ module Orb
             )
         end
 
+        # Current status of the migration: 'not_started', 'in_progress', 'completed',
+        # 'action_needed', or 'canceled'.
         module Status
           extend Orb::Internal::Type::Enum