Class: MetronomeSDK::Models::V1::Customers::PlanListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/customers/plan_list_response.rb,
sig/metronome_sdk/models/v1/customers/plan_list_response.rbs

Overview

See Also:

  • MetronomeSDK::Resources::V1::Customers::Plans#list

Defined Under Namespace

Classes: TrialInfo

Instance Attribute 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(id:, custom_fields:, plan_description:, plan_id:, plan_name:, starting_on:, ending_before: nil, net_payment_terms_days: nil, trial_info: nil) ⇒ Object

Parameters:

  • id (String) —

    the ID of the customer plan

  • custom_fields (Hash{Symbol=>String}) —

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

  • plan_description (String)
  • plan_id (String) —

    the ID of the plan

  • plan_name (String)
  • starting_on (Time)
  • ending_before (Time) (defaults to: nil)
  • net_payment_terms_days (Float) (defaults to: nil)
  • trial_info (MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo) (defaults to: nil) 



# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 57

Instance Attribute Details

#custom_fields ⇒ Hash{Symbol=>String}

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

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


19
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 19

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

#ending_before ⇒ Time?

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


45
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 45

optional :ending_before, Time

#id ⇒ String

the ID of the customer plan

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 13

required :id, String

#net_payment_terms_days ⇒ Float?

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


50
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 50

optional :net_payment_terms_days, Float

#plan_description ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


24
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 24

required :plan_description, String

#plan_id ⇒ String

the ID of the plan

Parameters:

  • value (String)

Returns:

  • (String) 


30
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 30

required :plan_id, String

#plan_name ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


35
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 35

required :plan_name, String

#starting_on ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


40
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 40

required :starting_on, Time

#trial_info ⇒ MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo?

Returns:



55
 
# File 'lib/metronome_sdk/models/v1/customers/plan_list_response.rb', line 55

optional :trial_info, -> { MetronomeSDK::Models::V1::Customers::PlanListResponse::TrialInfo }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


57
 
# File 'sig/metronome_sdk/models/v1/customers/plan_list_response.rbs', line 57

def to_hash: -> {