Class: Orb::Models::SubscriptionPriceIntervalsParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/subscription_price_intervals_params.rb

Overview

See Also:

Defined Under Namespace

Classes: Add, AddAdjustment, Edit, EditAdjustment

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class 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, #initialize, 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

This class inherits a constructor from Orb::Internal::Type::BaseModel

Instance Attribute Details

#add ⇒ Array<Orb::Models::SubscriptionPriceIntervalsParams::Add>?

A list of price intervals to add to the subscription.

Returns:



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

optional :add, -> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Add] }

#add_adjustments ⇒ Array<Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment>?

A list of adjustments to add to the subscription.

Returns:



20
21
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 20

optional :add_adjustments,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::AddAdjustment] }

#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) 


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

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

#edit ⇒ Array<Orb::Models::SubscriptionPriceIntervalsParams::Edit>?

A list of price intervals to edit on the subscription.

Returns:



35
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 35

optional :edit, -> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::Edit] }

#edit_adjustments ⇒ Array<Orb::Models::SubscriptionPriceIntervalsParams::EditAdjustment>?

A list of adjustments to edit on the subscription.

Returns:



41
42
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 41

optional :edit_adjustments,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionPriceIntervalsParams::EditAdjustment] }

Class Method Details

.variants ⇒ Array(Time, Symbol, Orb::Models::BillingCycleRelativeDate)

Returns:




# File 'lib/orb/models/subscription_price_intervals_params.rb', line 373