Class: MetronomeSDK::Models::V1::Customers::PlanEndParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/customers/plan_end_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

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(customer_id: , customer_plan_id: , ending_before: nil, void_invoices: nil, void_stripe_invoices: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::Customers::PlanEndParams for more details.

Parameters:

  • customer_id (String) (defaults to: )
  • customer_plan_id (String) (defaults to: )
  • ending_before (Time) (defaults to: nil) —

    RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be

  • void_invoices (Boolean) (defaults to: nil) —

    If true, plan end date can be before the last finalized invoice date. Any invoic

  • void_stripe_invoices (Boolean) (defaults to: nil) —

    Only applicable when void_invoices is set to true. If true, for every invoice th

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



# File 'lib/metronome_sdk/models/v1/customers/plan_end_params.rb', line 44

Instance Attribute Details

#customer_id ⇒ String

Returns:

  • (String) 


15
 
# File 'lib/metronome_sdk/models/v1/customers/plan_end_params.rb', line 15

required :customer_id, String

#customer_plan_id ⇒ String

Returns:

  • (String) 


20
 
# File 'lib/metronome_sdk/models/v1/customers/plan_end_params.rb', line 20

required :customer_plan_id, String

#ending_before ⇒ Time?

RFC 3339 timestamp for when the plan ends (exclusive) for this customer. Must be at 0:00 UTC (midnight). If not provided, the plan end date will be cleared.

Returns:

  • (Time, nil) 


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

optional :ending_before, Time

#void_invoices ⇒ Boolean?

If true, plan end date can be before the last finalized invoice date. Any invoices generated after the plan end date will be voided.

Returns:

  • (Boolean, nil) 


34
 
# File 'lib/metronome_sdk/models/v1/customers/plan_end_params.rb', line 34

optional :void_invoices, MetronomeSDK::Internal::Type::Boolean

#void_stripe_invoices ⇒ Boolean?

Only applicable when void_invoices is set to true. If true, for every invoice that is voided we will also attempt to void/delete the stripe invoice (if any). Stripe invoices will be voided if finalized or deleted if still in draft state.

Returns:

  • (Boolean, nil) 


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

optional :void_stripe_invoices, MetronomeSDK::Internal::Type::Boolean