lib/recurly/requests/subscription_change_create.rb in recurly-3.28.0 vs lib/recurly/requests/subscription_change_create.rb in recurly-4.0.0
- old
+ new
@@ -5,17 +5,13 @@
module Recurly
module Requests
class SubscriptionChangeCreate < Request
# @!attribute add_ons
- # @return [Array[SubscriptionAddOnUpdate]] If this value is omitted your existing add-ons will be removed. If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on's ID: `{"id": "abc123"}`. If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request. - If an `id` is passed, any attributes not passed in will pull from the existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the current values of the plan add-on - Attributes passed in as part of the request will override either of the above scenarios
+ # @return [Array[SubscriptionAddOnUpdate]] If you provide a value for this field it will replace any existing add-ons. So, when adding or modifying an add-on, you need to include the existing subscription add-ons. Unchanged add-ons can be included just using the subscription add-on''s ID: `{"id": "abc123"}`. If this value is omitted your existing add-ons will be unaffected. To remove all existing add-ons, this value should be an empty array.' If a subscription add-on's `code` is supplied without the `id`, `{"code": "def456"}`, the subscription add-on attributes will be set to the current values of the plan add-on unless provided in the request. - If an `id` is passed, any attributes not passed in will pull from the existing subscription add-on - If a `code` is passed, any attributes not passed in will pull from the current values of the plan add-on - Attributes passed in as part of the request will override either of the above scenarios
define_attribute :add_ons, Array, { :item_type => :SubscriptionAddOnUpdate }
- # @!attribute billing_info
- # @return [SubscriptionChangeBillingInfoCreate]
- define_attribute :billing_info, :SubscriptionChangeBillingInfoCreate
-
# @!attribute collection_method
# @return [String] Collection method
define_attribute :collection_method, String
# @!attribute coupon_codes
@@ -44,24 +40,16 @@
# @!attribute quantity
# @return [Integer] Optionally override the default quantity of 1.
define_attribute :quantity, Integer
- # @!attribute ramp_intervals
- # @return [Array[SubscriptionRampInterval]] The new set of ramp intervals for the subscription.
- define_attribute :ramp_intervals, Array, { :item_type => :SubscriptionRampInterval }
-
# @!attribute revenue_schedule_type
# @return [String] Revenue schedule type
define_attribute :revenue_schedule_type, String
# @!attribute shipping
# @return [SubscriptionChangeShippingCreate] The shipping address can currently only be changed immediately, using SubscriptionUpdate.
define_attribute :shipping, :SubscriptionChangeShippingCreate
-
- # @!attribute tax_inclusive
- # @return [Boolean] This field is deprecated. Please do not use it.
- define_attribute :tax_inclusive, :Boolean
# @!attribute timeframe
# @return [String] The timeframe parameter controls when the upgrade or downgrade takes place. The subscription change can occur now, when the subscription is next billed, or when the subscription term ends. Generally, if you're performing an upgrade, you will want the change to occur immediately (now). If you're performing a downgrade, you should set the timeframe to `term_end` or `bill_date` so the change takes effect at a scheduled billing date. The `renewal` timeframe option is accepted as an alias for `term_end`.
define_attribute :timeframe, String