Contents

module Recurly
  class Subscription < RecurlyAccountBase
    self.element_name = "subscription"

    def self.refund(account_code, refund_type = :partial)
      raise "Refund type must be :full or :partial." unless refund_type == :full or refund_type == :partial
      Subscription.delete(nil, {:account_code => account_code, :refund => refund_type})
    end

    # Stops the subscription from renewing. The subscription remains valid until the end of
    # the current term (current_period_ends_at).
    def cancel(account_code)
      Subscription.delete(account_code)
    end

    # Terminates the subscription immediately and processes a full or partial refund
    def refund(refund_type)
      raise "Refund type must be :full or :partial." unless refund_type == :full or refund_type == :partial
      Subscription.delete(nil, {:account_code => self.subscription_account_code, :refund => refund_type})
    end

    # Valid timeframe: :now or :renewal
    # Valid options: plan_code, quantity, unit_amount
    def change(timeframe, options = {})
      raise "Timeframe must be :full or :renewal." unless timeframe == 'now' or timeframe == 'renewal'
      options[:timeframe] = timeframe
      path = "/accounts/#{CGI::escape(self.subscription_account_code || '')}/subscription.xml"
      connection.put(path,
        self.class.format.encode(options, :root => :subscription),
        self.class.headers)
    end

    def subscription_account_code
      acct_code = self.account_code if defined?(self.account_code) and !self.account_code.nil? and !self.account_code.blank?
      acct_code ||= account.account_code if defined?(account) and !account.nil?
      acct_code ||= self.primary_key if defined?(self.primary_key)
      acct_code ||= self.id if defined?(self.id)
      raise 'Missing Account Code' if acct_code.nil? or acct_code.blank?
      acct_code
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
recurly-0.2.1	lib/recurly/subscription.rb
recurly-0.2.0	lib/recurly/subscription.rb