add if_required type to PE fields.billingDetails.address (#661)

stripe · Oct 8, 2024 · 94a07cf · 94a07cf
1 parent 5965cef
commit 94a07cf
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/tests/types/src/invalid.ts b/tests/types/src/invalid.ts
@@ -100,6 +100,14 @@ elements.create('payment', {
   defaultValues: {card: {network: 'invalid_network'}},
 });
 
+// invalid value for fields
+// @ts-expect-error: No overload matches this call
+elements.create('payment', {
+  fields: {
+    billingDetails: 'if_required',
+  },
+});
+
 paymentElement.on('change', (e) => {
   // @ts-expect-error: `error` is not present on PaymentElement "change" event.
   if (e.error) {

diff --git a/tests/types/src/valid.ts b/tests/types/src/valid.ts
@@ -415,7 +415,7 @@ const paymentElement: StripePaymentElement = elements.create('payment', {
     billingDetails: {
       email: 'never',
       phone: 'auto',
-      address: 'never',
+      address: 'if_required',
     },
   },
   terms: {

diff --git a/types/stripe-js/elements/payment.d.ts b/types/stripe-js/elements/payment.d.ts
@@ -183,6 +183,7 @@ export interface FieldsOption {
         phone?: FieldOption;
         address?:
           | FieldOption
+          | 'if_required'
           | {
               country?: FieldOption;
               postalCode?: FieldOption;