Class: Orb::Models::SubscriptionSchedulePlanChangeParams

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

Overview

See Also:

Defined Under Namespace

Modules: BillingCycleAlignment, ChangeOption Classes: AddAdjustment, AddPrice, RemoveAdjustment, RemovePrice, ReplaceAdjustment, ReplacePrice

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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(external_price_id: nil, price_id: nil) ⇒ Object

Parameters:

  • external_price_id (String, nil) (defaults to: nil) —

    The external price id of the price to remove on the subscription.

  • price_id (String, nil) (defaults to: nil) —

    The id of the price to remove on the subscription.




# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 540

Instance Attribute Details

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

Additional adjustments to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



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

optional :add_adjustments,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionSchedulePlanChangeParams::AddAdjustment] },
nil?: true

#add_prices ⇒ Array<Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice>?

Additional prices to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



29
30
31
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 29

optional :add_prices,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionSchedulePlanChangeParams::AddPrice] },
nil?: true

#align_billing_with_plan_change_date ⇒ Boolean?

DEPRECATED

Use billing_cycle_alignment instead. Reset billing periods to be

aligned with the plan change’s effective date.

Returns:

  • (Boolean, nil) 


38
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 38

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

#auto_collection ⇒ Boolean?

Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. If not specified, this defaults to the behavior configured for this customer.

Returns:

  • (Boolean, nil) 


46
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 46

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

#billing_cycle_alignment ⇒ Symbol, ...

Reset billing periods to be aligned with the plan change’s effective date or start of the month. Defaults to ‘unchanged` which keeps subscription’s existing billing cycle alignment.

Returns:



54
55
56
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 54

optional :billing_cycle_alignment,
enum: -> { Orb::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment },
nil?: true

#billing_cycle_anchor_configuration ⇒ Orb::Models::BillingCycleAnchorConfiguration?

Returns:



61
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 61

optional :billing_cycle_anchor_configuration, -> { Orb::BillingCycleAnchorConfiguration }, nil?: true

#change_date ⇒ Time?

The date that the plan change should take effect. This parameter can only be passed if the ‘change_option` is `requested_date`. If a date with no time is passed, the plan change will happen at midnight in the customer’s timezone.

Returns:

  • (Time, nil) 


69
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 69

optional :change_date, Time, nil?: true

#change_option ⇒ Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption

Returns:



13
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 13

required :change_option, enum: -> { Orb::SubscriptionSchedulePlanChangeParams::ChangeOption }

#coupon_redemption_code ⇒ String?

Redemption code to be used for this subscription. If the coupon cannot be found by its redemption code, or cannot be redeemed, an error response will be returned and the subscription creation or plan change will not be scheduled.

Returns:

  • (String, nil) 


77
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 77

optional :coupon_redemption_code, String, nil?: true

#credits_overage_rate ⇒ Float?

Deprecated.

Returns:

  • (Float, nil) 


83
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 83

optional :credits_overage_rate, Float, nil?: true

#default_invoice_memo ⇒ String?

Determines the default memo on this subscription’s invoices. Note that if this is not provided, it is determined by the plan configuration.

Returns:

  • (String, nil) 


90
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 90

optional :default_invoice_memo, String, nil?: true

#external_plan_id ⇒ String?

The external_plan_id of the plan that the given subscription should be switched to. Note that either this property or ‘plan_id` must be specified.

Returns:

  • (String, nil) 


97
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 97

optional :external_plan_id, String, nil?: true

#filter ⇒ String?

An additional filter to apply to usage queries. This filter must be expressed as a boolean [computed property](/extensibility/advanced-metrics#computed-properties). If null, usage queries will not include any additional filter.

Returns:

  • (String, nil) 


106
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 106

optional :filter, String, nil?: true

#initial_phase_order ⇒ Integer?

The phase of the plan to start with

Returns:

  • (Integer, nil) 


112
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 112

optional :initial_phase_order, Integer, nil?: true

#invoicing_threshold ⇒ String?

When this subscription’s accrued usage reaches this threshold, an invoice will be issued for the subscription. If not specified, invoices will only be issued at the end of the billing period.

Returns:

  • (String, nil) 


120
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 120

optional :invoicing_threshold, String, nil?: true

#net_terms ⇒ Integer?

The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0. If not provided, this defaults to the value specified in the plan.

Returns:

  • (Integer, nil) 


128
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 128

optional :net_terms, Integer, nil?: true

#per_credit_overage_amount ⇒ Float?

Deprecated.

Returns:

  • (Float, nil) 


134
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 134

optional :per_credit_overage_amount, Float, nil?: true

#plan_id ⇒ String?

The plan that the given subscription should be switched to. Note that either this property or ‘external_plan_id` must be specified.

Returns:

  • (String, nil) 


141
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 141

optional :plan_id, String, nil?: true

#plan_version_number ⇒ Integer?

Specifies which version of the plan to change to. If null, the default version will be used.

Returns:

  • (Integer, nil) 


148
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 148

optional :plan_version_number, Integer, nil?: true

#price_overrides ⇒ Array<Object>?

Deprecated.

Optionally provide a list of overrides for prices on the plan

Returns:

  • (Array<Object>, nil) 


156
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 156

optional :price_overrides, Orb::Internal::Type::ArrayOf[Orb::Internal::Type::Unknown], nil?: true

#remove_adjustments ⇒ Array<Orb::Models::SubscriptionSchedulePlanChangeParams::RemoveAdjustment>?

Plan adjustments to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



163
164
165
166
167
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 163

optional :remove_adjustments,
-> {
  Orb::Internal::Type::ArrayOf[Orb::SubscriptionSchedulePlanChangeParams::RemoveAdjustment]
},
nil?: true

#remove_prices ⇒ Array<Orb::Models::SubscriptionSchedulePlanChangeParams::RemovePrice>?

Plan prices to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



174
175
176
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 174

optional :remove_prices,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionSchedulePlanChangeParams::RemovePrice] },
nil?: true

#replace_adjustments ⇒ Array<Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment>?

Plan adjustments to be replaced with additional adjustments on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



184
185
186
187
188
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 184

optional :replace_adjustments,
-> {
  Orb::Internal::Type::ArrayOf[Orb::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment]
},
nil?: true

#replace_prices ⇒ Array<Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice>?

Plan prices to be replaced with additional prices on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)

Returns:



195
196
197
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 195

optional :replace_prices,
-> { Orb::Internal::Type::ArrayOf[Orb::SubscriptionSchedulePlanChangeParams::ReplacePrice] },
nil?: true

#trial_duration_days ⇒ Integer?

The duration of the trial period in days. If not provided, this defaults to the value specified in the plan. If ‘0` is provided, the trial on the plan will be skipped.

Returns:

  • (Integer, nil) 


205
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 205

optional :trial_duration_days, Integer, nil?: true

#usage_customer_ids ⇒ Array<String>?

A list of customer IDs whose usage events will be aggregated and billed under this subscription. By default, a subscription only considers usage events associated with its attached customer’s customer_id. When usage_customer_ids is provided, the subscription includes usage events from the specified customers only. Provided usage_customer_ids must be either the customer for this subscription itself, or any of that customer’s children.

Returns:

  • (Array<String>, nil) 


216
 
# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 216

optional :usage_customer_ids, Orb::Internal::Type::ArrayOf[String], nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 283

.variants ⇒ Array(Orb::Models::NewPercentageDiscount, Orb::Models::NewUsageDiscount, Orb::Models::NewAmountDiscount, Orb::Models::NewMinimum, Orb::Models::NewMaximum)

Returns:




# File 'lib/orb/models/subscription_schedule_plan_change_params.rb', line 346