Class: Pay::Subscription

Inherits:
ApplicationRecord show all
Defined in:
app/models/pay/subscription.rb

Constant Summary collapse

STATUSES =
%w[incomplete incomplete_expired trialing active past_due canceled unpaid paused]

Instance Method Summary collapse

Methods inherited from ApplicationRecord

json_column?

Instance Method Details

#active?Boolean

Returns:

  • (Boolean)


56
57
58
# File 'app/models/pay/subscription.rb', line 56

def active?
  ["trialing", "active"].include?(status) && (ends_at.nil? || on_grace_period? || on_trial?)
end

#cancelObject



81
82
83
# File 'app/models/pay/subscription.rb', line 81

def cancel
  send("#{processor}_cancel")
end

#cancel_now!Object



85
86
87
# File 'app/models/pay/subscription.rb', line 85

def cancel_now!
  send("#{processor}_cancel_now!")
end

#canceled?Boolean

Returns:

  • (Boolean)


44
45
46
# File 'app/models/pay/subscription.rb', line 44

def canceled?
  ends_at?
end

#cancelled?Boolean

Returns:

  • (Boolean)


48
49
50
# File 'app/models/pay/subscription.rb', line 48

def cancelled?
  canceled?
end

#has_incomplete_payment?Boolean

Returns:

  • (Boolean)


68
69
70
# File 'app/models/pay/subscription.rb', line 68

def has_incomplete_payment?
  past_due? || incomplete?
end

#incomplete?Boolean

Returns:

  • (Boolean)


64
65
66
# File 'app/models/pay/subscription.rb', line 64

def incomplete?
  status == "incomplete"
end

#latest_paymentObject



124
125
126
127
# File 'app/models/pay/subscription.rb', line 124

def latest_payment
  return unless stripe?
  processor_subscription(expand: ["latest_invoice.payment_intent"]).latest_invoice.payment_intent
end

#no_prorateObject



32
33
34
# File 'app/models/pay/subscription.rb', line 32

def no_prorate
  self.prorate = false
end

#on_grace_period?Boolean

Returns:

  • (Boolean)


52
53
54
# File 'app/models/pay/subscription.rb', line 52

def on_grace_period?
  canceled? && Time.zone.now < ends_at
end

#on_trial?Boolean

Returns:

  • (Boolean)


40
41
42
# File 'app/models/pay/subscription.rb', line 40

def on_trial?
  trial_ends_at? && Time.zone.now < trial_ends_at
end

#past_due?Boolean

Returns:

  • (Boolean)


60
61
62
# File 'app/models/pay/subscription.rb', line 60

def past_due?
  status == "past_due"
end

#pauseObject



76
77
78
79
# File 'app/models/pay/subscription.rb', line 76

def pause
  return unless paddle?
  send("#{processor}_pause")
end

#paused?Boolean

Returns:

  • (Boolean)


72
73
74
# File 'app/models/pay/subscription.rb', line 72

def paused?
  status == "paused"
end

#processor_subscription(options = {}) ⇒ Object



120
121
122
# File 'app/models/pay/subscription.rb', line 120

def processor_subscription(options = {})
  owner.processor_subscription(processor_id, options)
end

#resumeObject



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# File 'app/models/pay/subscription.rb', line 89

def resume
  unless on_grace_period?
    unless paddle?
      raise StandardError,
        "You can only resume subscriptions within their grace period."
    end
  end

  unless paused?
    if paddle?
      raise StandardError,
        "You can only resume paused subscriptions."
    end
  end

  send("#{processor}_resume")

  update(ends_at: nil, status: "active")
  self
end

#skip_trialObject



36
37
38
# File 'app/models/pay/subscription.rb', line 36

def skip_trial
  self.trial_ends_at = nil
end

#swap(plan) ⇒ Object



110
111
112
113
# File 'app/models/pay/subscription.rb', line 110

def swap(plan)
  send("#{processor}_swap", plan)
  update(processor_plan: plan, ends_at: nil)
end

#swap_and_invoice(plan) ⇒ Object



115
116
117
118
# File 'app/models/pay/subscription.rb', line 115

def swap_and_invoice(plan)
  swap(plan)
  owner.invoice!(subscription_id: processor_id)
end