Class: Braintree::Subscription

Inherits:

Object

• Object
• Braintree::Subscription

show all

Includes:

BaseModule

Defined in:

lib/braintree/subscription.rb

Overview

Defined Under Namespace

Modules: Status, TrialDurationUnit

Instance Attribute Summary (collapse)

• - (Object) add_ons readonly

  Returns the value of attribute add_ons.

• - (Object) balance readonly

  Returns the value of attribute balance.

• - (Object) billing_day_of_month readonly

  Returns the value of attribute billing_day_of_month.

• - (Object) billing_period_end_date readonly

  Returns the value of attribute billing_period_end_date.

• - (Object) billing_period_start_date readonly

  Returns the value of attribute billing_period_start_date.

• - (Object) days_past_due readonly

  Returns the value of attribute days_past_due.

• - (Object) descriptor readonly

  Returns the value of attribute descriptor.

• - (Object) discounts readonly

  Returns the value of attribute discounts.

• - (Object) failure_count readonly

  Returns the value of attribute failure_count.

• - (Object) first_billing_date readonly

  Returns the value of attribute first_billing_date.

• - (Object) id readonly

  Returns the value of attribute id.

• - (Object) merchant_account_id readonly

  Returns the value of attribute merchant_account_id.

• - (Object) next_billing_date readonly

  Returns the value of attribute next_billing_date.

• - (Object) next_billing_period_amount readonly

  Returns the value of attribute next_billing_period_amount.

• - (Object) number_of_billing_cycles readonly

  Returns the value of attribute number_of_billing_cycles.

• - (Object) paid_through_date readonly

  Returns the value of attribute paid_through_date.

• - (Object) payment_method_token readonly

  Returns the value of attribute payment_method_token.

• - (Object) plan_id readonly

  Returns the value of attribute plan_id.

• - (Object) price readonly

  Returns the value of attribute price.

• - (Object) status readonly

  Returns the value of attribute status.

• - (Object) transactions readonly

  Returns the value of attribute transactions.

• - (Object) trial_duration readonly

  Returns the value of attribute trial_duration.

• - (Object) trial_duration_unit readonly

  Returns the value of attribute trial_duration_unit.

• - (Object) trial_period readonly

  Returns the value of attribute trial_period.

Class Method Summary (collapse)

• + (Object) _new(*args)

  :nodoc:.

• + (Object) cancel(subscription_id)

  See www.braintreepayments.com/docs/ruby/subscriptions/cancel.

• + (Object) create(attributes)

  See www.braintreepayments.com/docs/ruby/subscriptions/create.

• + (Object) create!(attributes)
• + (Object) find(id)

  See www.braintreepayments.com/docs/ruby/subscriptions/search.

• + (Object) retry_charge(subscription_id, amount = nil)
• + (Object) search(&block)

  See www.braintreepayments.com/docs/ruby/subscriptions/search.

• + (Object) update(subscription_id, attributes)

  See www.braintreepayments.com/docs/ruby/subscriptions/update.

• + (Object) update!(subscription_id, attributes)

Instance Method Summary (collapse)

• - (Object) ==(other)

  True if other has the same id.

• - (Subscription) initialize(gateway, attributes) constructor

  :nodoc:.

• - (Boolean) never_expires?
• - (Object) next_bill_amount

Methods included from BaseModule

included

Methods included from BaseModule::Methods

#copy_instance_variables_from_object, #return_object_or_raise, #set_instance_variables_from_hash, #singleton_class

69
70
71
72
73
74
75
76
77
78

# File 'lib/braintree/subscription.rb', line 69

def initialize(gateway, attributes) # :nodoc:
  @gateway = gateway
  set_instance_variables_from_hash(attributes)
  @balance = Util.to_big_decimal(balance)
  @price = Util.to_big_decimal(price)
  @descriptor = Descriptor.new(@descriptor)
  transactions.map! { |attrs| Transaction._new(gateway, attrs) }
  add_ons.map! { |attrs| AddOn._new(attrs) }
  discounts.map! { |attrs| Discount._new(attrs) }
end

29
30
31

# File 'lib/braintree/subscription.rb', line 29

def add_ons
  @add_ons
end

23
24
25

# File 'lib/braintree/subscription.rb', line 23

def balance
  @balance
end

28
29
30

# File 'lib/braintree/subscription.rb', line 28

def billing_day_of_month
  @billing_day_of_month
end

22
23
24

