Class: Orb::Models::PriceCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/price_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Cadence, ConversionRateConfig, ModelType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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: , currency: , item_id: , model_type: , name: , unit_config: , package_config: , matrix_config: , matrix_with_allocation_config: , tiered_config: , tiered_bps_config: , bps_config: , bulk_bps_config: , bulk_config: , threshold_total_amount_config: , tiered_package_config: , grouped_tiered_config: , max_group_tiered_package_config: , tiered_with_minimum_config: , package_with_allocation_config: , tiered_package_with_minimum_config: , unit_with_percent_config: , tiered_with_proration_config: , unit_with_proration_config: , grouped_allocation_config: , grouped_with_prorated_minimum_config: , grouped_with_metered_minimum_config: , matrix_with_display_name_config: , bulk_with_proration_config: , grouped_tiered_package_config: , scalable_matrix_with_unit_pricing_config: , scalable_matrix_with_tiered_pricing_config: , cumulative_grouped_bulk_config: , billable_metric_id: nil, billed_in_advance: nil, billing_cycle_configuration: nil, conversion_rate: nil, conversion_rate_config: nil, dimensional_price_configuration: nil, external_price_id: nil, fixed_price_quantity: nil, invoice_grouping_key: nil, invoicing_cycle_configuration: nil, metadata: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    The cadence to bill for this price on.

  • currency (String) (defaults to: ) —

    An ISO 4217 currency string for which this price is billed in.

  • item_id (String) (defaults to: ) —

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

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

    The name of the price.

  • unit_config (Orb::Models::UnitConfig) (defaults to: )
  • package_config (Orb::Models::PackageConfig) (defaults to: )
  • matrix_config (Orb::Models::MatrixConfig) (defaults to: )
  • matrix_with_allocation_config (Orb::Models::MatrixWithAllocationConfig) (defaults to: )
  • tiered_config (Orb::Models::TieredConfig) (defaults to: )
  • tiered_bps_config (Orb::Models::TieredBPSConfig) (defaults to: )
  • bps_config (Orb::Models::BPSConfig) (defaults to: )
  • bulk_bps_config (Orb::Models::BulkBPSConfig) (defaults to: )
  • bulk_config (Orb::Models::BulkConfig) (defaults to: )
  • threshold_total_amount_config (Hash{Symbol=>Object}) (defaults to: )
  • tiered_package_config (Hash{Symbol=>Object}) (defaults to: )
  • grouped_tiered_config (Hash{Symbol=>Object}) (defaults to: )
  • max_group_tiered_package_config (Hash{Symbol=>Object}) (defaults to: )
  • tiered_with_minimum_config (Hash{Symbol=>Object}) (defaults to: )
  • package_with_allocation_config (Hash{Symbol=>Object}) (defaults to: )
  • tiered_package_with_minimum_config (Hash{Symbol=>Object}) (defaults to: )
  • unit_with_percent_config (Hash{Symbol=>Object}) (defaults to: )
  • tiered_with_proration_config (Hash{Symbol=>Object}) (defaults to: )
  • unit_with_proration_config (Hash{Symbol=>Object}) (defaults to: )
  • grouped_allocation_config (Hash{Symbol=>Object}) (defaults to: )
  • grouped_with_prorated_minimum_config (Hash{Symbol=>Object}) (defaults to: )
  • grouped_with_metered_minimum_config (Hash{Symbol=>Object}) (defaults to: )
  • matrix_with_display_name_config (Hash{Symbol=>Object}) (defaults to: )
  • bulk_with_proration_config (Hash{Symbol=>Object}) (defaults to: )
  • grouped_tiered_package_config (Hash{Symbol=>Object}) (defaults to: )
  • scalable_matrix_with_unit_pricing_config (Hash{Symbol=>Object}) (defaults to: )
  • scalable_matrix_with_tiered_pricing_config (Hash{Symbol=>Object}) (defaults to: )
  • cumulative_grouped_bulk_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.

  • 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

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/orb/models/price_create_params.rb', line 254

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) 


49
 
# File 'lib/orb/models/price_create_params.rb', line 49

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) 


56
 
# File 'lib/orb/models/price_create_params.rb', line 56

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:



63
 
# File 'lib/orb/models/price_create_params.rb', line 63

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

#bps_config ⇒ Orb::Models::BPSConfig

Returns:



145
 
# File 'lib/orb/models/price_create_params.rb', line 145

required :bps_config, -> { Orb::BPSConfig }

#bulk_bps_config ⇒ Orb::Models::BulkBPSConfig

Returns:



150
 
# File 'lib/orb/models/price_create_params.rb', line 150

required :bulk_bps_config, -> { Orb::BulkBPSConfig }

#bulk_config ⇒ Orb::Models::BulkConfig

Returns:



155
 
# File 'lib/orb/models/price_create_params.rb', line 155

required :bulk_config, -> { Orb::BulkConfig }

#bulk_with_proration_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


230
 
# File 'lib/orb/models/price_create_params.rb', line 230

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

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

The cadence to bill for this price on.

Returns:



14
 
# File 'lib/orb/models/price_create_params.rb', line 14

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

