Class: Orb::Models::NewPlanUnitWithProrationPrice

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/new_plan_unit_with_proration_price.rb

Defined Under Namespace

Modules: Cadence, ConversionRateConfig, ModelType

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: , model_type: , name: , unit_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, metadata: nil, reference_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::NewPlanUnitWithProrationPrice for more details.

Parameters:

  • cadence (Symbol, Orb::Models::NewPlanUnitWithProrationPrice::Cadence) (defaults to: ) —

    The cadence to bill for this price on.

  • item_id (String) (defaults to: ) —

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

  • model_type (Symbol, Orb::Models::NewPlanUnitWithProrationPrice::ModelType) (defaults to: )
  • name (String) (defaults to: ) —

    The name of the price.

  • unit_with_proration_config (Hash{Symbol=>Object}) (defaults to: )
  • 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.

  • 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




# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 123

Instance Attribute Details

#billable_metric_id ⇒ String?

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

Returns:

  • (String, nil) 


39
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 39

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.

Returns:

  • (Boolean, nil) 


46
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 46

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.

Returns:



53
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 53

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

#cadence ⇒ Symbol, Orb::Models::NewPlanUnitWithProrationPrice::Cadence

The cadence to bill for this price on.

Returns:



10
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 10

required :cadence, enum: -> { Orb::NewPlanUnitWithProrationPrice::Cadence }

#conversion_rate ⇒ Float?

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

Returns:

  • (Float, nil) 


59
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 59

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.

Returns:



65
66
67
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 65

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

#currency ⇒ String?

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

Returns:

  • (String, nil) 


74
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 74

optional :currency, String, nil?: true

#dimensional_price_configuration ⇒ Orb::Models::NewDimensionalPriceConfiguration?

For dimensional price: specifies a price group and dimension values

Returns:



80
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 80

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

#external_price_id ⇒ String?

An alias for the price.

Returns:

  • (String, nil) 


86
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 86

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.

Returns:

  • (Float, nil) 


93
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 93

optional :fixed_price_quantity, Float, nil?: true

#invoice_grouping_key ⇒ String?

The property used to group this price on an invoice

Returns:

  • (String, nil) 


99
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 99

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.

Returns:



106
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 106

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

#item_id ⇒ String

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

Returns:

  • (String) 


16
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 16

required :item_id, String

#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`.

Returns:

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


114
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 114

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

#model_type ⇒ Symbol, Orb::Models::NewPlanUnitWithProrationPrice::ModelType

Returns:



21
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 21

required :model_type, enum: -> { Orb::NewPlanUnitWithProrationPrice::ModelType }

#name ⇒ String

The name of the price.

Returns:

  • (String) 


27
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 27

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.

Returns:

  • (String, nil) 


121
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 121

optional :reference_id, String, nil?: true

#unit_with_proration_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


32
 
# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 32

required :unit_with_proration_config, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/new_plan_unit_with_proration_price.rb', line 176