subscription.rb in recurly-3.3.0

- old
+ new

@@ -5,11 +5,11 @@
 module Recurly
   module Resources
     class Subscription < Resource
 
       # @!attribute account
-      #   @return [AccountMini]
+      #   @return [AccountMini] Account mini details
       define_attribute :account, :AccountMini
 
       # @!attribute activated_at
       #   @return [DateTime] Activated at
       define_attribute :activated_at, DateTime
@@ -65,11 +65,11 @@
       # @!attribute current_term_started_at
       #   @return [DateTime] The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing periods.
       define_attribute :current_term_started_at, DateTime
 
       # @!attribute custom_fields
-      #   @return [Array[CustomField]]
+      #   @return [Array[CustomField]] The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
       define_attribute :custom_fields, Array, { :item_type => :CustomField }
 
       # @!attribute customer_notes
       #   @return [String] Customer notes
       define_attribute :customer_notes, String
@@ -97,15 +97,15 @@
       # @!attribute paused_at
       #   @return [DateTime] Null unless subscription is paused or will pause at the end of the current billing period.
       define_attribute :paused_at, DateTime
 
       # @!attribute pending_change
-      #   @return [SubscriptionChange]
+      #   @return [SubscriptionChange] Subscription Change
       define_attribute :pending_change, :SubscriptionChange
 
       # @!attribute plan
-      #   @return [PlanMini]
+      #   @return [PlanMini] Just the important parts.
       define_attribute :plan, :PlanMini
 
       # @!attribute po_number
       #   @return [String] For manual invoicing, this identifies the PO number associated with the subscription.
       define_attribute :po_number, String
@@ -125,10 +125,10 @@
       # @!attribute renewal_billing_cycles
       #   @return [Integer] If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.
       define_attribute :renewal_billing_cycles, Integer
 
       # @!attribute shipping
-      #   @return [SubscriptionShipping]
+      #   @return [SubscriptionShipping] Subscription shipping details
       define_attribute :shipping, :SubscriptionShipping
 
       # @!attribute state
       #   @return [String] State
       define_attribute :state, String