subscription.rb in recurly-3.0.0.beta.3

- old
+ new

@@ -1,12 +1,12 @@
 module Recurly
   module Resources
     class Subscription < Resource
 
       # @!attribute account
-      #   @return [Account]
-      define_attribute :account, :Account
+      #   @return [AccountMini]
+      define_attribute :account, :AccountMini
 
       # @!attribute activated_at
       #   @return [DateTime] Activated at
       define_attribute :activated_at, DateTime
 
@@ -16,10 +16,14 @@
 
       # @!attribute add_ons_total
       #   @return [Float] Total price of add-ons
       define_attribute :add_ons_total, Float
 
+      # @!attribute auto_renew
+      #   @return [Boolean] Whether the subscription renews at the end of its term.
+      define_attribute :auto_renew, :Boolean
+
       # @!attribute bank_account_authorized_at
       #   @return [DateTime] Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared.
       define_attribute :bank_account_authorized_at, DateTime
 
       # @!attribute canceled_at
@@ -48,10 +52,22 @@
 
       # @!attribute current_period_started_at
       #   @return [DateTime] Current billing period started at
       define_attribute :current_period_started_at, DateTime
 
+      # @!attribute current_term_ends_at
+      #   @return [DateTime] When the term ends. This is calculated by a plan's interval and `total_billing_cycles` in a term. Subscription changes with a `timeframe=renewal` will be applied on this date.
+      define_attribute :current_term_ends_at, DateTime
+
+      # @!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]]
+      define_attribute :custom_fields, Array, {:item_type => :CustomField}
+
       # @!attribute customer_notes
       #   @return [String] Customer notes
       define_attribute :customer_notes, String
 
       # @!attribute expiration_reason
@@ -72,30 +88,42 @@
 
       # @!attribute object
       #   @return [String] Object type
       define_attribute :object, String
 
+      # @!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]
       define_attribute :pending_change, :SubscriptionChange
 
       # @!attribute plan
-      #   @return [Plan]
-      define_attribute :plan, :Plan
+      #   @return [PlanMini]
+      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
 
       # @!attribute quantity
       #   @return [Integer] Subscription quantity
       define_attribute :quantity, Integer
 
       # @!attribute remaining_billing_cycles
-      #   @return [Integer] Remaining billing cycles
+      #   @return [Integer] The remaining billing cycles in the current term.
       define_attribute :remaining_billing_cycles, Integer
 
+      # @!attribute remaining_pause_cycles
+      #   @return [Integer] Null unless subscription is paused or will pause at the end of the current billing period.
+      define_attribute :remaining_pause_cycles, Integer
+
+      # @!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_address
       #   @return [ShippingAddress]
       define_attribute :shipping_address, :ShippingAddress
 
       # @!attribute state
@@ -107,9 +135,13 @@
       define_attribute :subtotal, Float
 
       # @!attribute terms_and_conditions
       #   @return [String] Terms and conditions
       define_attribute :terms_and_conditions, String
+
+      # @!attribute total_billing_cycles
+      #   @return [Integer] The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.
+      define_attribute :total_billing_cycles, Integer
 
       # @!attribute trial_ends_at
       #   @return [DateTime] Trial period ends at
       define_attribute :trial_ends_at, DateTime
 