Class: MetronomeSDK::Models::V1::PlanListChargesResponse

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MetronomeSDK::Models::V1::PlanListChargesResponse

Defined in:

lib/metronome_sdk/models/v1/plan_list_charges_response.rb

Overview

See Also:

• Resources::V1::Plans#list_charges

Defined Under Namespace

Modules: ChargeType Classes: Price, UnitConversion

Instance Attribute Summary

• #charge_type ⇒ Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType
• #credit_type ⇒ MetronomeSDK::Models::CreditTypeData
• #custom_fields ⇒ Hash{Symbol=>String}

  Custom fields to be added eg.

• #id ⇒ String
• #name ⇒ String
• #prices ⇒ Array<MetronomeSDK::Models::V1::PlanListChargesResponse::Price>
• #product_id ⇒ String
• #product_name ⇒ String
• #quantity ⇒ Float^?
• #start_period ⇒ Float^?

  Used in price ramps.

• #tier_reset_frequency ⇒ Float^?

  Used in pricing tiers.

• #unit_conversion ⇒ MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion^?

  Specifies how quantities for usage based charges will be converted.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(tier:, value:, collection_interval: nil, collection_schedule: nil, quantity: nil) ⇒ Object constructor

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(tier:, value:, collection_interval: nil, collection_schedule: nil, quantity: nil) ⇒ Object

Parameters:

• tier (Float) —

  Used in pricing tiers. Indicates at what metric value the price applies.

• value (Float)
• collection_interval (Float) (defaults to: nil)
• collection_schedule (String) (defaults to: nil)
• quantity (Float) (defaults to: nil)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 75

Instance Attribute Details

#charge_type ⇒ Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType

Returns:

• (Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 16

required :charge_type, enum: -> { MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType }

#credit_type ⇒ MetronomeSDK::Models::CreditTypeData

Returns:

• (MetronomeSDK::Models::CreditTypeData)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 21

required :credit_type, -> { MetronomeSDK::CreditTypeData }

#custom_fields ⇒ Hash{Symbol=>String}

Custom fields to be added eg. { “key1”: “value1”, “key2”: “value2” }

Returns:

• (Hash{Symbol=>String})

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 27

required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]

#id ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 11

required :id, String

#name ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 32

required :name, String

#prices ⇒ Array<MetronomeSDK::Models::V1::PlanListChargesResponse::Price>

Returns:

• (Array<MetronomeSDK::Models::V1::PlanListChargesResponse::Price>)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 37

required :prices,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PlanListChargesResponse::Price] }

#product_id ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 43

required :product_id, String

#product_name ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 48

required :product_name, String

#quantity ⇒ Float^?

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 53

optional :quantity, Float

#start_period ⇒ Float^?

Used in price ramps. Indicates how many billing periods pass before the charge applies.

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 60

optional :start_period, Float

#tier_reset_frequency ⇒ Float^?

Used in pricing tiers. Indicates how often the tier resets. Default is 1 - the tier count resets every billing period.

Returns:

• (Float, nil)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 67

optional :tier_reset_frequency, Float

#unit_conversion ⇒ MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion^?

Specifies how quantities for usage based charges will be converted.

Returns:

• (MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion, nil)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 73

optional :unit_conversion, -> { MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/metronome_sdk/models/v1/plan_list_charges_response.rb', line 113