Class: Orb::Models::SubscriptionPriceIntervalsParams::AddAdjustment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/subscription_price_intervals_params.rb

Defined Under Namespace

Modules: Adjustment, EndDate, StartDate

Instance Attribute Summary collapse

Class Method 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(adjustment: , start_date: , end_date: nil) ⇒ Object

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

Parameters:




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

Instance Attribute Details

#adjustment ⇒ Orb::Models::NewPercentageDiscount, ...

The definition of a new adjustment to create and add to the subscription.

Returns:



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

required :adjustment, union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::Adjustment }

#end_date ⇒ Time, ...

The end date of the adjustment interval. This is the date that the adjustment will stop affecting prices on the subscription. The adjustment will apply to invoice dates that overlap with this ‘end_date`.This `end_date` is treated as exclusive for in-advance prices, and inclusive for in-arrears prices.

Returns:



401
402
403
 
# File 'lib/orb/models/subscription_price_intervals_params.rb', line 401

optional :end_date,
union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::EndDate },
nil?: true

#start_date ⇒ Time, ...

The start date of the adjustment interval. This is the date that the adjustment will start affecting prices on the subscription. The adjustment will apply to invoice dates that overlap with this ‘start_date`. This `start_date` is treated as inclusive for in-advance prices, and exclusive for in-arrears prices.

Returns:



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

required :start_date, union: -> { Orb::SubscriptionPriceIntervalsParams::AddAdjustment::StartDate }

Class Method Details

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

Returns:




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