Class: MetronomeSDK::Models::V1::PlanDetail

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/metronome_sdk/models/v1/plan_detail.rb

Defined Under Namespace

Classes: CreditGrant, Minimum, OverageRate

Instance Attribute Summary

• #credit_grants ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>^?
• #custom_fields ⇒ Hash{Symbol=>String}

  Custom fields to be added eg.

• #description ⇒ String^?
• #id ⇒ String
• #minimums ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>^?
• #name ⇒ String
• #overage_rates ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>^?

Instance Method Summary

• #initialize(credit_type: , name: , start_period: , value: ) ⇒ Object constructor

  Some parameter documentations has been truncated, see Minimum for more details.

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(credit_type: , name: , start_period: , value: ) ⇒ Object

Some parameter documentations has been truncated, see Minimum for more details.

Parameters:

• credit_type (MetronomeSDK::Models::CreditTypeData) (defaults to: )
• name (String) (defaults to: )
• start_period (Float) (defaults to: ) —

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

• value (Float) (defaults to: )

# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 116

Instance Attribute Details

#credit_grants ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>^?

Returns:

• (Array<MetronomeSDK::Models::V1::PlanDetail::CreditGrant>, nil)

# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 26

optional :credit_grants,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::CreditGrant] }

#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_detail.rb', line 16

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

#description ⇒ String^?

Returns:

• (String, nil)

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

optional :description, String

#id ⇒ String

Returns:

• (String)

# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 10

required :id, String

#minimums ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>^?

Returns:

• (Array<MetronomeSDK::Models::V1::PlanDetail::Minimum>, nil)

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

optional :minimums, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::Minimum] }

#name ⇒ String

Returns:

• (String)

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

required :name, String

#overage_rates ⇒ Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>^?

Returns:

• (Array<MetronomeSDK::Models::V1::PlanDetail::OverageRate>, nil)

# File 'lib/metronome_sdk/models/v1/plan_detail.rb', line 42

optional :overage_rates,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::PlanDetail::OverageRate] }