Class: Pay::Stripe::Subscription

Inherits:
Pay::Subscription
  • Object
show all
Defined in:
app/models/pay/stripe/subscription.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#api_record(**options) ⇒ Object 



154
155
156
 
# File 'app/models/pay/stripe/subscription.rb', line 154

def api_record(**options)
  @api_record ||= ::Stripe::Subscription.retrieve(options.with_defaults(id: processor_id).merge(expand_options), {stripe_account: }.compact)
end

Class Method Details

.expand_options ⇒ Object

Common expand options for all requests that create, retrieve, or update a Stripe Subscription



131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'app/models/pay/stripe/subscription.rb', line 131

def self.expand_options
  {
    expand: [
      "default_payment_method",
      "discounts",
      "latest_invoice.confirmation_secret",
      "latest_invoice.payments",
      "latest_invoice.total_discount_amounts.discount",
      "pending_setup_intent",
      "schedule"
    ]
  }
end

.sync(subscription_id, object: nil, name: nil, stripe_account: nil, try: 0, retries: 1) ⇒ Object 



11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'app/models/pay/stripe/subscription.rb', line 11

def self.sync(subscription_id, object: nil, name: nil, stripe_account: nil, try: 0, retries: 1)
  # Skip loading the latest subscription details from the API if we already have it
  object ||= ::Stripe::Subscription.retrieve({id: subscription_id}.merge(expand_options), {stripe_account: }.compact)
  if object.customer.blank?
    Rails.logger.debug "Stripe Subscription #{object.id} does not have a customer"
    return
  end

  pay_customer = Pay::Customer.find_by(processor: :stripe, processor_id: object.customer)
  if pay_customer.blank?
    Rails.logger.debug "Pay::Customer #{object.customer} is not in the database while syncing Stripe Subscription #{object.id}"
    return
  end

  # Requests for the rest of the sync should go to the same Stripe Connect account as the customer
   ||= pay_customer.

  attributes = {
    object: object.to_hash,
    application_fee_percent: object.application_fee_percent,
    created_at: Time.at(object.created),
    processor_plan: object.items.first.price.id,
    quantity: object.items.first.try(:quantity) || 0,
    status: object.status,
    stripe_account: ,
    metadata: object.metadata,
    metered: false,
    pause_behavior: object.pause_collection&.behavior,
    pause_resumes_at: (object.pause_collection&.resumes_at ? Time.at(object.pause_collection&.resumes_at) : nil),
    current_period_start: (object.items.first.current_period_start ? Time.at(object.items.first.current_period_start) : nil),
    current_period_end: (object.items.first.current_period_end ? Time.at(object.items.first.current_period_end) : nil)
  }

  # Subscriptions that have ended should have their trial ended at the
  # same time if they were still on trial (if you cancel a
  # subscription, your are cancelling your trial as well at the same
  # instant). This avoids canceled subscriptions responding `true`
  # to #on_trial? due to the `trial_ends_at` being left set in the
  # future.
  if object.trial_end
    trial_ended_at = [object.ended_at, object.trial_end].compact.min
    attributes[:trial_ends_at] = Time.at(trial_ended_at)
  else
    attributes[:trial_ends_at] = nil
  end

  object.items.auto_paging_each do |subscription_item|
    next if attributes[:metered]
    attributes[:metered] = true if subscription_item.price.try(:recurring).try(:usage_type) == "metered"
  end

  attributes[:ends_at] = if object.ended_at
    # Fully cancelled subscription
    Time.at(object.ended_at)
  elsif object.cancel_at
    # subscription cancelling in the future
    Time.at(object.cancel_at)
  elsif object.cancel_at_period_end
    # Subscriptions cancelling in the future
    Time.at(object.items.first.current_period_end)
  end

  # Sync payment method if directly attached to subscription
  if object.default_payment_method
    if object.default_payment_method.is_a? String
      Pay::Stripe::PaymentMethod.sync(object.default_payment_method, stripe_account: )
      attributes[:payment_method_id] = object.default_payment_method
    else
      Pay::Stripe::PaymentMethod.sync(object.default_payment_method.id, object: object.default_payment_method, stripe_account: )
      attributes[:payment_method_id] = object.default_payment_method.id
    end
  end

  # Update or create the subscription
  pay_subscription = find_by(customer: pay_customer, processor_id: object.id)
  if pay_subscription
    # If pause behavior is changing to `void`, record the pause start date
    # Any other pause status (or no pause at all) should have nil for start
    if pay_subscription.pause_behavior != attributes[:pause_behavior]
      attributes[:pause_starts_at] = if attributes[:pause_behavior] == "void"
        Time.at(object.items.first.current_period_end)
      end
    end

    pay_subscription.with_lock { pay_subscription.update!(attributes) }
  else
    # Allow setting the subscription name in metadata, otherwise use the default
    name ||= object.metadata["pay_name"] || Pay.default_product_name
    pay_subscription = create!(attributes.merge(customer: pay_customer, name: name, processor_id: object.id))
  end

  # Cache the Stripe subscription on the Pay::Subscription that we return
  pay_subscription.api_record = object

  # Sync the latest charge if we already have it loaded (like during subscrbe), otherwise, let webhooks take care of creating it
  if (invoice = object.try(:latest_invoice))
    Array(invoice.try(:payments)).each do |invoice_payment|
      next unless invoice_payment.status == "paid"

      case invoice_payment.payment.type
      when "payment_intent"
        Pay::Stripe::Charge.sync_payment_intent(invoice_payment.payment.payment_intent, stripe_account: )
      when "charge"
        Pay::Stripe::Charge.sync(invoice_payment.payment.charge, stripe_account: )
      end
    end
  end

  pay_subscription
