Class: Orb::Models::Price::GroupedWithMeteredMinimum

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

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

Instance Attribute Summary

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

  Configuration for grouped_with_metered_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::GroupedWithMeteredMinimum::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_metered_minimum

  The pricing model type.

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

  The price id this price replaces.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(pricing_value:, unit_amount:) ⇒ Object constructor

  Configuration for a unit amount.

• #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(pricing_value:, unit_amount:) ⇒ Object

Configuration for a unit amount

Parameters:

• pricing_value (String)
• unit_amount (String) —

  Per unit amount

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

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 8065

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 8070

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

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 8099

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

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 8109

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

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

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 8220

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 8120

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 8125

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 8130

required :fixed_price_quantity, Float, nil?: true

#grouped_with_metered_minimum_config ⇒ Orb::Models::Price::GroupedWithMeteredMinimum::GroupedWithMeteredMinimumConfig

Configuration for grouped_with_metered_minimum pricing

Parameters:

• value (Orb::Price::GroupedWithMeteredMinimum::GroupedWithMeteredMinimumConfig)

Returns:

• (Orb::Models::Price::GroupedWithMeteredMinimum::GroupedWithMeteredMinimumConfig)

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

required :grouped_with_metered_minimum_config,
-> { Orb::Price::GroupedWithMeteredMinimum::GroupedWithMeteredMinimumConfig }

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 8147

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 8154

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

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

Returns:

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

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

optional :license_type, -> { Orb::Price::GroupedWithMeteredMinimum::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 8160

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

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 8175

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 8181

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

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :grouped_with_metered_minimum

The pricing model type

Parameters:

• value (:grouped_with_metered_minimum)

Returns:

• (Symbol, :grouped_with_metered_minimum)

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

required :model_type, const: :grouped_with_metered_minimum

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :name, String

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

required :plan_phase_order, Integer, nil?: true

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

Parameters:

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

Returns:

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

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

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

required :replaces_price_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {