orb-billing 1.54.0 → 1.55.0

data/rbi/orb/models/plan_create_params.rbi

@@ -215,7 +215,8 @@ module Orb
                 Orb::PlanCreateParams::Price::Price::MeteredAllowance,
                 Orb::NewPlanMinimumCompositePrice,
                 Orb::PlanCreateParams::Price::Price::Percent,
-                Orb::PlanCreateParams::Price::Price::EventOutput
+                Orb::PlanCreateParams::Price::Price::EventOutput,
+                Orb::PlanCreateParams::Price::Price::UnitWithMultiplier
               )
             )
           )
@@ -268,7 +269,8 @@ module Orb
                   Orb::PlanCreateParams::Price::Price::MeteredAllowance::OrHash,
                   Orb::NewPlanMinimumCompositePrice::OrHash,
                   Orb::PlanCreateParams::Price::Price::Percent::OrHash,
-                  Orb::PlanCreateParams::Price::Price::EventOutput::OrHash
+                  Orb::PlanCreateParams::Price::Price::EventOutput::OrHash,
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::OrHash
                 )
               )
           ).returns(T.attached_class)
@@ -330,7 +332,8 @@ module Orb
                     Orb::PlanCreateParams::Price::Price::MeteredAllowance,
                     Orb::NewPlanMinimumCompositePrice,
                     Orb::PlanCreateParams::Price::Price::Percent,
-                    Orb::PlanCreateParams::Price::Price::EventOutput
+                    Orb::PlanCreateParams::Price::Price::EventOutput,
+                    Orb::PlanCreateParams::Price::Price::UnitWithMultiplier
                   )
                 )
             }
@@ -815,7 +818,8 @@ module Orb
                 Orb::PlanCreateParams::Price::Price::MeteredAllowance,
                 Orb::NewPlanMinimumCompositePrice,
                 Orb::PlanCreateParams::Price::Price::Percent,
-                Orb::PlanCreateParams::Price::Price::EventOutput
+                Orb::PlanCreateParams::Price::Price::EventOutput,
+                Orb::PlanCreateParams::Price::Price::UnitWithMultiplier
               )
             end
 
@@ -5628,6 +5632,407 @@ module Orb
             end
           end
 
