Class: Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration

Inherits:
Internal::Type::BaseModel
  • Object
show all
Defined in:
lib/orb/models/beta/external_plan_id_create_plan_version_params.rb,
sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs

Defined Under Namespace

Modules: Cadence Classes: TieredWithProrationConfig

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(cadence:, item_id:, name:, tiered_with_proration_config:, billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, currency: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, license_type_id: nil, metadata: nil, reference_id: nil, model_type: :tiered_with_proration) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration for more details.

Parameters:

  • cadence (Symbol, Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration::Cadence) —

    The cadence to bill for this price on.

  • item_id (String) —

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

  • name (String) —

    The name of the price.

  • tiered_with_proration_config (Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration::TieredWithProrationConfig) —

    Configuration for tiered_with_proration pricing

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

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

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

    If the Price represents a fixed cost, the price will be billed in-advance if thi

  • billing_cycle_configuration (Orb::Models::NewBillingCycleConfiguration, nil) (defaults to: nil) —

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

  • conversion_rate (Float, nil) (defaults to: nil) —

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

  • conversion_rate_config (Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil) (defaults to: nil) —

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

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

    An ISO 4217 currency string, or custom pricing unit identifier, in which this pr

  • dimensional_price_configuration (Orb::Models::NewDimensionalPriceConfiguration, nil) (defaults to: nil) —

    For dimensional price: specifies a price group and dimension values

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

    An alias for the price.

  • fixed_price_quantity (Float, nil) (defaults to: nil) —

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

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

    The property used to group this price on an invoice

  • invoicing_cycle_configuration (Orb::Models::NewBillingCycleConfiguration, nil) (defaults to: nil) —

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

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

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

  • metadata (Hash{Symbol=>String, nil}, nil) (defaults to: nil) —

    User-specified key/value pairs for the resource. Individual keys can be removed

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

    A transient ID that can be used to reference this price when adding adjustments

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

    The pricing model type




# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1441

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) 


1349
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1349

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) 


1356
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1356

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:

Returns:



1363
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1363

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

#cadence ⇒ Symbol, Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration::Cadence

The cadence to bill for this price on.

Parameters:

  • value (Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration::cadence)

Returns:



1316
1317
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1316

required :cadence,
enum: -> { Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration::Cadence }

#conversion_rate ⇒ Float?

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

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


1369
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1369

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:



1375
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1375

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) 


1382
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1382

optional :currency, String, nil?: true

#dimensional_price_configuration ⇒ Orb::Models::NewDimensionalPriceConfiguration?

For dimensional price: specifies a price group and dimension values

Parameters:

Returns:



1388
1389
1390
1391
1392
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1388

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

#external_price_id ⇒ String?

An alias for the price.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


1398
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1398

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) 


1405
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1405

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) 


1411
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1411

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:

Returns:



1418
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1418

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) 


1323
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1323

required :item_id, String

#license_type_id ⇒ String?

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

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


1424
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1424

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) 


1432
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1432

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

#model_type ⇒ Symbol, :tiered_with_proration

The pricing model type

Parameters:

  • value (:tiered_with_proration)

Returns:

  • (Symbol, :tiered_with_proration) 


1329
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1329

required :model_type, const: :tiered_with_proration

#name ⇒ String

The name of the price.

Parameters:

  • value (String)

Returns:

  • (String) 


1335
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1335

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) 


1439
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1439

optional :reference_id, String, nil?: true

#tiered_with_proration_config ⇒ Orb::Models::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration::TieredWithProrationConfig

Configuration for tiered_with_proration pricing

Parameters:

  • value (Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration::TieredWithProrationConfig)

Returns:



1341
1342
 
# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1341

required :tiered_with_proration_config,
-> { Orb::Beta::ExternalPlanIDCreatePlanVersionParams::AddPrice::Price::TieredWithProration::TieredWithProrationConfig }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/beta/external_plan_id_create_plan_version_params.rb', line 1497

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


1009
 
# File 'sig/orb/models/beta/external_plan_id_create_plan_version_params.rbs', line 1009

def to_hash: -> {