Class: Orb::Models::Price::Percent

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

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

Instance Attribute Summary

• #billable_metric ⇒ Orb::Models::BillableMetricTiny^?
• #billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration
• #billing_mode ⇒ Symbol, Orb::Models::Price::Percent::BillingMode
• #cadence ⇒ Symbol, Orb::Models::Price::Percent::Cadence
• #composite_price_filters ⇒ Array<Orb::Models::Price::Percent::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::Percent::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, :percent

  The pricing model type.

• #name ⇒ String
• #percent_config ⇒ Orb::Models::Price::Percent::PercentConfig

  Configuration for percent pricing.

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

  The price id this price replaces.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(percent:, maximum_amount: nil, minimum_amount: nil, prorated: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see PercentConfig 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(percent:, maximum_amount: nil, minimum_amount: nil, prorated: nil) ⇒ Object

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

Configuration for percent pricing

Parameters:

• percent (Float) —

  Fraction of the component subtotals to charge (0 < percent <= 1).

• maximum_amount (String, nil) (defaults to: nil) —

  Maximum amount to charge. If unset, the fee has no upper bound.

• minimum_amount (String, nil) (defaults to: nil) —

  Minimum amount to charge. If unset, the fee is bounded below by 0.

• prorated (Boolean) (defaults to: nil) —

  If true, the minimum_amount is prorated based on the service period. The maximum

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

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 13625

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 13630

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

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 13657

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

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 13667

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

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

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 13777

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 13678

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 13683

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 13688

required :fixed_price_quantity, Float, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 13698

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 13705

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

#license_type ⇒ Orb::Models::Price::Percent::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::Percent::LicenseType, nil)

Returns:

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

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

optional :license_type, -> { Orb::Price::Percent::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 13711

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

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 13726

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 13732

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

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :percent

The pricing model type

Parameters:

• value (:percent)

Returns:

• (Symbol, :percent)

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

required :model_type, const: :percent

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :name, String

#percent_config ⇒ Orb::Models::Price::Percent::PercentConfig

Configuration for percent pricing

Parameters:

• value (Orb::Price::Percent::PercentConfig)

Returns:

• (Orb::Models::Price::Percent::PercentConfig)

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

required :percent_config, -> { Orb::Price::Percent::PercentConfig }

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

required :plan_phase_order, Integer, nil?: true

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

Parameters:

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

Returns:

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

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

required :price_type, enum: -> { Orb::Price::Percent::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 13772

required :replaces_price_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {