Class: Pay::Paddle::Subscription

Inherits:
Object
  • Object
show all
Defined in:
lib/pay/paddle/subscription.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pay_subscription) ⇒ Subscription 



68
69
70
 
# File 'lib/pay/paddle/subscription.rb', line 68

def initialize(pay_subscription)
  @pay_subscription = pay_subscription
end

Instance Attribute Details

#pay_subscription ⇒ Object (readonly)

Returns the value of attribute pay_subscription.



4
5
6
 
# File 'lib/pay/paddle/subscription.rb', line 4

def pay_subscription
  @pay_subscription
end

Class Method Details

.sync(subscription_id, object: nil, name: Pay.default_product_name) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/pay/paddle/subscription.rb', line 25

def self.sync(subscription_id, object: nil, name: Pay.default_product_name)
  # Passthrough is not return from this API, so we can't use that
  object ||= OpenStruct.new PaddlePay::Subscription::User.list({subscription_id: subscription_id}).try(:first)

  pay_customer = Pay::Customer.find_by(processor: :paddle, processor_id: object.user_id)

  # If passthrough exists (only on webhooks) we can use it to create the Pay::Customer
  if pay_customer.nil? && object.passthrough
    owner = Pay::Paddle.owner_from_passthrough(object.passthrough)
    pay_customer = owner&.set_payment_processor(:paddle, processor_id: object.user_id)
  end

  return unless pay_customer

  attributes = {
    paddle_cancel_url: object.cancel_url,
    paddle_update_url: object.update_url,
    processor_plan: object.plan_id || object.subscription_plan_id,
    quantity: object.quantity,
    status: object.state || object.status
  }

  # If paused or delete while on trial, set ends_at to match
  case attributes[:status]
  when "trialing"
    attributes[:trial_ends_at] = Time.zone.parse(object.next_bill_date)
    attributes[:ends_at] = nil
  when "paused", "deleted"
    attributes[:trial_ends_at] = nil
    attributes[:ends_at] = Time.zone.parse(object.next_bill_date)
  end

  # Update or create the subscription
  if (pay_subscription = pay_customer.subscriptions.find_by(processor_id: object.subscription_id))
    pay_subscription.with_lock do
      pay_subscription.update!(attributes)
    end
    pay_subscription
  else
    pay_customer.subscriptions.create!(attributes.merge(name: name, processor_id: object.subscription_id))
  end
end

Instance Method Details

#cancel(**options) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/pay/paddle/subscription.rb', line 79

def cancel(**options)
  ends_at = if on_trial?
    trial_ends_at
  elsif paused?
    pause_starts_at
  else
    processor_subscription.next_payment&.fetch(:date) || Time.current
  end

  PaddlePay::Subscription::User.cancel(processor_id)
  pay_subscription.update(status: :canceled, ends_at: ends_at)

  # Remove payment methods since customer cannot be reused after cancelling
  Pay::PaymentMethod.where(customer_id: pay_subscription.customer_id).destroy_all
rescue ::PaddlePay::PaddlePayError => e
  raise Pay::Paddle::Error, e
end

#cancel_now!(**options) ⇒ Object 



97
98
99
100
101
102
103
104
105
 
# File 'lib/pay/paddle/subscription.rb', line 97

def cancel_now!(**options)
  PaddlePay::Subscription::User.cancel(processor_id)
  pay_subscription.update(status: :canceled, ends_at: Time.current)

  # Remove payment methods since customer cannot be reused after cancelling
  Pay::PaymentMethod.where(customer_id: pay_subscription.customer_id).destroy_all
rescue ::PaddlePay::PaddlePayError => e
  raise Pay::Paddle::Error, e
end

#change_quantity(quantity, **options) ⇒ Object

Raises:

  • (NotImplementedError) 


107
108
109
 
# File 'lib/pay/paddle/subscription.rb', line 107

def change_quantity(quantity, **options)
  raise NotImplementedError, "Paddle does not support setting quantity on subscriptions"
end

#on_grace_period? ⇒ Boolean

A subscription could be set to cancel or pause in the future It is considered on grace period until the cancel or pause time begins



113
114
115
 
# File 'lib/pay/paddle/subscription.rb', line 113

def on_grace_period?
  (canceled? && Time.current < ends_at) || (paused? && pause_starts_at? && Time.current < pause_starts_at)
end

#pause ⇒ Object 



121
122
123
124
125
126
127
 
# File 'lib/pay/paddle/subscription.rb', line 121

def pause
  attributes = {pause: true}
  response = PaddlePay::Subscription::User.update(processor_id, attributes)
  pay_subscription.update(status: :paused, pause_starts_at: Time.zone.parse(response.dig(:next_payment, :date)))
rescue ::PaddlePay::PaddlePayError => e
  raise Pay::Paddle::Error, e
end

#paused? ⇒ Boolean 



117
118
119
 
# File 'lib/pay/paddle/subscription.rb', line 117

def paused?
  pay_subscription.status == "paused"
end

#resume ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/pay/paddle/subscription.rb', line 129

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

  attributes = {pause: false}
  PaddlePay::Subscription::User.update(processor_id, attributes)
  pay_subscription.update(status: :active, pause_starts_at: nil)
rescue ::PaddlePay::PaddlePayError => e
  raise Pay::Paddle::Error, e
end

#retry_failed_payment ⇒ Object

Retries the latest invoice for a Past Due subscription



154
155
 
# File 'lib/pay/paddle/subscription.rb', line 154

def retry_failed_payment
end

#subscription(**options) ⇒ Object 



72
73
74
75
76
77
 
# File 'lib/pay/paddle/subscription.rb', line 72

def subscription(**options)
  hash = PaddlePay::Subscription::User.list({subscription_id: processor_id}, options).try(:first)
  OpenStruct.new(hash)
rescue ::PaddlePay::PaddlePayError => e
  raise Pay::Paddle::Error, e
end

#swap(plan, **options) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/pay/paddle/subscription.rb', line 141

def swap(plan, **options)
  raise ArgumentError, "plan must be a string" unless plan.is_a?(String)

  attributes = {plan_id: plan, prorate: prorate}
  attributes[:quantity] = quantity if quantity?
  PaddlePay::Subscription::User.update(processor_id, attributes)

  pay_subscription.update(processor_plan: plan, ends_at: nil, status: :active)
rescue ::PaddlePay::PaddlePayError => e
  raise Pay::Paddle::Error, e
end