Class: Orb::Models::SubscriptionCancelParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::SubscriptionCancelParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/orb/models/subscription_cancel_params.rb

Overview

See Also:

• Resources::Subscriptions#cancel

Defined Under Namespace

Modules: CancelOption

Instance Attribute Summary

• #allow_invoice_credit_or_void ⇒ Boolean^?

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

• #cancel_option ⇒ Symbol, Orb::Models::SubscriptionCancelParams::CancelOption

  Determines the timing of subscription cancellation.

• #cancellation_date ⇒ Time^?

  The date that the cancellation should take effect.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(cancel_option: , allow_invoice_credit_or_void: nil, cancellation_date: nil, request_options: {}) ⇒ Object constructor

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

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(cancel_option: , allow_invoice_credit_or_void: nil, cancellation_date: nil, request_options: {}) ⇒ Object

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

Parameters:

• cancel_option (Symbol, Orb::Models::SubscriptionCancelParams::CancelOption) (defaults to: ) —

  Determines the timing of subscription cancellation

• 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

• cancellation_date (Time, nil) (defaults to: nil) —

  The date that the cancellation should take effect. This parameter can only be pa

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

# File 'lib/orb/models/subscription_cancel_params.rb', line 31

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)

# File 'lib/orb/models/subscription_cancel_params.rb', line 22

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

#cancel_option ⇒ Symbol, Orb::Models::SubscriptionCancelParams::CancelOption

Determines the timing of subscription cancellation

Returns:

• (Symbol, Orb::Models::SubscriptionCancelParams::CancelOption)

# File 'lib/orb/models/subscription_cancel_params.rb', line 14

required :cancel_option, enum: -> { Orb::SubscriptionCancelParams::CancelOption }

#cancellation_date ⇒ Time^?

The date that the cancellation should take effect. This parameter can only be passed if the ‘cancel_option` is `requested_date`.

Returns:

• (Time, nil)

# File 'lib/orb/models/subscription_cancel_params.rb', line 29

optional :cancellation_date, Time, nil?: true