Class: Orb::Models::Price::Tiered

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::Price::Tiered

Defined in:

lib/orb/models/price.rb,
sig/orb/models/price.rbs

Defined Under Namespace

Modules: BillingMode, Cadence, PriceType Classes: CompositePriceFilter, LicenseType

Instance Attribute Summary

• #billable_metric ⇒ Orb::Models::BillableMetricTiny^?
• #billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration
• #billing_mode ⇒ Symbol, Orb::Models::Price::Tiered::BillingMode
• #cadence ⇒ Symbol, Orb::Models::Price::Tiered::Cadence
• #composite_price_filters ⇒ Array<Orb::Models::Price::Tiered::CompositePriceFilter>^?
• #conversion_rate ⇒ Float^?
• #conversion_rate_config ⇒ Orb::Models::UnitConversionRateConfig, ...
• #created_at ⇒ Time
• #credit_allocation ⇒ Orb::Models::Allocation^?
• #currency ⇒ String
• #dimensional_price_configuration ⇒ Orb::Models::DimensionalPriceConfiguration^?
• #discount ⇒ Orb::Models::PercentageDiscount, ... deprecated Deprecated.
• #external_price_id ⇒ String^?
• #fixed_price_quantity ⇒ Float^?
• #id ⇒ String
• #invoice_grouping_key ⇒ String^?
• #invoicing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration^?
• #item ⇒ Orb::Models::ItemSlim

  A minimal representation of an Item containing only the essential identifying information.

• #license_type ⇒ Orb::Models::Price::Tiered::LicenseType^?

  The LicenseType resource represents a type of license that can be assigned to users.

• #maximum ⇒ Orb::Models::Maximum^? deprecated Deprecated.
• #maximum_amount ⇒ String^? deprecated Deprecated.
• #metadata ⇒ Hash{Symbol=>String}

  User specified key-value pairs for the resource.

• #minimum ⇒ Orb::Models::Minimum^? deprecated Deprecated.
• #minimum_amount ⇒ String^? deprecated Deprecated.
• #model_type ⇒ Symbol, :tiered

  The pricing model type.

• #name ⇒ String
• #plan_phase_order ⇒ Integer^?
• #price_type ⇒ Symbol, Orb::Models::Price::Tiered::PriceType
• #replaces_price_id ⇒ String^?

  The price id this price replaces.

• #tiered_config ⇒ Orb::Models::TieredConfig

  Configuration for tiered pricing.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered) ⇒ Object constructor

  Some parameter documentations has been truncated, see Tiered for more details.

• #to_hash ⇒ {

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, tiered_config:, dimensional_price_configuration: nil, license_type: nil, model_type: :tiered) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Price::Tiered for more details.

Parameters:

• id (String)
• billable_metric (Orb::Models::BillableMetricTiny, nil)
• billing_cycle_configuration (Orb::Models::BillingCycleConfiguration)
• billing_mode (Symbol, Orb::Models::Price::Tiered::BillingMode)
• cadence (Symbol, Orb::Models::Price::Tiered::Cadence)
• composite_price_filters (Array<Orb::Models::Price::Tiered::CompositePriceFilter>, nil)
• conversion_rate (Float, nil)
• conversion_rate_config (Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil)
• created_at (Time)
• credit_allocation (Orb::Models::Allocation, nil)
• currency (String)
• discount (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil)
• external_price_id (String, nil)
• fixed_price_quantity (Float, nil)
• invoice_grouping_key (String, nil)
• invoicing_cycle_configuration (Orb::Models::BillingCycleConfiguration, nil)
• item (Orb::Models::ItemSlim) —

  A minimal representation of an Item containing only the essential identifying in

• maximum (Orb::Models::Maximum, nil)
• maximum_amount (String, nil)
• metadata (Hash{Symbol=>String}) —

  User specified key-value pairs for the resource. If not present, this defaults t

• minimum (Orb::Models::Minimum, nil)
• minimum_amount (String, nil)
• name (String)
• plan_phase_order (Integer, nil)
• price_type (Symbol, Orb::Models::Price::Tiered::PriceType)
• replaces_price_id (String, nil) —

  The price id this price replaces. This price will take the place of the replaced

• tiered_config (Orb::Models::TieredConfig) —

  Configuration for tiered pricing

• dimensional_price_configuration (Orb::Models::DimensionalPriceConfiguration, nil) (defaults to: nil)
• license_type (Orb::Models::Price::Tiered::LicenseType, nil) (defaults to: nil) —

  The LicenseType resource represents a type of license that can be assigned to us

• model_type (Symbol, :tiered) (defaults to: :tiered) —

  The pricing model type

# File 'lib/orb/models/price.rb', line 627

Instance Attribute Details

#billable_metric ⇒ Orb::Models::BillableMetricTiny^?

Parameters:

• value (Orb::BillableMetricTiny, nil)

Returns:

• (Orb::Models::BillableMetricTiny, nil)

# File 'lib/orb/models/price.rb', line 465

required :billable_metric, -> { Orb::BillableMetricTiny }, nil?: true

#billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration

Parameters:

• value (Orb::BillingCycleConfiguration)

Returns:

• (Orb::Models::BillingCycleConfiguration)

# File 'lib/orb/models/price.rb', line 470

required :billing_cycle_configuration, -> { Orb::BillingCycleConfiguration }

#billing_mode ⇒ Symbol, Orb::Models::Price::Tiered::BillingMode

Parameters:

• value (Orb::Models::Price::Tiered::billing_mode)

Returns:

• (Symbol, Orb::Models::Price::Tiered::BillingMode)

# File 'lib/orb/models/price.rb', line 475

required :billing_mode, enum: -> { Orb::Price::Tiered::BillingMode }