rescue ActiveRecord::RecordInvalid, ActiveRecord::RecordNotUnique
  try += 1
  if try <= retries
    sleep 0.1
    retry
  else
    raise
  end
end

.sync_from_checkout_session(session_id, stripe_account: nil) ⇒ Object 



6
7
8
9
 
# File 'app/models/pay/stripe/subscription.rb', line 6

def self.sync_from_checkout_session(session_id, stripe_account: nil)
  checkout_session = ::Stripe::Checkout::Session.retrieve({id: session_id}, {stripe_account: }.compact)
  sync(checkout_session.subscription, stripe_account: )
end

Instance Method Details

#cancel(**options) ⇒ Object

Marks a subscription to cancel at period end

If subscription is already past_due, the subscription will be cancelled immediately To disable this, pass past_due_cancel_now: false



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'app/models/pay/stripe/subscription.rb', line 176

def cancel(**options)
  return if canceled?

  if past_due? && options.fetch(:past_due_cancel_now, true)
    cancel_now!
  else
    @api_record = ::Stripe::Subscription.update(processor_id, {cancel_at_period_end: true}.merge(expand_options), stripe_options)
    update(ends_at: Time.at(@api_record.cancel_at))
  end
rescue ::Stripe::StripeError => e
  raise Pay::Stripe::Error, e
end

#cancel_now!(**options) ⇒ Object

Cancels a subscription immediately

cancel_now!(prorate: true) cancel_now!(invoice_now: true)



193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'app/models/pay/stripe/subscription.rb', line 193

def cancel_now!(**options)
  return if canceled? && ends_at.past?

  @api_record = ::Stripe::Subscription.cancel(processor_id, options.merge(expand_options), stripe_options)
  update(
    trial_ends_at: (@api_record.trial_end ? Time.at(@api_record.trial_end) : nil),
    ends_at: Time.at(@api_record.ended_at),
    status: @api_record.status
  )
rescue ::Stripe::StripeError => e
  raise Pay::Stripe::Error, e
end

#change_quantity(quantity, **options) ⇒ Object

This updates a SubscriptionItem's quantity in Stripe

Defaults to the first SubscriptionItem. Pass subscription_item_id: to update a different one (Stripe no longer accepts a top-level quantity on the subscription itself)



210
211
212
213
214
215
216
217
 
# File 'app/models/pay/stripe/subscription.rb', line 210

def change_quantity(quantity, **options)
  subscription_item_id = options.delete(:subscription_item_id) || subscription_items.first.id
  ::Stripe::SubscriptionItem.update(subscription_item_id, options.merge(quantity: quantity), stripe_options)
  @api_record = nil
  update(quantity: quantity)
rescue ::Stripe::StripeError => e
  raise Pay::Stripe::Error, e
end

#client_secret ⇒ Object

Returns a SetupIntent or PaymentIntent client secret for the subscription



159
160
161
 
# File 'app/models/pay/stripe/subscription.rb', line 159

def client_secret
  api_record&.pending_setup_intent&.client_secret || api_record&.latest_invoice&.confirmation_secret&.client_secret