#conversion_rate ⇒ Float?

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

Returns:

  • (Float, nil) 


69
 
# File 'lib/orb/models/price_create_params.rb', line 69

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:



75
 
# File 'lib/orb/models/price_create_params.rb', line 75

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

#cumulative_grouped_bulk_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


252
 
# File 'lib/orb/models/price_create_params.rb', line 252

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

#currency ⇒ String

An ISO 4217 currency string for which this price is billed in.

Returns:

  • (String) 


20
 
# File 'lib/orb/models/price_create_params.rb', line 20

required :currency, String

#dimensional_price_configuration ⇒ Orb::Models::NewDimensionalPriceConfiguration?

For dimensional price: specifies a price group and dimension values

Returns:



81
 
# File 'lib/orb/models/price_create_params.rb', line 81

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

#external_price_id ⇒ String?

An alias for the price.

Returns:

  • (String, nil) 


87
 
# File 'lib/orb/models/price_create_params.rb', line 87

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) 


94
 
# File 'lib/orb/models/price_create_params.rb', line 94

optional :fixed_price_quantity, Float, nil?: true

#grouped_allocation_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


210
 
# File 'lib/orb/models/price_create_params.rb', line 210

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

#grouped_tiered_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


170
 
# File 'lib/orb/models/price_create_params.rb', line 170

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

#grouped_tiered_package_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


235
 
# File 'lib/orb/models/price_create_params.rb', line 235

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

#grouped_with_metered_minimum_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


220
 
# File 'lib/orb/models/price_create_params.rb', line 220

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

#grouped_with_prorated_minimum_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


215
 
# File 'lib/orb/models/price_create_params.rb', line 215

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

#invoice_grouping_key ⇒ String?

The property used to group this price on an invoice

Returns:

  • (String, nil) 


100
 
# File 'lib/orb/models/price_create_params.rb', line 100

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:



107
 
# File 'lib/orb/models/price_create_params.rb', line 107

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

#item_id ⇒ String

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

Returns:

  • (String) 


26
 
# File 'lib/orb/models/price_create_params.rb', line 26

required :item_id, String

#matrix_config ⇒ Orb::Models::MatrixConfig

Returns:



125
 
# File 'lib/orb/models/price_create_params.rb', line 125

required :matrix_config, -> { Orb::MatrixConfig }

#matrix_with_allocation_config ⇒ Orb::Models::MatrixWithAllocationConfig

Returns:



130
 
# File 'lib/orb/models/price_create_params.rb', line 130

required :matrix_with_allocation_config, -> { Orb::MatrixWithAllocationConfig }

#matrix_with_display_name_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


225
 
# File 'lib/orb/models/price_create_params.rb', line 225

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

#max_group_tiered_package_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


175
 
# File 'lib/orb/models/price_create_params.rb', line 175

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

#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) 


115
 
# File 'lib/orb/models/price_create_params.rb', line 115

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

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

Returns:



31
 
# File 'lib/orb/models/price_create_params.rb', line 31

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

#name ⇒ String

The name of the price.

Returns:

  • (String) 


37
 
# File 'lib/orb/models/price_create_params.rb', line 37

required :name, String

#package_config ⇒ Orb::Models::PackageConfig

Returns:



120
 
# File 'lib/orb/models/price_create_params.rb', line 120

required :package_config, -> { Orb::PackageConfig }

#package_with_allocation_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


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

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

#scalable_matrix_with_tiered_pricing_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


246
247
 
# File 'lib/orb/models/price_create_params.rb', line 246

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

#scalable_matrix_with_unit_pricing_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


240
241
 
# File 'lib/orb/models/price_create_params.rb', line 240

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

#threshold_total_amount_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


160
 
# File 'lib/orb/models/price_create_params.rb', line 160

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

#tiered_bps_config ⇒ Orb::Models::TieredBPSConfig

Returns:



140
 
# File 'lib/orb/models/price_create_params.rb', line 140

required :tiered_bps_config, -> { Orb::TieredBPSConfig }

#tiered_config ⇒ Orb::Models::TieredConfig

Returns:



135
 
# File 'lib/orb/models/price_create_params.rb', line 135

required :tiered_config, -> { Orb::TieredConfig }

#tiered_package_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


165
 
# File 'lib/orb/models/price_create_params.rb', line 165

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

#tiered_package_with_minimum_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


190
 
# File 'lib/orb/models/price_create_params.rb', line 190

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

#tiered_with_minimum_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


180
 
# File 'lib/orb/models/price_create_params.rb', line 180

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

#tiered_with_proration_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


200
 
# File 'lib/orb/models/price_create_params.rb', line 200

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

#unit_config ⇒ Orb::Models::UnitConfig

Returns:



42
 
# File 'lib/orb/models/price_create_params.rb', line 42

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

#unit_with_percent_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


195
 
# File 'lib/orb/models/price_create_params.rb', line 195

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

#unit_with_proration_config ⇒ Hash{Symbol=>Object}

Returns:

  • (Hash{Symbol=>Object}) 


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

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/price_create_params.rb', line 359