+          class UnitWithMultiplier < Orb::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier,
+                  Orb::Internal::AnyHash
+                )
+              end
+
+            # The cadence to bill for this price on.
+            sig do
+              returns(
+                Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::OrSymbol
+              )
+            end
+            attr_accessor :cadence
+
+            # The id of the item the price will be associated with.
+            sig { returns(String) }
+            attr_accessor :item_id
+
+            # The pricing model type
+            sig { returns(Symbol) }
+            attr_accessor :model_type
+
+            # The name of the price.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # Configuration for unit_with_multiplier pricing
+            sig do
+              returns(
+                Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::UnitWithMultiplierConfig
+              )
+            end
+            attr_reader :unit_with_multiplier_config
+
+            sig do
+              params(
+                unit_with_multiplier_config:
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::UnitWithMultiplierConfig::OrHash
+              ).void
+            end
+            attr_writer :unit_with_multiplier_config
+
+            # The id of the billable metric for the price. Only needed if the price is
+            # usage-based.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :billable_metric_id
+
+            # If the Price represents a fixed cost, the price will be billed in-advance if
+            # this is true, and in-arrears if this is false.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :billed_in_advance
+
+            # For custom cadence: specifies the duration of the billing period in days or
+            # months.
+            sig { returns(T.nilable(Orb::NewBillingCycleConfiguration)) }
+            attr_reader :billing_cycle_configuration
+
+            sig do
+              params(
+                billing_cycle_configuration:
+                  T.nilable(Orb::NewBillingCycleConfiguration::OrHash)
+              ).void
+            end
+            attr_writer :billing_cycle_configuration
+
+            # The per unit conversion rate of the price currency to the invoicing currency.
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :conversion_rate
+
+            # The configuration for the rate of the price currency to the invoicing currency.
+            sig do
+              returns(
+                T.nilable(
+                  T.any(
+                    Orb::UnitConversionRateConfig,
+                    Orb::TieredConversionRateConfig
+                  )
+                )
+              )
+            end
+            attr_accessor :conversion_rate_config
+
+            # An ISO 4217 currency string, or custom pricing unit identifier, in which this
+            # price is billed.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :currency
+
+            # For dimensional price: specifies a price group and dimension values
+            sig { returns(T.nilable(Orb::NewDimensionalPriceConfiguration)) }
+            attr_reader :dimensional_price_configuration
+
+            sig do
+              params(
+                dimensional_price_configuration:
+                  T.nilable(Orb::NewDimensionalPriceConfiguration::OrHash)
+              ).void
+            end
+            attr_writer :dimensional_price_configuration
+
+            # An alias for the price.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :external_price_id
+
+            # If the Price represents a fixed cost, this represents the quantity of units
+            # applied.
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :fixed_price_quantity
+
+            # The property used to group this price on an invoice
+            sig { returns(T.nilable(String)) }
+            attr_accessor :invoice_grouping_key
+
+            # Within each billing cycle, specifies the cadence at which invoices are produced.
+            # If unspecified, a single invoice is produced per billing cycle.
+            sig { returns(T.nilable(Orb::NewBillingCycleConfiguration)) }
+            attr_reader :invoicing_cycle_configuration
+
+            sig do
+              params(
+                invoicing_cycle_configuration:
+                  T.nilable(Orb::NewBillingCycleConfiguration::OrHash)
+              ).void
+            end
+            attr_writer :invoicing_cycle_configuration
+
+            # The ID of the license type to associate with this price. On a usage price this
+            # also marks the price as eligible to draw down from that license type's
+            # allocation; a usage price created without it is billed normally. Usage prices
+            # with a license type must use the `unit` model, and only draw down when their
+            # currency matches the allocation's.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :license_type_id
+
+            # User-specified key/value pairs for the resource. Individual keys can be removed
+            # by setting the value to `null`, and the entire metadata mapping can be cleared
+            # by setting `metadata` to `null`.
+            sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+            attr_accessor :metadata
+
+            # A transient ID that can be used to reference this price when adding adjustments
+            # in the same API call.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :reference_id
+
+            sig do
+              params(
+                cadence:
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::OrSymbol,
+                item_id: String,
+                name: String,
+                unit_with_multiplier_config:
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::UnitWithMultiplierConfig::OrHash,
+                billable_metric_id: T.nilable(String),
+                billed_in_advance: T.nilable(T::Boolean),
+                billing_cycle_configuration:
+                  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
+                conversion_rate: T.nilable(Float),
+                conversion_rate_config:
+                  T.nilable(
+                    T.any(
+                      Orb::UnitConversionRateConfig::OrHash,
+                      Orb::TieredConversionRateConfig::OrHash
+                    )
+                  ),
+                currency: T.nilable(String),
+                dimensional_price_configuration:
+                  T.nilable(Orb::NewDimensionalPriceConfiguration::OrHash),
+                external_price_id: T.nilable(String),
+                fixed_price_quantity: T.nilable(Float),
+                invoice_grouping_key: T.nilable(String),
+                invoicing_cycle_configuration:
+                  T.nilable(Orb::NewBillingCycleConfiguration::OrHash),
+                license_type_id: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+                reference_id: T.nilable(String),
+                model_type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The cadence to bill for this price on.
+              cadence:,
+              # The id of the item the price will be associated with.
+              item_id:,
+              # The name of the price.
+              name:,
+              # Configuration for unit_with_multiplier pricing
+              unit_with_multiplier_config:,
+              # The id of the billable metric for the price. Only needed if the price is
+              # usage-based.
+              billable_metric_id: nil,
+              # If the Price represents a fixed cost, the price will be billed in-advance if
+              # this is true, and in-arrears if this is false.
+              billed_in_advance: nil,
+              # For custom cadence: specifies the duration of the billing period in days or
+              # months.
+              billing_cycle_configuration: nil,
+              # The per unit conversion rate of the price currency to the invoicing currency.
+              conversion_rate: nil,
+              # The configuration for the rate of the price currency to the invoicing currency.
+              conversion_rate_config: nil,
+              # An ISO 4217 currency string, or custom pricing unit identifier, in which this
+              # price is billed.
+              currency: nil,
+              # For dimensional price: specifies a price group and dimension values
+              dimensional_price_configuration: nil,
+              # An alias for the price.
+              external_price_id: nil,
+              # If the Price represents a fixed cost, this represents the quantity of units
+              # applied.
+              fixed_price_quantity: nil,
+              # The property used to group this price on an invoice
+              invoice_grouping_key: nil,
+              # Within each billing cycle, specifies the cadence at which invoices are produced.
+              # If unspecified, a single invoice is produced per billing cycle.
+              invoicing_cycle_configuration: nil,
+              # The ID of the license type to associate with this price. On a usage price this
+              # also marks the price as eligible to draw down from that license type's
+              # allocation; a usage price created without it is billed normally. Usage prices
+              # with a license type must use the `unit` model, and only draw down when their
+              # currency matches the allocation's.
+              license_type_id: nil,
+              # User-specified key/value pairs for the resource. Individual keys can be removed
+              # by setting the value to `null`, and the entire metadata mapping can be cleared
+              # by setting `metadata` to `null`.
+              metadata: nil,
+              # A transient ID that can be used to reference this price when adding adjustments
+              # in the same API call.
+              reference_id: nil,
+              # The pricing model type
+              model_type: :unit_with_multiplier
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  cadence:
+                    Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::OrSymbol,
+                  item_id: String,
+                  model_type: Symbol,
+                  name: String,
+                  unit_with_multiplier_config:
+                    Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::UnitWithMultiplierConfig,
+                  billable_metric_id: T.nilable(String),
+                  billed_in_advance: T.nilable(T::Boolean),
+                  billing_cycle_configuration:
+                    T.nilable(Orb::NewBillingCycleConfiguration),
+                  conversion_rate: T.nilable(Float),
+                  conversion_rate_config:
+                    T.nilable(
+                      T.any(
+                        Orb::UnitConversionRateConfig,
+                        Orb::TieredConversionRateConfig
+                      )
+                    ),
+                  currency: T.nilable(String),
+                  dimensional_price_configuration:
+                    T.nilable(Orb::NewDimensionalPriceConfiguration),
+                  external_price_id: T.nilable(String),
+                  fixed_price_quantity: T.nilable(Float),
+                  invoice_grouping_key: T.nilable(String),
+                  invoicing_cycle_configuration:
+                    T.nilable(Orb::NewBillingCycleConfiguration),
+                  license_type_id: T.nilable(String),
+                  metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+                  reference_id: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # The cadence to bill for this price on.
+            module Cadence
+              extend Orb::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              ONE_TIME =
+                T.let(
+                  :one_time,
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::TaggedSymbol
+                )
+              MONTHLY =
+                T.let(
+                  :monthly,
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::TaggedSymbol
+                )
+              QUARTERLY =
+                T.let(
+                  :quarterly,
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::TaggedSymbol
+                )
+              SEMI_ANNUAL =
+                T.let(
+                  :semi_annual,
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::TaggedSymbol
+                )
+              ANNUAL =
+                T.let(
+                  :annual,
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::TaggedSymbol
+                )
+              CUSTOM =
+                T.let(
+                  :custom,
+                  Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::Cadence::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            class UnitWithMultiplierConfig < Orb::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Orb::PlanCreateParams::Price::Price::UnitWithMultiplier::UnitWithMultiplierConfig,
+                    Orb::Internal::AnyHash
+                  )
+                end
+
+              # Sub-line label for list-price events that don't set display_name_key. Unlabeled
+              # events with another multiplier are labeled by their multiplier (e.g. '0.8×
+              # rate').
+              sig { returns(String) }
+              attr_accessor :default_display_name
+
+              # Event property holding the sub-line label for the event's rate (e.g.
+              # 'Off-peak').
+              sig { returns(String) }
+              attr_accessor :display_name_key
+
+              # Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
+              # discount). Events without a number between 0 and 1000 with at most 12 decimal
+              # places are charged at unit_amount.
+              sig { returns(String) }
+              attr_accessor :multiplier_key
+
+              # List price per unit, before the event's multiplier is applied.
+              sig { returns(String) }
+              attr_accessor :unit_amount
+
+              # Configuration for unit_with_multiplier pricing
+              sig do
+                params(
+                  default_display_name: String,
+                  display_name_key: String,
+                  multiplier_key: String,
+                  unit_amount: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # Sub-line label for list-price events that don't set display_name_key. Unlabeled
+                # events with another multiplier are labeled by their multiplier (e.g. '0.8×
+                # rate').
+                default_display_name:,
+                # Event property holding the sub-line label for the event's rate (e.g.
+                # 'Off-peak').
+                display_name_key:,
+                # Event property holding the multiplier applied to unit_amount (e.g. 0.8 for a 20%
+                # discount). Events without a number between 0 and 1000 with at most 12 decimal
+                # places are charged at unit_amount.
+                multiplier_key:,
+                # List price per unit, before the event's multiplier is applied.
+                unit_amount:
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    default_display_name: String,
+                    display_name_key: String,
+                    multiplier_key: String,
+                    unit_amount: String
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+
           sig do
             override.returns(
               T::Array[Orb::PlanCreateParams::Price::Price::Variants]

data/rbi/orb/models/plan_version.rbi

@@ -79,7 +79,8 @@ module Orb
                 Orb::Price::MeteredAllowance::OrHash,
                 Orb::Price::MinimumComposite::OrHash,
                 Orb::Price::Percent::OrHash,
-                Orb::Price::EventOutput::OrHash
+                Orb::Price::EventOutput::OrHash,
+                Orb::Price::UnitWithMultiplier::OrHash
               )
             ],
           version: Integer