#cadence ⇒ Symbol, Orb::Models::Price::Tiered::Cadence

Parameters:

• value (Orb::Models::Price::Tiered::cadence)

Returns:

• (Symbol, Orb::Models::Price::Tiered::Cadence)

# File 'lib/orb/models/price.rb', line 480

required :cadence, enum: -> { Orb::Price::Tiered::Cadence }

#composite_price_filters ⇒ Array<Orb::Models::Price::Tiered::CompositePriceFilter>^?

Parameters:

• value (::Array[Orb::Price::Tiered::CompositePriceFilter], nil)

Returns:

• (Array<Orb::Models::Price::Tiered::CompositePriceFilter>, nil)

# File 'lib/orb/models/price.rb', line 485

required :composite_price_filters,
-> { Orb::Internal::Type::ArrayOf[Orb::Price::Tiered::CompositePriceFilter] },
nil?: true

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/orb/models/price.rb', line 492

required :conversion_rate, Float, nil?: true

#conversion_rate_config ⇒ Orb::Models::UnitConversionRateConfig, ...

Parameters:

• value (Orb::Models::conversion_rate_config, nil)

Returns:

• (Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil)

# File 'lib/orb/models/price.rb', line 497

required :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/orb/models/price.rb', line 502

required :created_at, Time

#credit_allocation ⇒ Orb::Models::Allocation^?

Parameters:

• value (Orb::Allocation, nil)

Returns:

• (Orb::Models::Allocation, nil)

# File 'lib/orb/models/price.rb', line 507

required :credit_allocation, -> { Orb::Allocation }, nil?: true

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/price.rb', line 512

required :currency, String

#dimensional_price_configuration ⇒ Orb::Models::DimensionalPriceConfiguration^?

Parameters:

• value (Orb::DimensionalPriceConfiguration, nil)

Returns:

• (Orb::Models::DimensionalPriceConfiguration, nil)

# File 'lib/orb/models/price.rb', line 617

optional :dimensional_price_configuration, -> { Orb::DimensionalPriceConfiguration }, nil?: true

#discount ⇒ Orb::Models::PercentageDiscount, ...

Deprecated.

Parameters:

• value (Orb::Models::discount, nil)

Returns:

• (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil)

# File 'lib/orb/models/price.rb', line 518

required :discount, union: -> { Orb::Discount }, nil?: true

#external_price_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 523

required :external_price_id, String, nil?: true

#fixed_price_quantity ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/orb/models/price.rb', line 528

required :fixed_price_quantity, Float, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/price.rb', line 460

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 533

required :invoice_grouping_key, String, nil?: true

#invoicing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration^?

Parameters:

• value (Orb::BillingCycleConfiguration, nil)

Returns:

• (Orb::Models::BillingCycleConfiguration, nil)

# File 'lib/orb/models/price.rb', line 538

required :invoicing_cycle_configuration, -> { Orb::BillingCycleConfiguration }, nil?: true

#item ⇒ Orb::Models::ItemSlim

A minimal representation of an Item containing only the essential identifying information.

Parameters:

• value (Orb::ItemSlim)

Returns:

• (Orb::Models::ItemSlim)

# File 'lib/orb/models/price.rb', line 545

required :item, -> { Orb::ItemSlim }

#license_type ⇒ Orb::Models::Price::Tiered::LicenseType^?

The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key.

Parameters:

• value (Orb::Price::Tiered::LicenseType, nil)

Returns:

• (Orb::Models::Price::Tiered::LicenseType, nil)

# File 'lib/orb/models/price.rb', line 625

optional :license_type, -> { Orb::Price::Tiered::LicenseType }, nil?: true

#maximum ⇒ Orb::Models::Maximum^?

Deprecated.

Parameters:

• value (Orb::Maximum, nil)

Returns:

• (Orb::Models::Maximum, nil)

# File 'lib/orb/models/price.rb', line 551

required :maximum, -> { Orb::Maximum }, nil?: true

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 557

required :maximum_amount, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Parameters:

• value (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String})

# File 'lib/orb/models/price.rb', line 566

required :metadata, Orb::Internal::Type::HashOf[String]

#minimum ⇒ Orb::Models::Minimum^?

Deprecated.

Parameters:

• value (Orb::Minimum, nil)

Returns:

• (Orb::Models::Minimum, nil)

# File 'lib/orb/models/price.rb', line 572

required :minimum, -> { Orb::Minimum }, nil?: true

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 578

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :tiered

The pricing model type

Parameters:

• value (:tiered)

Returns:

• (Symbol, :tiered)

# File 'lib/orb/models/price.rb', line 584

required :model_type, const: :tiered

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/price.rb', line 589

required :name, String

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/orb/models/price.rb', line 594

required :plan_phase_order, Integer, nil?: true

#price_type ⇒ Symbol, Orb::Models::Price::Tiered::PriceType

Parameters:

• value (Orb::Models::Price::Tiered::price_type)

Returns:

• (Symbol, Orb::Models::Price::Tiered::PriceType)

# File 'lib/orb/models/price.rb', line 599

required :price_type, enum: -> { Orb::Price::Tiered::PriceType }

#replaces_price_id ⇒ String^?

The price id this price replaces. This price will take the place of the replaced price in plan version migrations.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 606

required :replaces_price_id, String, nil?: true

#tiered_config ⇒ Orb::Models::TieredConfig

Configuration for tiered pricing

Parameters:

• value (Orb::TieredConfig)

Returns:

• (Orb::Models::TieredConfig)

# File 'lib/orb/models/price.rb', line 612

required :tiered_config, -> { Orb::TieredConfig }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/orb/models/price.rb', line 698

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/orb/models/price.rbs', line 443

def to_hash: -> {