Module: Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption

Extended by:

Internal::Type::Enum

Defined in:

lib/orb/models/subscription_schedule_plan_change_params.rb

Constant Summary

REQUESTED_DATE =

:requested_date

END_OF_SUBSCRIPTION_TERM =

:end_of_subscription_term

IMMEDIATE =

:immediate

Instance Method Summary

• #initialize(change_option: , add_adjustments: nil, add_prices: nil, align_billing_with_plan_change_date: nil, auto_collection: nil, billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, change_date: nil, coupon_redemption_code: nil, credits_overage_rate: nil, default_invoice_memo: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) ⇒ Object

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

Methods included from Internal::Type::Enum

==, ===, coerce, dump, hash, inspect, to_sorbet_type, values

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Instance Method Details

#initialize(change_option: , add_adjustments: nil, add_prices: nil, align_billing_with_plan_change_date: nil, auto_collection: nil, billing_cycle_alignment: nil, billing_cycle_anchor_configuration: nil, change_date: nil, coupon_redemption_code: nil, credits_overage_rate: nil, default_invoice_memo: nil, external_plan_id: nil, filter: nil, initial_phase_order: nil, invoicing_threshold: nil, net_terms: nil, per_credit_overage_amount: nil, plan_id: nil, plan_version_number: nil, price_overrides: nil, remove_adjustments: nil, remove_prices: nil, replace_adjustments: nil, replace_prices: nil, trial_duration_days: nil, usage_customer_ids: nil, request_options: {}) ⇒ Object

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

Parameters:

• change_option (Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::ChangeOption) (defaults to: )
• add_adjustments (Array<Orb::Models::SubscriptionSchedulePlanChangeParams::AddAdjustment>, nil) (defaults to: nil) —

  Additional adjustments to be added to the subscription. (Only available for acco

• add_prices (Array<Orb::Models::SubscriptionSchedulePlanChangeParams::AddPrice>, nil) (defaults to: nil) —

  Additional prices to be added to the subscription. (Only available for accounts

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

  DEPRECATED

  Use billing_cycle_alignment instead. Reset billing periods to be al

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

  Determines whether issued invoices for this subscription will automatically be c

• billing_cycle_alignment (Symbol, Orb::Models::SubscriptionSchedulePlanChangeParams::BillingCycleAlignment, nil) (defaults to: nil) —

  Reset billing periods to be aligned with the plan change’s effective date or sta

• billing_cycle_anchor_configuration (Orb::Models::BillingCycleAnchorConfiguration, nil) (defaults to: nil)
• change_date (Time, nil) (defaults to: nil) —

  The date that the plan change should take effect. This parameter can only be pas

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

  Redemption code to be used for this subscription. If the coupon cannot be found

• credits_overage_rate (Float, nil) (defaults to: nil)
• default_invoice_memo (String, nil) (defaults to: nil) —

  Determines the default memo on this subscription’s invoices. Note that if this i

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

  The external_plan_id of the plan that the given subscription should be switched

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

  An additional filter to apply to usage queries. This filter must be expressed as

• initial_phase_order (Integer, nil) (defaults to: nil) —

  The phase of the plan to start with

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

  When this subscription’s accrued usage reaches this threshold, an invoice will b

• net_terms (Integer, nil) (defaults to: nil) —

  The net terms determines the difference between the invoice date and the issue d

• per_credit_overage_amount (Float, nil) (defaults to: nil)
• plan_id (String, nil) (defaults to: nil) —

  The plan that the given subscription should be switched to. Note that either thi

• plan_version_number (Integer, nil) (defaults to: nil) —

  Specifies which version of the plan to change to. If null, the default version w

• price_overrides (Array<Object>, nil) (defaults to: nil) —

  Optionally provide a list of overrides for prices on the plan

• remove_adjustments (Array<Orb::Models::SubscriptionSchedulePlanChangeParams::RemoveAdjustment>, nil) (defaults to: nil) —

  Plan adjustments to be removed from the subscription. (Only available for accoun

• remove_prices (Array<Orb::Models::SubscriptionSchedulePlanChangeParams::RemovePrice>, nil) (defaults to: nil) —

  Plan prices to be removed from the subscription. (Only available for accounts th

• replace_adjustments (Array<Orb::Models::SubscriptionSchedulePlanChangeParams::ReplaceAdjustment>, nil) (defaults to: nil) —

  Plan adjustments to be replaced with additional adjustments on the subscription.

• replace_prices (Array<Orb::Models::SubscriptionSchedulePlanChangeParams::ReplacePrice>, nil) (defaults to: nil) —

  Plan prices to be replaced with additional prices on the subscription. (Only ava

• trial_duration_days (Integer, nil) (defaults to: nil) —

  The duration of the trial period in days. If not provided, this defaults to the

• usage_customer_ids (Array<String>, nil) (defaults to: nil) —

  A list of customer IDs whose usage events will be aggregated and billed under th

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

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

module ChangeOption
  extend Orb::Internal::Type::Enum

  REQUESTED_DATE = :requested_date
  END_OF_SUBSCRIPTION_TERM = :end_of_subscription_term
  IMMEDIATE = :immediate

  # @!method self.values
  #   @return [Array<Symbol>]
end