throw more specific error when accessing Invoice.payment_intent (#1736)

Author: xavdid-stripe

lib/stripe/stripe_object.rb

@@ -171,7 +171,19 @@ def update_attributes(values, opts = {}, dirty: true)
     end
 
     def [](key)
-      @values[key.to_sym]
+      key_sym = key.to_sym
+      return @values[key_sym] if @values.key?(key_sym)
+
+      # super specific one-off case to help users debug this property disappearing
+      # see also: https://go/j/DEVSDK-2835
+      if is_a?(Invoice) && key_sym == :payment_intent
+        raise KeyError,
+              "The 'payment_intent' attribute is no longer available on Invoice objects. " \
+              "See the docs for more details: https://docs.stripe.com/changelog/basil/2025-03-31/" \
+              "add-support-for-multiple-partial-payments-on-invoices#why-is-this-a-breaking-change"
+      end
+
+      nil
     end
 
     def []=(key, value)
@@ -432,6 +444,15 @@ class << self; self; end
       begin
         super
       rescue NoMethodError => e
+        # super specific one-off case to help users debug this property disappearing
+        # see also: https://go/j/DEVSDK-2835
+        if is_a?(Invoice) && name == :payment_intent
+          raise NoMethodError,
+                "The 'payment_intent' attribute is no longer available on Invoice objects. " \
+                "See the docs for more details: https://docs.stripe.com/changelog/basil/2025-03-31/" \
+                "add-support-for-multiple-partial-payments-on-invoices#why-is-this-a-breaking-change"
+        end
+
         # If we notice the accessed name of our set of transient values we can
         # give the user a slightly more helpful error message. If not, just
         # raise right away.

test/stripe/stripe_object_test.rb

@@ -785,5 +785,44 @@ class WithAdditiveObjectParam < Stripe::StripeObject # rubocop:todo Lint/Constan
         assert account.company.is_a?(Stripe::Account::Company) if account.respond_to?(:company) && account.company
       end
     end
+
+    should "raise special error for Invoice.payment_intent" do
+      is_good_error = lambda do |e|
+        e.message.include?("multiple-partial-payments-on-invoices")
+      end
+
+      i = Stripe::Invoice.construct_from({})
+
+      # Test attribute access
+      e = assert_raises(NoMethodError) do
+        i.payment_intent
+      end
+      assert is_good_error.call(e)
+
+      # Test hash access
+      e = assert_raises(KeyError) do
+        i[:payment_intent]
+      end
+      assert is_good_error.call(e)
+
+      # Only that property gets the special error
+      e = assert_raises(NoMethodError) do
+        i.blah
+      end
+      assert !is_good_error.call(e)
+
+      # Other properties don't get the special error with hash access
+      assert_nil i[:blah]
+
+      # Other classes don't have that special error
+      so = Stripe::StripeObject.construct_from({})
+      e = assert_raises(NoMethodError) do
+        so.payment_intent
+      end
+      assert !is_good_error.call(e)
+
+      # Hash access on non-Invoice objects returns nil
+      assert_nil so[:payment_intent]
+    end
   end
 end