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

xavdid-stripe · web-flow · commit 0e8ad0b2da00 · 2025-11-21T09:56:46.000-08:00
diff --git a/stripe/_stripe_object.py b/stripe/_stripe_object.py
@@ -216,6 +216,15 @@ def __getitem__(self, k: str) -> Any:
                     % (k, k, ", ".join(list(self.keys())))
                 )
             else:
+                from stripe._invoice import Invoice
+
+                # super specific one-off case to help users debug this property disappearing
+                # see also: https://go/j/DEVSDK-2835
+                if isinstance(self, Invoice) and k == "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"
+                    )
+
                 raise err
 
     def __delitem__(self, k: str) -> None:
diff --git a/tests/test_stripe_object.py b/tests/test_stripe_object.py
@@ -6,6 +6,7 @@
 import pytest
 
 import stripe
+from stripe._invoice import Invoice
 from stripe._stripe_object import StripeObject
 
 # We use this because it has a map, "restriction.currency_options" from string -> CurrencyOptions nested class.
@@ -433,3 +434,36 @@ def test_can_update_api_key(self, http_client_mock):
             api_key="key2",
             stripe_account=None,
         )
+
+    def test_invoice_payment_method_gets_special_error(self):
+        def is_good_error(e: Exception) -> bool:
+            return "multiple-partial-payments-on-invoices" in str(e)
+
+        i = Invoice()
+
+        with pytest.raises(AttributeError) as e:
+            i.payment_intent  # type: ignore
+        assert is_good_error(e.value)
+
+        with pytest.raises(KeyError) as e:
+            i["payment_intent"]
+        assert is_good_error(e.value)
+
+        # only that property gets the special error
+        with pytest.raises(AttributeError) as e:
+            i.blah  # type: ignore
+        assert not is_good_error(e.value)
+
+        with pytest.raises(KeyError) as e:
+            i["blah"]
+        assert not is_good_error(e.value)
+
+        # other classes don't have that special error
+        so = StripeObject()
+        with pytest.raises(AttributeError) as e:
+            so.payment_intent  # type: ignore
+        assert not is_good_error(e.value)
+
+        with pytest.raises(KeyError) as e:
+            so["payment_intent"]
+        assert not is_good_error(e.value)