# File 'lib/braintree/subscription.rb', line 22

def billing_period_end_date
  @billing_period_end_date
end

22
23
24

# File 'lib/braintree/subscription.rb', line 22

def billing_period_start_date
  @billing_period_start_date
end

21
22
23

# File 'lib/braintree/subscription.rb', line 21

def days_past_due
  @days_past_due
end

30
31
32

# File 'lib/braintree/subscription.rb', line 30

def descriptor
  @descriptor
end

29
30
31

# File 'lib/braintree/subscription.rb', line 29

def discounts
  @discounts
end

25
26
27

# File 'lib/braintree/subscription.rb', line 25

def failure_count
  @failure_count
end

22
23
24

# File 'lib/braintree/subscription.rb', line 22

def first_billing_date
  @first_billing_date
end

21
22
23

# File 'lib/braintree/subscription.rb', line 21

def id
  @id
end

21
22
23

# File 'lib/braintree/subscription.rb', line 21

def merchant_account_id
  @merchant_account_id
end

22
23
24

# File 'lib/braintree/subscription.rb', line 22

def next_billing_date
  @next_billing_date
end

27
28
29

# File 'lib/braintree/subscription.rb', line 27

def next_billing_period_amount
  @next_billing_period_amount
end

28
29
30

# File 'lib/braintree/subscription.rb', line 28

def number_of_billing_cycles
  @number_of_billing_cycles
end

23
24
25

# File 'lib/braintree/subscription.rb', line 23

def paid_through_date
  @paid_through_date
end

21
22
23

# File 'lib/braintree/subscription.rb', line 21

def payment_method_token
  @payment_method_token
end

21
22
23

# File 'lib/braintree/subscription.rb', line 21

def plan_id
  @plan_id
end

21
22
23

# File 'lib/braintree/subscription.rb', line 21

def price
  @price
end

21
22
23

# File 'lib/braintree/subscription.rb', line 21

def status
  @status
end

26
27
28

# File 'lib/braintree/subscription.rb', line 26

def transactions
  @transactions
end

24
25
26

# File 'lib/braintree/subscription.rb', line 24

def trial_duration
  @trial_duration
end

24
25
26

# File 'lib/braintree/subscription.rb', line 24

def trial_duration_unit
  @trial_duration_unit
end

24
25
26

# File 'lib/braintree/subscription.rb', line 24

def trial_period
  @trial_period
end

97
98
99

# File 'lib/braintree/subscription.rb', line 97

def _new(*args) # :nodoc:
  self.new *args
end

33
34
35

# File 'lib/braintree/subscription.rb', line 33

def self.cancel(subscription_id)
  Configuration.gateway.subscription.cancel(subscription_id)
end

38
39
40

# File 'lib/braintree/subscription.rb', line 38

def self.create(attributes)
  Configuration.gateway.subscription.create(attributes)
end

42
43
44

# File 'lib/braintree/subscription.rb', line 42

def self.create!(attributes)
  return_object_or_raise(:subscription) { create(attributes) }
end

47
48
49

# File 'lib/braintree/subscription.rb', line 47

def self.find(id)
  Configuration.gateway.subscription.find(id)
end

51
52
53

# File 'lib/braintree/subscription.rb', line 51

def self.retry_charge(subscription_id, amount=nil)
  Configuration.gateway.transaction.retry_subscription_charge(subscription_id, amount)
end

56
57
58

# File 'lib/braintree/subscription.rb', line 56

def self.search(&block)
  Configuration.gateway.subscription.search(&block)
end

61
62
63

# File 'lib/braintree/subscription.rb', line 61

def self.update(subscription_id, attributes)
  Configuration.gateway.subscription.update(subscription_id, attributes)
end

65
66
67

# File 'lib/braintree/subscription.rb', line 65

def self.update!(subscription_id, attributes)
  return_object_or_raise(:subscription) { update(subscription_id, attributes) }
end

90
91
92
93

# File 'lib/braintree/subscription.rb', line 90

def ==(other)
  return false unless other.is_a?(Subscription)
  id == other.id
end

85
86
87

# File 'lib/braintree/subscription.rb', line 85

def never_expires?
  @never_expires
end

80
81
82
83

# File 'lib/braintree/subscription.rb', line 80

def next_bill_amount
  warn "[DEPRECATED] Subscription.next_bill_amount is deprecated. Please use Subscription.next_billing_period_amount"
  @next_bill_amount
end