end

#latest_payment ⇒ Object

Returns the Stripe::PaymentIntent for the latest invoice, if there is one



367
368
369
370
371
372
 
# File 'app/models/pay/stripe/subscription.rb', line 367

def latest_payment
  payment_intent_id = api_record.latest_invoice&.payments&.first&.payment&.payment_intent
  ::Stripe::PaymentIntent.retrieve({id: payment_intent_id}, stripe_options) if payment_intent_id
rescue ::Stripe::StripeError => e
  raise Pay::Stripe::Error, e
end

#metered_subscription_item ⇒ Object

Returns the first metered subscription item



328
329
330
331
332
 
# File 'app/models/pay/stripe/subscription.rb', line 328

def metered_subscription_item
  subscription_items.auto_paging_each do |subscription_item|
    return subscription_item if subscription_item.price.try(:recurring).try(:usage_type) == "metered"
  end
end

#on_grace_period? ⇒ Boolean

Returns:

  • (Boolean) 


219
220
221
 
# File 'app/models/pay/stripe/subscription.rb', line 219

def on_grace_period?
  (ends_at? && ends_at > Time.current) || (paused? && will_pause?)
end

#pause(**options) ⇒ Object

Pauses a Stripe subscription

pause(behavior: "mark_uncollectible") pause(behavior: "keep_as_draft") pause(behavior: "void") pause(behavior: "mark_uncollectible", resumes_at: 1.month.from_now)

void - If you can’t provide your services for a certain period of time, you can void invoices that are created by your subscriptions so that your customers aren’t charged. keep_as_draft - If you want to temporarily offer your services for free and collect payments later mark_uncollectible - If you want to offer your services for free

pause_behavior of void is considered active until the end of the current period and not active after that. The current_period_end is stored as pause_starts_at Other pause_behaviors do not set pause_starts_at because they are used for offering free services

https://docs.stripe.com/billing/subscriptions/pause-payment



250
251
252
253
254
255
256
257
258
259
 
# File 'app/models/pay/stripe/subscription.rb', line 250

def pause(**options)
  attributes = {pause_collection: options.reverse_merge(behavior: "void")}
  @api_record = ::Stripe::Subscription.update(processor_id, attributes.merge(expand_options), stripe_options)
  behavior = @api_record.pause_collection&.behavior
  update(
    pause_behavior: behavior,
    pause_resumes_at: (@api_record.pause_collection&.resumes_at ? Time.at(@api_record.pause_collection&.resumes_at) : nil),
    pause_starts_at: ((behavior == "void") ? Time.at(@api_record.items.first.current_period_end) : nil)
  )
end

#pause_active? ⇒ Boolean

Returns:

  • (Boolean) 


223
224
225
 
# File 'app/models/pay/stripe/subscription.rb', line 223

def pause_active?
  paused? && (pause_starts_at.nil? || Time.current.after?(pause_starts_at))
end

#paused? ⇒ Boolean

Returns:

  • (Boolean) 


231
232
233
 
# File 'app/models/pay/stripe/subscription.rb', line 231

def paused?
  pause_behavior == "void"
end

#pay_open_invoices ⇒ Object

Looks up open invoices for a subscription and attempts to pay them

Invoices no longer expose a payment_intent directly, so the PaymentIntent is looked up through the invoice's payments



359
360
361
362
363
364
 
# File 'app/models/pay/stripe/subscription.rb', line 359

def pay_open_invoices
  ::Stripe::Invoice.list({subscription: processor_id, status: :open, expand: ["data.payments"]}, stripe_options).auto_paging_each do |invoice|
    payment_intent_id = invoice.payments.first&.payment&.payment_intent
    retry_failed_payment(payment_intent_id: payment_intent_id) if payment_intent_id
  end
end

#preview_invoice(**options) ⇒ Object 



334
335
336
 
# File 'app/models/pay/stripe/subscription.rb', line 334

def preview_invoice(**options)
  ::Stripe::Invoice.create_preview(options.merge(subscription: processor_id), stripe_options)
end

#resumable? ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
 
# File 'app/models/pay/stripe/subscription.rb', line 273

def resumable?
  on_grace_period? || paused?
end

#resume ⇒ Object 



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'app/models/pay/stripe/subscription.rb', line 277

