Class: Orb::Models::SubscriptionTriggerPhaseParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/subscription_trigger_phase_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(allow_invoice_credit_or_void: nil, effective_date: nil, request_options: {}) ⇒ Object

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

Parameters:

  • allow_invoice_credit_or_void (Boolean, nil) (defaults to: nil) —

    If false, this request will fail if it would void an issued invoice or create a

  • effective_date (Date, nil) (defaults to: nil) —

    The date on which the phase change should take effect. If not provided, defaults

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



# File 'lib/orb/models/subscription_trigger_phase_params.rb', line 25

Instance Attribute Details

#allow_invoice_credit_or_void ⇒ Boolean?

If false, this request will fail if it would void an issued invoice or create a credit note. Consider using this as a safety mechanism if you do not expect existing invoices to be changed.

Returns:

  • (Boolean, nil) 


16
 
# File 'lib/orb/models/subscription_trigger_phase_params.rb', line 16

optional :allow_invoice_credit_or_void, Orb::Internal::Type::Boolean, nil?: true

#effective_date ⇒ Date?

The date on which the phase change should take effect. If not provided, defaults to today in the customer’s timezone.

Returns:

  • (Date, nil) 


23
 
# File 'lib/orb/models/subscription_trigger_phase_params.rb', line 23

optional :effective_date, Date, nil?: true