Class: Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice

Defined in:

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

Overview

See Also:

• Orb::Models::PlanCreateParams::Price#license_allocation_price

Defined Under Namespace

Modules: Cadence, ModelType Classes: LicenseAllocation

Instance Attribute Summary

• #billable_metric_id ⇒ String^?

  The id of the billable metric for the price.

• #billed_in_advance ⇒ Boolean^?

  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.

• #billing_cycle_configuration ⇒ Orb::Models::NewBillingCycleConfiguration^?

  For custom cadence: specifies the duration of the billing period in days or months.

• #cadence ⇒ Symbol, Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::Cadence

  The cadence to bill for this price on.

• #conversion_rate ⇒ Float^?

  The per unit conversion rate of the price currency to the invoicing currency.

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

  The configuration for the rate of the price currency to the invoicing currency.

• #currency ⇒ String^?

  An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.

• #dimensional_price_configuration ⇒ Orb::Models::NewDimensionalPriceConfiguration^?

  For dimensional price: specifies a price group and dimension values.

• #external_price_id ⇒ String^?

  An alias for the price.

• #fixed_price_quantity ⇒ Float^?

  If the Price represents a fixed cost, this represents the quantity of units applied.

• #invoice_grouping_key ⇒ String^?

  The property used to group this price on an invoice.

• #invoicing_cycle_configuration ⇒ Orb::Models::NewBillingCycleConfiguration^?

  Within each billing cycle, specifies the cadence at which invoices are produced.

• #item_id ⇒ String

  The id of the item the price will be associated with.

• #license_allocations ⇒ Array<Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::LicenseAllocation>

  License allocations to associate with this price.

• #license_type_id ⇒ String^?

  The ID of the license type to associate with this price.

• #metadata ⇒ Hash{Symbol=>String, nil}^?

  User-specified key/value pairs for the resource.

• #model_type ⇒ Symbol, Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::ModelType

  The pricing model type.

• #name ⇒ String

  The name of the price.

• #reference_id ⇒ String^?

  A transient ID that can be used to reference this price when adding adjustments in the same API call.

• #unit_config ⇒ Orb::Models::UnitConfig

  Configuration for unit pricing.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(amount:, currency:, write_off_overage: nil) ⇒ Object constructor
• #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(amount:, currency:, write_off_overage: nil) ⇒ Object

Parameters:

• amount (String) —

  The amount of credits granted per active license per cadence.

• currency (String) —

  The currency of the license allocation.

• write_off_overage (Boolean, nil) (defaults to: nil) —

  When True, overage beyond the allocation is written off.

# File 'lib/orb/models/plan_create_params.rb', line 290

Instance Attribute Details

#billable_metric_id ⇒ String^?

The id of the billable metric for the price. Only needed if the price is usage-based.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan_create_params.rb', line 198

optional :billable_metric_id, String, nil?: true

#billed_in_advance ⇒ Boolean^?

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.

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/orb/models/plan_create_params.rb', line 205

optional :billed_in_advance, Orb::Internal::Type::Boolean, nil?: true

#billing_cycle_configuration ⇒ Orb::Models::NewBillingCycleConfiguration^?

For custom cadence: specifies the duration of the billing period in days or months.

Parameters:

• value (Orb::NewBillingCycleConfiguration, nil)

Returns:

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

# File 'lib/orb/models/plan_create_params.rb', line 212

optional :billing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true

#cadence ⇒ Symbol, Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::Cadence

The cadence to bill for this price on.

Parameters:

• value (Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::cadence)

Returns:

• (Symbol, Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::Cadence)

# File 'lib/orb/models/plan_create_params.rb', line 157

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

#conversion_rate ⇒ Float^?

The per unit conversion rate of the price currency to the invoicing currency.

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/orb/models/plan_create_params.rb', line 218

optional :conversion_rate, Float, nil?: true

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

The configuration for the rate of the price currency to the invoicing currency.

Parameters:

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

Returns:

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

# File 'lib/orb/models/plan_create_params.rb', line 224

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

#currency ⇒ String^?

An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan_create_params.rb', line 231

optional :currency, String, nil?: true

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

For dimensional price: specifies a price group and dimension values

Parameters:

• value (Orb::NewDimensionalPriceConfiguration, nil)

Returns:

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

# File 'lib/orb/models/plan_create_params.rb', line 237

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

#external_price_id ⇒ String^?

An alias for the price.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan_create_params.rb', line 243

optional :external_price_id, String, nil?: true

#fixed_price_quantity ⇒ Float^?

If the Price represents a fixed cost, this represents the quantity of units applied.

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/orb/models/plan_create_params.rb', line 250

optional :fixed_price_quantity, Float, nil?: true

#invoice_grouping_key ⇒ String^?

The property used to group this price on an invoice

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan_create_params.rb', line 256

optional :invoice_grouping_key, String, nil?: true

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

Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle.

Parameters:

• value (Orb::NewBillingCycleConfiguration, nil)

Returns:

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

# File 'lib/orb/models/plan_create_params.rb', line 263

optional :invoicing_cycle_configuration, -> { Orb::NewBillingCycleConfiguration }, nil?: true

#item_id ⇒ String

The id of the item the price will be associated with.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/plan_create_params.rb', line 163

required :item_id, String

#license_allocations ⇒ Array<Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::LicenseAllocation>

License allocations to associate with this price. Each entry defines a per-license credit pool granted each cadence. Requires license_type_id or license_type_configuration to be set. Usage prices draw down from these allocations only if they set the same license type.

Parameters:

• value (::Array[Orb::PlanCreateParams::Price::LicenseAllocationPrice::LicenseAllocation])

Returns:

• (Array<Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::LicenseAllocation>)

# File 'lib/orb/models/plan_create_params.rb', line 172

required :license_allocations,
-> { Orb::Internal::Type::ArrayOf[Orb::PlanCreateParams::Price::LicenseAllocationPrice::LicenseAllocation] }

#license_type_id ⇒ String^?

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.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan_create_params.rb', line 273

optional :license_type_id, String, nil?: true

#metadata ⇒ Hash{Symbol=>String, 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.

Parameters:

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

Returns:

• (Hash{Symbol=>String, nil}, nil)

# File 'lib/orb/models/plan_create_params.rb', line 281

optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true

#model_type ⇒ Symbol, Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::ModelType

The pricing model type

Parameters:

• value (Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::model_type)

Returns:

• (Symbol, Orb::Models::PlanCreateParams::Price::LicenseAllocationPrice::ModelType)

# File 'lib/orb/models/plan_create_params.rb', line 179

required :model_type, enum: -> { Orb::PlanCreateParams::Price::LicenseAllocationPrice::ModelType }

#name ⇒ String

The name of the price.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/plan_create_params.rb', line 185

required :name, String

#reference_id ⇒ String^?

A transient ID that can be used to reference this price when adding adjustments in the same API call.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan_create_params.rb', line 288

optional :reference_id, String, nil?: true

#unit_config ⇒ Orb::Models::UnitConfig

Configuration for unit pricing

Parameters:

• value (Orb::UnitConfig)

Returns:

• (Orb::Models::UnitConfig)

# File 'lib/orb/models/plan_create_params.rb', line 191

required :unit_config, -> { Orb::UnitConfig }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/orb/models/plan_create_params.rb', line 349

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/orb/models/plan_create_params.rbs', line 198

def to_hash: -> {