def resume
  unless resumable?
    raise Error, "You can only resume subscriptions within their grace period."
  end

  if paused?
    unpause
  else
    @api_record = ::Stripe::Subscription.update(processor_id, {
      trial_end: (on_trial? ? trial_ends_at.to_i : "now"),
      cancel_at_period_end: false
    }.merge(expand_options),
      stripe_options)
  end
  update(ends_at: nil, status: @api_record.status)
rescue ::Stripe::StripeError => e
  raise Pay::Stripe::Error, e
end

#retry_failed_payment(payment_intent_id: nil) ⇒ Object

Retries the latest invoice for a Past Due subscription and attempts to pay it



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'app/models/pay/stripe/subscription.rb', line 339

def retry_failed_payment(payment_intent_id: nil)
  payment_intent_id ||= api_record.latest_invoice.payments.first.payment.payment_intent
  payment_intent = ::Stripe::PaymentIntent.retrieve({id: payment_intent_id}, stripe_options)

  payment_intent = if payment_intent.status == "requires_payment_method"
    payment_method = customer.default_payment_method
    raise Pay::Stripe::Error, "no default payment method to retry the payment with" if payment_method.nil?

    ::Stripe::PaymentIntent.confirm(payment_intent_id, {payment_method: payment_method.processor_id}, stripe_options)
  else
    ::Stripe::PaymentIntent.confirm(payment_intent_id, stripe_options)
  end
  Pay::Payment.new(payment_intent).validate
rescue ::Stripe::StripeError => e
  raise Pay::Stripe::Error, e
end

#stripe_object ⇒ Object 



145
146
147
148
 
# File 'app/models/pay/stripe/subscription.rb', line 145

def stripe_object
  sync! if object.nil?
  ::Stripe::Subscription.construct_from(object)
end

#subscription_items ⇒ Object 



323
324
325
 
# File 'app/models/pay/stripe/subscription.rb', line 323

def subscription_items
  stripe_object.items
end

#swap(plan, **options) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'app/models/pay/stripe/subscription.rb', line 296

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

  prorate = options.fetch(:prorate) { true }
  proration_behavior = options.delete(:proration_behavior) || (prorate ? "always_invoice" : "none")

  @api_record = ::Stripe::Subscription.update(
    processor_id,
    {
      cancel_at_period_end: false,
      items: [{id: subscription_items.first.id, plan: plan, quantity: quantity}],
      proration_behavior: proration_behavior,
      trial_end: (on_trial? ? trial_ends_at.to_i : "now")
    }.merge(expand_options).merge(options),
    stripe_options
  )

  # Validate that swap was successful and handle SCA if needed
  if (payment_intent_id = @api_record.latest_invoice.payments.first&.payment&.payment_intent)
    Pay::Payment.from_id(payment_intent_id, stripe_account: ).validate
  end

  sync!(object: @api_record)
rescue ::Stripe::StripeError => e
  raise Pay::Stripe::Error, e
end

#sync!(**options) ⇒ Object 



150
151
152
 
# File 'app/models/pay/stripe/subscription.rb', line 150

def sync!(**options)
  super(**options.with_defaults(stripe_account: ))
end

#unpause ⇒ Object

Unpauses a subscription

https://docs.stripe.com/billing/subscriptions/pause-payment#unpausing



264
265
266
267
268
269
270
271
 
# File 'app/models/pay/stripe/subscription.rb', line 264

def unpause
  @api_record = ::Stripe::Subscription.update(processor_id, {pause_collection: ""}.merge(expand_options), stripe_options)
  update(
    pause_behavior: nil,
    pause_resumes_at: nil,
    pause_starts_at: nil
  )
end

#update_payment_method(id) ⇒ Object

Sets the default_payment_method on a subscription Pass an empty string to unset



165
166
167
168
169
170
 
# File 'app/models/pay/stripe/subscription.rb', line 165

def update_payment_method(id)
  @api_record = ::Stripe::Subscription.update(processor_id, {default_payment_method: id}.merge(expand_options), stripe_options)
  update(payment_method_id: @api_record.default_payment_method&.id)
rescue ::Stripe::StripeError => e
  raise Pay::Stripe::Error, e
end

#will_pause? ⇒ Boolean

Returns:

  • (Boolean) 


227
228
229
 
# File 'app/models/pay/stripe/subscription.rb', line 227

def will_pause?
  pause_starts_at? && Time.current < pause_starts_at
end