Class: Orb::Models::Price::GroupedWithProratedMinimum

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

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

Instance Attribute Summary

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

  Configuration for grouped_with_prorated_minimum pricing.

• #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::GroupedWithProratedMinimum::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, :grouped_with_prorated_minimum

  The pricing model type.

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

  The price id this price replaces.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(grouping_key:, minimum:, unit_rate:) ⇒ Object constructor

  Configuration for grouped_with_prorated_minimum pricing.

• #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(grouping_key:, minimum:, unit_rate:) ⇒ Object

Configuration for grouped_with_prorated_minimum pricing

Parameters:

• grouping_key (String) —

  How to determine the groups that should each have a minimum

• minimum (String) —

  The minimum amount to charge per group

• unit_rate (String) —

  The amount to charge per unit

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

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 7666

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 7671

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

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 7700

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

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 7710

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

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

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 7821

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 7721

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 7726

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 7731

required :fixed_price_quantity, Float, nil?: true

#grouped_with_prorated_minimum_config ⇒ Orb::Models::Price::GroupedWithProratedMinimum::GroupedWithProratedMinimumConfig

Configuration for grouped_with_prorated_minimum pricing

Parameters:

• value (Orb::Price::GroupedWithProratedMinimum::GroupedWithProratedMinimumConfig)

Returns:

• (Orb::Models::Price::GroupedWithProratedMinimum::GroupedWithProratedMinimumConfig)

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

required :grouped_with_prorated_minimum_config,
-> { Orb::Price::GroupedWithProratedMinimum::GroupedWithProratedMinimumConfig }

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 7748

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 7755

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

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

Returns:

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

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

optional :license_type, -> { Orb::Price::GroupedWithProratedMinimum::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 7761

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

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 7776

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 7782

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

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :grouped_with_prorated_minimum

The pricing model type

Parameters:

• value (:grouped_with_prorated_minimum)

Returns:

• (Symbol, :grouped_with_prorated_minimum)

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

required :model_type, const: :grouped_with_prorated_minimum

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :name, String

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

required :plan_phase_order, Integer, nil?: true

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

Parameters:

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

Returns:

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

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

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

required :replaces_price_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {