pay 5.0.3 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c607f5486ae4c1dfbf46b492e1a369e89e763e03e43bb25596882396285a416a
-  data.tar.gz: cbe12e5104c4cc18c9edc0a3d2ecf99f2d9d3adad431e4868747625f4934e6ec
+  metadata.gz: 46dc11ef6e994fd5e55708294d2ffcd1a889bcd58b2a2a6473ee12bee883fb95
+  data.tar.gz: 7f7df60a4318e91cd11d616f744d733cb756a4cac21c56a66031026a539e3cd8
 SHA512:
-  metadata.gz: ae0b3f32f96f2efcc5618df5b158397e1d6d1c6c79ee2109bb806628da2c53d998d8090fb7c9d7b2055a7ba660960b8ae4a36a6e6c4da54a943b4cd7020adae2
-  data.tar.gz: 356ba70d14722f9b083f366a957c26809082ce14193d7e4ec09350cf4c232de8dd215736b8c5968166d5659a8d9235df90104cc9367654b94e8905a09cfcdb77
+  metadata.gz: 9dd6da70a8e3aceb1b8ea1a6010bf2cfc2034953ed56a9a197dc9685afa9a1f9b26960072f5ae0590359b24516988f61a82f0567f9443462cdbc6bf03dc75d08
+  data.tar.gz: 1910bbf68cebf716348b0a1a7ad8e639ea14c86a90c1a0abf04eae037a3370a5ff2b6ffc7c4049af03a900e21e7c41a0b29deb729aeb67d8378dcb79f94cbbac

data/app/mailers/pay/user_mailer.rb

@@ -5,25 +5,33 @@ module Pay
         attachments[params[:pay_charge].filename] = params[:pay_charge].receipt
       end
 
-      mail to: to
+      mail mail_arguments
     end
 
     def refund
-      mail to: to
+      mail mail_arguments
     end
 
     def subscription_renewing
-      mail to: to
+      mail mail_arguments
     end
 
     def payment_action_required
-      mail to: to
+      mail mail_arguments
+    end
+
+    def subscription_trial_will_end
+      mail mail_arguments
+    end
+
+    def subscription_trial_ended
+      mail mail_arguments
     end
 
     private
 
-    def to
-      "#{params[:pay_customer].customer_name} <#{params[:pay_customer].email}>"
+    def mail_arguments
+      Pay.mail_arguments.call(mailer_name, params)
     end
   end
 end

data/app/models/pay/customer.rb

@@ -46,7 +46,7 @@ module Pay
     end
 
     def subscription(name: Pay.default_product_name)
-      subscriptions.loaded? ? subscriptions.reverse.detect { |s| s.name == name } : subscriptions.for_name(name).last
+      subscriptions.order(id: :desc).for_name(name).first
     end
 
     def subscribed?(name: Pay.default_product_name, processor_plan: nil)
@@ -92,5 +92,10 @@ module Pay
       # If these match, consider it a generic trial
       subscription.trial_ends_at == subscription.ends_at
     end
+
+    # Attempts to pay all past_due subscriptions
+    def retry_past_due_subscriptions!
+      subscriptions.past_due.each(&:retry_failed_payment)
+    end
   end
 end

data/app/models/pay/subscription.rb

@@ -8,14 +8,16 @@ module Pay
 
     # Scopes
     scope :for_name, ->(name) { where(name: name) }
-    scope :on_trial, -> { where.not(trial_ends_at: nil).where("#{table_name}.trial_ends_at > ?", Time.zone.now) }
+    scope :on_trial, -> { where.not(trial_ends_at: nil).where("#{table_name}.trial_ends_at > ?", Time.current) }
     scope :cancelled, -> { where.not(ends_at: nil) }
-    scope :on_grace_period, -> { cancelled.where("#{table_name}.ends_at > ?", Time.zone.now) }
-    # Stripe considers paused subscriptions to be active, therefore we reflect that in this scope and
-    # make it consistent across all processors
-    scope :active, -> { where(status: ["trialing", "active", "paused"], ends_at: nil).or(on_grace_period).or(on_trial) }
+    scope :on_grace_period, -> { cancelled.where("#{table_name}.ends_at > ?", Time.current) }
+    scope :active, -> { where(status: ["trialing", "active"], ends_at: nil).pause_not_started.or(on_grace_period).or(on_trial) }
+    scope :paused, -> { where(status: "paused").or(where("pause_starts_at <= ?", Time.current)) }
+    scope :pause_not_started, -> { where("pause_starts_at IS NULL OR pause_starts_at > ?", Time.current) }
+    scope :active_or_paused, -> { active.or(paused) }
     scope :incomplete, -> { where(status: :incomplete) }
     scope :past_due, -> { where(status: :past_due) }
+    scope :metered, -> { where(metered: true) }
     scope :with_active_customer, -> { joins(:customer).merge(Customer.active) }
     scope :with_deleted_customer, -> { joins(:customer).merge(Customer.deleted) }
 
@@ -24,12 +26,8 @@ module Pay
 
     store_accessor :data, :paddle_update_url
     store_accessor :data, :paddle_cancel_url
-    store_accessor :data, :paddle_paused_from
     store_accessor :data, :stripe_account
-    store_accessor :data, :metered
     store_accessor :data, :subscription_items
-    store_accessor :data, :pause_behavior
-    store_accessor :data, :pause_resumes_at
 
     attribute :prorate, :boolean, default: true
 
@@ -51,36 +49,6 @@ module Pay
       scope processor_name, -> { joins(:customer).where(pay_customers: {processor: processor_name}) }
     end
 
-    def self.active_without_paused
-      case Pay::Adapter.current_adapter
-      when "postgresql", "postgis"
-        active.where("data->>'pause_behavior' IS NULL AND status != 'paused'")
-      when "mysql2"
-        active.where("data->>'$.pause_behavior' IS NULL AND status != 'paused'")
-      when "sqlite3"
-        # sqlite 3.38 supports ->> syntax, however, sqlite 3.37 is what ships with Ubuntu 22.04.
-        active.where("json_extract(data, '$.pause_behavior') IS NULL AND status != 'paused'")
-      end
-    end
-
-    def self.with_metered_items
-      case Pay::Adapter.current_adapter
-      when "sqlite3"
-        where("json_extract(data, '$.\"metered\"') = true")
-        # For SQLite 3.38+ we could use the arrows
-        # where("data->'metered' = ?", "true")
-      when "mysql2"
-        where("data->'$.\"metered\"' = true")
-      when "postgresql", "postgis"
-        # Single quotes are important for json keys apparently
-        where("data->>'metered' = 'true'")
-      end
-    end
-
-    def metered_items?
-      !!metered
-    end
-
     def self.find_by_processor_and_id(processor, processor_id)
       joins(:customer).find_by(processor_id: processor_id, pay_customers: {processor: processor})
     end
@@ -93,8 +61,9 @@ module Pay
       @payment_processor ||= self.class.pay_processor_for(customer.processor).new(self)
     end
 
-    def sync!
-      self.class.pay_processor_for(customer.processor).sync(processor_id)
+    def sync!(**options)
+      self.class.pay_processor_for(customer.processor).sync(processor_id, **options)
+      reload
     end
 
     def no_prorate
@@ -109,8 +78,16 @@ module Pay
       fake_processor? && trial_ends_at?
     end
 
+    def has_trial?
+      trial_ends_at?
+    end
+
     def on_trial?
-      trial_ends_at? && Time.zone.now < trial_ends_at
+      trial_ends_at? && trial_ends_at.after?(Time.current)
+    end
+
+    def trial_ended?
+      trial_ends_at? && trial_ends_at.before?(Time.current)
     end
 
     def canceled?
@@ -121,8 +98,21 @@ module Pay
       canceled?
     end
 
+    def on_grace_period?
+      (ends_at? && Time.current < ends_at) ||
+        ((status == "paused" || pause_behavior == "void") && will_pause?)
+    end
+
+    def will_pause?
+      pause_starts_at? && Time.current < pause_starts_at
+    end
+
+    def pause_active?
+      (status == "paused" || pause_behavior == "void") && (pause_starts_at.nil? || pause_starts_at >= Time.current)
+    end
+
     def active?
-      ["trialing", "active", "paused"].include?(status) && (ends_at.nil? || on_grace_period? || on_trial?)
+      ["trialing", "active"].include?(status) && (!(canceled? || paused?) || on_trial? || on_grace_period?)
     end
 
     def past_due?
@@ -137,8 +127,8 @@ module Pay
       past_due? || incomplete?
     end
 
-    def change_quantity(quantity)
-      payment_processor.change_quantity(quantity)
+    def change_quantity(quantity, **options)
+      payment_processor.change_quantity(quantity, **options)
       update(quantity: quantity)
     end
 
@@ -148,10 +138,9 @@ module Pay
       self
     end
 
-    def swap(plan)
+    def swap(plan, **options)
       raise ArgumentError, "plan must be a string. Got `#{plan.inspect}` instead." unless plan.is_a?(String)
-      payment_processor.swap(plan)
-      update(processor_plan: plan, ends_at: nil, status: :active)
+      payment_processor.swap(plan, **options)
     end
 
     def swap_and_invoice(plan)
@@ -167,18 +156,6 @@ module Pay
       processor_subscription(expand: ["latest_invoice.payment_intent"]).latest_invoice.payment_intent
     end
 
-    def paddle_paused_from
-      if (timestamp = super)
-        Time.zone.parse(timestamp)
-      end
-    end
-
-    def pause_resumes_at
-      if (resumes_at = super)
-        Time.zone.parse(resumes_at)
-      end
-    end
-
     private
 
     def cancel_if_active

data/app/views/pay/user_mailer/subscription_trial_ended.html.erb

@@ -0,0 +1,6 @@
+<h3>Your <%= Pay.business_name %> trial has ended</h3>
+<p>This is just a friendly reminder that your <%= Pay.business_name %> trial has ended.</p>
+
+<p>You may manage your subscription via your account. If you have any questions, please hit reply and let us know.</p>
+
+<p>- The <%= Pay.business_name %> Team</p>

data/app/views/pay/user_mailer/subscription_trial_will_end.html.erb

@@ -0,0 +1,6 @@
+<h3>Your <%= Pay.business_name %> trial is ending soon</h3>
+<p>This is just a friendly reminder that your <%= Pay.business_name %> trial will be ending soon.</p>
+
+<p>You may manage your subscription via your account. If you have any questions, please hit reply and let us know.</p>
+
+<p>- The <%= Pay.business_name %> Team</p>

data/config/locales/en.yml

@@ -56,3 +56,7 @@ en:
         subject: "Your upcoming subscription renewal"
       payment_action_required:
         subject: "Confirm your payment"
+      subscription_trial_will_end:
+        subject: "Your trial is ending soon"
+      subscription_trial_ended:
+        subject: "Your trial has ended"

data/db/migrate/1_create_pay_tables.rb

@@ -39,14 +39,22 @@ class CreatePayTables < ActiveRecord::Migration[6.0]
       t.string :processor_plan, null: false
       t.integer :quantity, default: 1, null: false
       t.string :status, null: false
+      t.datetime :current_period_start
+      t.datetime :current_period_end
       t.datetime :trial_ends_at
       t.datetime :ends_at
+      t.boolean :metered
+      t.string :pause_behavior
+      t.datetime :pause_starts_at
+      t.datetime :pause_resumes_at
       t.decimal :application_fee_percent, precision: 8, scale: 2
       t.public_send Pay::Adapter.json_column_type, :metadata
       t.public_send Pay::Adapter.json_column_type, :data
       t.timestamps
     end
     add_index :pay_subscriptions, [:customer_id, :processor_id], unique: true
+    add_index :pay_subscriptions, [:metered]
+    add_index :pay_subscriptions, [:pause_starts_at]
 
     create_table :pay_charges do |t|
       t.belongs_to :customer, foreign_key: {to_table: :pay_customers}, null: false, index: false

data/lib/pay/billable/sync_customer.rb

@@ -8,7 +8,7 @@ module Pay
       extend ActiveSupport::Concern
 
       included do
-        after_update :enqeue_customer_sync_job, if: :pay_should_sync_customer?
+        after_update_commit :enqeue_customer_sync_job, if: :pay_should_sync_customer?
       end
 
       def pay_should_sync_customer?

data/lib/pay/braintree/subscription.rb

@@ -4,8 +4,9 @@ module Pay
       attr_reader :pay_subscription
 
       delegate :active?,
-        :customer,
         :canceled?,
+        :on_grace_period?,
+        :customer,
         :ends_at,
         :name,
         :on_trial?,
@@ -55,6 +56,10 @@ module Pay
         raise Pay::Braintree::Error, e
       end
 
+      def change_quantity(quantity, **options)
+        raise NotImplementedError, "Braintree does not support setting quantity on subscriptions"
+      end
+
       def on_grace_period?
         canceled? && Time.current < ends_at
       end
@@ -96,7 +101,7 @@ module Pay
         raise Pay::Braintree::Error, e
       end
 
-      def swap(plan)
+      def swap(plan, **options)
         raise ArgumentError, "plan must be a string" unless plan.is_a?(String)
 
         if on_grace_period? && processor_plan == plan
@@ -128,10 +133,25 @@ module Pay
           }
         })
         raise Error, "Braintree failed to swap plans: #{result.message}" unless result.success?
+
+        pay_subscription.update(processor_plan: plan, ends_at: nil, status: :active)
       rescue ::Braintree::BraintreeError => e
         raise Pay::Braintree::Error, e
       end
 
+      # Retries the latest invoice for a Past Due subscription
+      def retry_failed_payment
+        result = gateway.subscription.retry_charge(
+          processor_id,
+          nil, # amount if different
+          true # submit for settlement
+        )
+
+        if result.success?
+          pay_subscription.update(status: :active)
+        end
+      end
+
       private
 
       def gateway

data/lib/pay/engine.rb

@@ -17,7 +17,9 @@ module Pay
       end
     end
 
-    initializer "pay.webhooks" do
+    # Add webhook subscribers before app initializers define extras
+    # This keeps the processing in order so that changes have happened before user-defined webhook processors
+    config.before_initialize do
       Pay::Stripe.configure_webhooks if Pay::Stripe.enabled?
       Pay::Braintree.configure_webhooks if Pay::Braintree.enabled?
       Pay::Paddle.configure_webhooks if Pay::Paddle.enabled?

data/lib/pay/fake_processor/merchant.rb

@@ -0,0 +1,26 @@
+module Pay
+  module FakeProcessor
+    class Merchant
+      attr_reader :pay_merchant
+      delegate :processor_id, to: :pay_merchant
+
+      def initialize(pay_merchant)
+        @pay_merchant = pay_merchant
+      end
+
+      def create_account(**options)
+        fake_account = Struct.new(:id).new("fake_account_id")
+        pay_merchant.update(processor_id: fake_account.id)
+        fake_account
+      end
+
+      def account_link(refresh_url:, return_url:, type: "account_onboarding", **options)
+        Struct.new(:url).new("/fake_processor/account_link")
+      end
+
+      def login_link(**options)
+        Struct.new(:url).new("/fake_processor/login_link")
+      end
+    end
+  end
+end

data/lib/pay/fake_processor/subscription.rb

@@ -3,9 +3,11 @@ module Pay
     class Subscription
       attr_reader :pay_subscription
 
-      delegate :canceled?,
-        :ends_at,
+      delegate :active?,
+        :canceled?,
+        :on_grace_period?,
         :on_trial?,
+        :ends_at,
         :owner,
         :processor_subscription,
         :processor_id,
@@ -42,6 +44,10 @@ module Pay
         )
       end
 
+      def change_quantity(quantity, **options)
+        pay_subscription.update(quantity: quantity)
+      end
+
       def on_grace_period?
         canceled? && Time.current < ends_at
       end
@@ -60,10 +66,13 @@ module Pay
         end
       end
 
-      def swap(plan)
+      def swap(plan, **options)
+        pay_subscription.update(processor_plan: plan, ends_at: nil, status: :active)
       end
 
-      def change_quantity(quantity)
+      # Retries the latest invoice for a Past Due subscription
+      def retry_failed_payment
+        pay_subscription.update(status: :active)
       end
     end
   end

data/lib/pay/fake_processor.rb

@@ -5,5 +5,6 @@ module Pay
     autoload :Error, "pay/fake_processor/error"
     autoload :PaymentMethod, "pay/fake_processor/payment_method"
     autoload :Subscription, "pay/fake_processor/subscription"
+    autoload :Merchant, "pay/fake_processor/merchant"
   end
 end

data/lib/pay/paddle/subscription.rb

@@ -5,11 +5,12 @@ module Pay
 
       delegate :active?,
         :canceled?,
+        :on_grace_period?,
+        :on_trial?,
         :ends_at,
         :name,
-        :on_trial?,
         :owner,
-        :paddle_paused_from,
+        :pause_starts_at,
         :processor_id,
         :processor_plan,
         :processor_subscription,
@@ -78,7 +79,7 @@ module Pay
         ends_at = if on_trial?
           trial_ends_at
         elsif paused?
-          paddle_paused_from
+          pause_starts_at
         else
           processor_subscription.next_payment&.fetch(:date) || Time.current
         end
@@ -102,6 +103,10 @@ module Pay
         raise Pay::Paddle::Error, e
       end
 
+      def change_quantity(quantity, **options)
+        raise NotImplementedError, "Paddle does not support setting quantity on subscriptions"
+      end
+
       def on_grace_period?
         canceled? && Time.current < ends_at || paused? && Time.current < paddle_paused_from
       end
@@ -113,7 +118,7 @@ module Pay
       def pause
         attributes = {pause: true}
         response = PaddlePay::Subscription::User.update(processor_id, attributes)
-        pay_subscription.update(status: :paused, paddle_paused_from: Time.zone.parse(response.dig(:next_payment, :date)))
+        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
@@ -125,20 +130,26 @@ module Pay
 
         attributes = {pause: false}
         PaddlePay::Subscription::User.update(processor_id, attributes)
-        pay_subscription.update(status: :active, paddle_paused_from: nil)
+        pay_subscription.update(status: :active, pause_starts_at: nil)
       rescue ::PaddlePay::PaddlePayError => e
         raise Pay::Paddle::Error, e
       end
 
-      def swap(plan)
+      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
+
+      # Retries the latest invoice for a Past Due subscription
+      def retry_failed_payment
+      end
     end
   end
 end

data/lib/pay/paddle/webhooks/subscription_updated.rb

@@ -16,7 +16,7 @@ module Pay
             pay_subscription.trial_ends_at = Time.zone.parse(event["next_bill_date"])
           when "active"
             pay_subscription.status = "active"
-            pay_subscription.paddle_paused_from = Time.zone.parse(event["paused_from"]) if event["paused_from"].present?
+            pay_subscription.pause_starts_at = Time.zone.parse(event["paused_from"]) if event["paused_from"].present?
           else
             pay_subscription.status = event["status"]
           end

data/lib/pay/stripe/billable.rb

@@ -57,10 +57,7 @@ module Pay
         end
 
         if payment_method_token?
-          payment_method = ::Stripe::PaymentMethod.attach(payment_method_token, {customer: stripe_customer.id}, stripe_options)
-          pay_payment_method = save_payment_method(payment_method, default: false)
-          pay_payment_method.make_default!
-
+          add_payment_method(payment_method_token, default: true)
           pay_customer.payment_method_token = nil
         end
 
@@ -89,13 +86,14 @@ module Pay
           confirm: true,
           currency: "usd",
           customer: processor_id,
+          expand: ["latest_charge.refunds"],
           payment_method: payment_method&.processor_id
         }.merge(options)
 
         payment_intent = ::Stripe::PaymentIntent.create(args, stripe_options)
         Pay::Payment.new(payment_intent).validate
 
-        charge = payment_intent.charges.first
+        charge = payment_intent.latest_charge
         Pay::Stripe::Charge.sync(charge.id, object: charge)
       rescue ::Stripe::StripeError => e
         raise Pay::Stripe::Error, e
@@ -105,13 +103,9 @@ module Pay
         quantity = options.delete(:quantity)
         opts = {
           expand: ["pending_setup_intent", "latest_invoice.payment_intent", "latest_invoice.charge"],
-          items: [plan: plan, quantity: quantity],
-          off_session: true
+          items: [plan: plan, quantity: quantity]
         }.merge(options)
 
-        # Inherit trial from plan unless trial override was specified
-        opts[:trial_from_plan] = true unless opts[:trial_period_days]
-
         # Load the Stripe customer to verify it exists and update payment method if needed
         opts[:customer] = customer.id
 
@@ -190,9 +184,10 @@ module Pay
         stripe_sub.trial_end.present? ? Time.at(stripe_sub.trial_end) : nil
       end
 
-      # Syncs a customer's subscriptions from Stripe to the database
-      def sync_subscriptions
-        subscriptions = ::Stripe::Subscription.list({customer: customer}, stripe_options)
+      # Syncs a customer's subscriptions from Stripe to the database.
+      # Note that by default canceled subscriptions are NOT returned by Stripe. In order to include them, use `sync_subscriptions(status: "all")`.
+      def sync_subscriptions(**options)
+        subscriptions = ::Stripe::Subscription.list(options.merge(customer: customer), stripe_options)
         subscriptions.map do |subscription|
           Pay::Stripe::Subscription.sync(subscription.id)
         end

data/lib/pay/stripe/charge.rb

@@ -14,7 +14,7 @@ module Pay
 
       def self.sync(charge_id, object: nil, stripe_account: nil, try: 0, retries: 1)
         # Skip loading the latest charge details from the API if we already have it
-        object ||= ::Stripe::Charge.retrieve({id: charge_id, expand: ["invoice.total_discount_amounts.discount", "invoice.total_tax_amounts.tax_rate"]}, {stripe_account: stripe_account}.compact)
+        object ||= ::Stripe::Charge.retrieve({id: charge_id, expand: ["invoice.total_discount_amounts.discount", "invoice.total_tax_amounts.tax_rate", "refunds"]}, {stripe_account: stripe_account}.compact)
 
         # Ignore charges without a Customer
         return if object.customer.blank?

data/lib/pay/stripe/payment_method.rb

@@ -9,6 +9,23 @@ module Pay
         @pay_payment_method = pay_payment_method
       end
 
+      # Syncs a PaymentIntent's payment method to the database
+      def self.sync_payment_intent(id, stripe_account: nil)
+        payment_intent = ::Stripe::PaymentIntent.retrieve({id: id, expand: ["payment_method"]}, {stripe_account: stripe_account}.compact)
+        payment_method = payment_intent.payment_method
+        return unless payment_method
+        Pay::Stripe::PaymentMethod.sync(payment_method.id, object: payment_method)
+      end
+
+      # Syncs a SetupIntent's payment method to the database
+      def self.sync_setup_intent(id, stripe_account: nil)
+        setup_intent = ::Stripe::SetupIntent.retrieve({id: id, expand: ["payment_method"]}, {stripe_account: stripe_account}.compact)
+        payment_method = setup_intent.payment_method
+        return unless payment_method
+        Pay::Stripe::PaymentMethod.sync(payment_method.id, object: payment_method)
+      end
+
+      # Syncs PaymentMethod objects from Stripe
       def self.sync(id, object: nil, stripe_account: nil, try: 0, retries: 1)
         object ||= ::Stripe::PaymentMethod.retrieve(id, {stripe_account: stripe_account}.compact)
 

data/lib/pay/stripe/subscription.rb

@@ -6,6 +6,7 @@ module Pay
 
       delegate :active?,
         :canceled?,
+        :on_grace_period?,
         :ends_at,
         :name,
         :on_trial?,
@@ -21,6 +22,8 @@ module Pay
         :trial_ends_at,
         :pause_behavior,
         :pause_resumes_at,
+        :current_period_start,
+        :current_period_end,
         to: :pay_subscription
 
       def self.sync(subscription_id, object: nil, name: nil, stripe_account: nil, try: 0, retries: 1)
@@ -32,6 +35,7 @@ module Pay
 
         attributes = {
           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,
@@ -40,12 +44,20 @@ module Pay
           subscription_items: [],
           metered: false,
           pause_behavior: object.pause_collection&.behavior,
-          pause_resumes_at: (object.pause_collection&.resumes_at ? Time.at(object.pause_collection&.resumes_at) : nil)
+          pause_resumes_at: (object.pause_collection&.resumes_at ? Time.at(object.pause_collection&.resumes_at) : nil),
+          current_period_start: (object.current_period_start ? Time.at(object.current_period_start) : nil),
+          current_period_end: (object.current_period_end ? Time.at(object.current_period_end) : nil)
         }
 
-        # Subscriptions that have ended should have their trial ended at the same time
+        # 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
-          attributes[:trial_ends_at] = Time.at(object.ended_at || object.trial_end)
+          trial_ended_at = [object.ended_at, object.trial_end].compact.min
+          attributes[:trial_ends_at] = Time.at(trial_ended_at)
         end
 
         # Record subscription items to db
@@ -71,11 +83,18 @@ module Pay
         # Update or create the subscription
         pay_subscription = pay_customer.subscriptions.find_by(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.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 = pay_customer.subscriptions.create!(attributes.merge(name: name, processor_id: object.id))
         end
 
@@ -153,7 +172,7 @@ module Pay
       # For a subscription with a single item, we can update the subscription directly if no SubscriptionItem ID is available
       # Otherwise a SubscriptionItem ID is required so Stripe knows which entry to update
       def change_quantity(quantity, **options)
-        subscription_item_id = options.fetch(:subscription_item_id, subscription_items&.first&.dig("id"))
+        subscription_item_id = options.delete(:subscription_item_id) || subscription_items&.first&.dig("id")
         if subscription_item_id
           ::Stripe::SubscriptionItem.update(subscription_item_id, options.merge(quantity: quantity), stripe_options)
           @stripe_subscription = nil
@@ -165,12 +184,8 @@ module Pay
         raise Pay::Stripe::Error, e
       end
 
-      def on_grace_period?
-        canceled? && Time.current < ends_at
-      end
-
       def paused?
-        pause_behavior.present?
+        pause_behavior == "void"
       end
 
       # Pauses a Stripe subscription
@@ -179,18 +194,32 @@ module Pay
       # 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
       def pause(**options)
-        attributes = {pause_collection: options.reverse_merge(behavior: "mark_uncollectible")}
+        attributes = {pause_collection: options.reverse_merge(behavior: "void")}
         @stripe_subscription = ::Stripe::Subscription.update(processor_id, attributes.merge(expand_options), stripe_options)
+        behavior = @stripe_subscription.pause_collection&.behavior
         pay_subscription.update(
-          pause_behavior: @stripe_subscription.pause_collection&.behavior,
-          pause_resumes_at: (@stripe_subscription.pause_collection&.resumes_at ? Time.at(@stripe_subscription.pause_collection&.resumes_at) : nil)
+          pause_behavior: behavior,
+          pause_resumes_at: (@stripe_subscription.pause_collection&.resumes_at ? Time.at(@stripe_subscription.pause_collection&.resumes_at) : nil),
+          pause_starts_at: ((behavior == "void") ? Time.at(@stripe_subscription.current_period_end) : nil)
         )
       end
 
+      # Unpauses a subscription
       def unpause
         @stripe_subscription = ::Stripe::Subscription.update(processor_id, {pause_collection: nil}.merge(expand_options), stripe_options)
-        pay_subscription.update(pause_behavior: nil, pause_resumes_at: nil)
+        pay_subscription.update(
+          pause_behavior: nil,
+          pause_resumes_at: nil,
+          pause_starts_at: nil
+        )
       end
 
       def resume
@@ -215,20 +244,24 @@ module Pay
         raise Pay::Stripe::Error, e
       end
 
-      def swap(plan)
+      def swap(plan, **options)
         raise ArgumentError, "plan must be a string" unless plan.is_a?(String)
 
+        proration_behavior = options.delete(:proration_behavior) || (prorate ? "always_invoice" : "none")
+
         @stripe_subscription = ::Stripe::Subscription.update(
           processor_id,
           {
             cancel_at_period_end: false,
             plan: plan,
-            proration_behavior: (prorate ? "create_prorations" : "none"),
+            proration_behavior: proration_behavior,
             trial_end: (on_trial? ? trial_ends_at.to_i : "now"),
             quantity: quantity
           }.merge(expand_options),
           stripe_options
         )
+
+        pay_subscription.sync!(object: @stripe_subscription)
       rescue ::Stripe::StripeError => e
         raise Pay::Stripe::Error, e
       end
@@ -262,6 +295,11 @@ module Pay
         ::Stripe::Invoice.upcoming(options.merge(subscription: processor_id), stripe_options)
       end
 
+      # Retries the latest invoice for a Past Due subscription
+      def retry_failed_payment
+        subscription.latest_invoice.pay
+      end
+
       private
 
       # Options for Stripe requests

data/lib/pay/stripe/webhooks/payment_intent_succeeded.rb

@@ -9,9 +9,7 @@ module Pay
 
         def call(event)
           object = event.data.object
-          object.charges.data.each do |charge|
-            Pay::Stripe::Charge.sync(charge.id, stripe_account: event.try(:account))
-          end
+          Pay::Stripe::Charge.sync(object.latest_charge, stripe_account: event.try(:account))
         end
       end
     end

data/lib/pay/stripe/webhooks/payment_method_attached.rb

@@ -4,10 +4,7 @@ module Pay
       class PaymentMethodAttached
         def call(event)
           object = event.data.object
-          pay_customer = Pay::Customer.find_by(processor: :stripe, processor_id: object.customer)
-          return unless pay_customer
-
-          pay_customer.save_payment_method(object, default: false)
+          Pay::Stripe::PaymentMethod.sync(object.id, stripe_account: event.try(:account))
         end
       end
     end

data/lib/pay/stripe/webhooks/payment_method_updated.rb

@@ -4,13 +4,7 @@ module Pay
       class PaymentMethodUpdated
         def call(event)
           object = event.data.object
-
           if object.customer
-            pay_customer = Pay::Customer.find_by(processor: :stripe, processor_id: object.customer)
-
-            # Couldn't find user, we can skip
-            return unless pay_customer.present?
-
             Pay::Stripe::PaymentMethod.sync(object.id, stripe_account: event.try(:account))
           else
             # If customer was removed, we should delete the payment method if it exists

data/lib/pay/stripe/webhooks/subscription_trial_will_end.rb

@@ -0,0 +1,24 @@
+module Pay
+  module Stripe
+    module Webhooks
+      class SubscriptionTrialWillEnd
+        def call(event)
+          object = event.data.object
+
+          pay_subscription = Pay::Subscription.find_by_processor_and_id(:stripe, object.id)
+          return if pay_subscription.nil?
+
+          pay_subscription.sync!
+
+          pay_user_mailer = Pay.mailer.with(pay_customer: pay_subscription.customer, pay_subscription: pay_subscription)
+
+          if Pay.send_email?(:subscription_trial_will_end, pay_subscription) && pay_subscription.on_trial?
+            pay_user_mailer.subscription_trial_will_end.deliver_later
+          elsif Pay.send_email?(:subscription_trial_ended, pay_subscription) && pay_subscription.trial_ended?
+            pay_user_mailer.subscription_trial_ended.deliver_later
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pay/stripe.rb

@@ -24,6 +24,7 @@ module Pay
       autoload :SubscriptionDeleted, "pay/stripe/webhooks/subscription_deleted"
       autoload :SubscriptionRenewing, "pay/stripe/webhooks/subscription_renewing"
       autoload :SubscriptionUpdated, "pay/stripe/webhooks/subscription_updated"
+      autoload :SubscriptionTrialWillEnd, "pay/stripe/webhooks/subscription_trial_will_end"
     end
 
     extend Env
@@ -31,12 +32,12 @@ module Pay
     def self.enabled?
       return false unless Pay.enabled_processors.include?(:stripe) && defined?(::Stripe)
 
-      Pay::Engine.version_matches?(required: "~> 7", current: ::Stripe::VERSION) || (raise "[Pay] stripe gem must be version ~> 7")
+      Pay::Engine.version_matches?(required: "~> 8", current: ::Stripe::VERSION) || (raise "[Pay] stripe gem must be version ~> 8")
     end
 
     def self.setup
       ::Stripe.api_key = private_key
-      ::Stripe.api_version = "2022-08-01"
+      ::Stripe.api_version = "2022-11-15"
 
       # Used by Stripe to identify Pay for support
       ::Stripe.set_app_info("PayRails", partner_id: "pp_partner_IqhY0UExnJYLxg", version: Pay::VERSION, url: "https://github.com/pay-rails/pay")
@@ -86,6 +87,9 @@ module Pay
         # When a customers subscription is canceled, we want to update our records
         events.subscribe "stripe.customer.subscription.deleted", Pay::Stripe::Webhooks::SubscriptionDeleted.new
 
+        # When a customers subscription trial period is 3 days from ending or ended immediately this event is fired
+        events.subscribe "stripe.customer.subscription.trial_will_end", Pay::Stripe::Webhooks::SubscriptionTrialWillEnd.new
+
         # Monitor changes for customer's default card changing
         events.subscribe "stripe.customer.updated", Pay::Stripe::Webhooks::CustomerUpdated.new
 

data/lib/pay/version.rb

@@ -1,3 +1,3 @@
 module Pay
-  VERSION = "5.0.3"
+  VERSION = "6.0.0"
 end

data/lib/pay/webhooks/delegator.rb

@@ -27,7 +27,7 @@ module Pay
 
       # Unsubscribe
       def unsubscribe(name)
-        backend.unsubscribe name
+        backend.unsubscribe name_with_namespace(name)
       end
 
       # Called to process an event

data/lib/pay.rb

@@ -61,6 +61,8 @@ module Pay
   @@emails.subscription_renewing = ->(pay_subscription, price) {
     (price&.type == "recurring") && (price.recurring&.interval == "year")
   }
+  @@emails.subscription_trial_will_end = true
+  @@emails.subscription_trial_ended = true
 
   @@mailer = "Pay::UserMailer"
 
@@ -76,6 +78,27 @@ module Pay
   mattr_accessor :parent_mailer
   @@parent_mailer = "Pay::ApplicationMailer"
 
+  # Should return a hash of arguments for the `mail` call in UserMailer
+  mattr_accessor :mail_arguments
+  @@mail_arguments = ->(mailer, params) {
+    {
+      to: Pay.mail_to.call(mailer, params)
+    }
+  }
+
+  # Should return String or Array of email recipients
+  mattr_accessor :mail_to
+  @@mail_to = ->(mailer, params) {
+    if ActionMailer::Base.respond_to?(:email_address_with_name)
+      ActionMailer::Base.email_address_with_name(params[:pay_customer].email, params[:pay_customer].customer_name)
+    else
+      Mail::Address.new.tap do |builder|
+        builder.address = params[:pay_customer].email
+        builder.display_name = params[:pay_customer].customer_name.presence
+      end.to_s
+    end
+  }
+
   def self.setup
     yield self
   end

data/lib/tasks/pay.rake

@@ -26,6 +26,6 @@ def sync_default_payment_method(pay_customer, retries: 2)
   rescue
     sleep 0.5
     try += 1
-    try <= retries ? retry : raise
+    (try <= retries) ? retry : raise
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pay
 version: !ruby/object:Gem::Version
-  version: 5.0.3
+  version: 6.0.0
 platform: ruby
 authors:
 - Jason Charnes
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-19 00:00:00.000000000 Z
+date: 2022-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -119,6 +119,8 @@ files:
 - app/views/pay/user_mailer/receipt.html.erb
 - app/views/pay/user_mailer/refund.html.erb
 - app/views/pay/user_mailer/subscription_renewing.html.erb
+- app/views/pay/user_mailer/subscription_trial_ended.html.erb
+- app/views/pay/user_mailer/subscription_trial_will_end.html.erb
 - config/currencies/iso.json
 - config/locales/en.yml
 - config/routes.rb
@@ -151,6 +153,7 @@ files:
 - lib/pay/fake_processor/billable.rb
 - lib/pay/fake_processor/charge.rb
 - lib/pay/fake_processor/error.rb
+- lib/pay/fake_processor/merchant.rb
 - lib/pay/fake_processor/payment_method.rb
 - lib/pay/fake_processor/subscription.rb
 - lib/pay/nano_id.rb
@@ -191,6 +194,7 @@ files:
 - lib/pay/stripe/webhooks/subscription_created.rb
 - lib/pay/stripe/webhooks/subscription_deleted.rb
 - lib/pay/stripe/webhooks/subscription_renewing.rb
+- lib/pay/stripe/webhooks/subscription_trial_will_end.rb
 - lib/pay/stripe/webhooks/subscription_updated.rb
 - lib/pay/version.rb
 - lib/pay/webhooks.rb