Add defaultValues to StripePaymentElementOptions interface (#332)

* Add `defaultValues` to `StripePaymentElementOptions` * Run prettier * Use 🐍 case for postal code
stripe · Jun 16, 2022 · d5d45f6 · d5d45f6
1 parent 19cdc3e
commit d5d45f6
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/tests/types/src/valid.ts b/tests/types/src/valid.ts
@@ -266,6 +266,21 @@ const afterpayClearpayMessageElement = elements.create(
 );
 
 const paymentElement: StripePaymentElement = elements.create('payment', {
+  defaultValues: {
+    billingDetails: {
+      name: 'Jane Doe',
+      email: 'jane.doe@example.com',
+      phone: '8004444444',
+      address: {
+        line1: '354 Oyster Point Blvd',
+        line2: '',
+        city: 'South San Francisco',
+        state: 'CA',
+        country: 'US',
+        postal_code: '94080',
+      },
+    },
+  },
   fields: {
     billingDetails: {
       email: 'never',

diff --git a/types/stripe-js/elements/payment.d.ts b/types/stripe-js/elements/payment.d.ts
@@ -110,6 +110,22 @@ export type StripePaymentElement = StripeElementBase & {
   collapse(): StripePaymentElement;
 };
 
+export interface DefaultValuesOption {
+  billingDetails?: {
+    name?: string;
+    email?: string;
+    phone?: string;
+    address?: {
+      country?: string;
+      postal_code?: string;
+      state?: string;
+      city?: string;
+      line1?: string;
+      line2?: string;
+    };
+  };
+}
+
 export type FieldOption = 'auto' | 'never';
 
 export interface FieldsOption {
@@ -152,6 +168,11 @@ export interface WalletsOption {
 }
 
 export interface StripePaymentElementOptions {
+  /**
+   * Provide initial customer information that will be displayed in the Payment Element.
+   */
+  defaultValues?: DefaultValuesOption;
+
   /**
    * Override the business name displayed in the Payment Element.
    * By default the PaymentElement will use your Stripe account or business name.