lib/recurly/requests/subscription_change_create.rb in recurly-3.2.2 vs lib/recurly/requests/subscription_change_create.rb in recurly-3.3.0
- old
+ new
@@ -37,10 +37,10 @@
# @!attribute quantity
# @return [Integer] Optionally override the default quantity of 1.
define_attribute :quantity, Integer
# @!attribute shipping
- # @return [SubscriptionChangeShippingCreate]
+ # @return [SubscriptionChangeShippingCreate] The shipping address can currently only be changed immediately, using SubscriptionUpdate.
define_attribute :shipping, :SubscriptionChangeShippingCreate
# @!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