stripe 8.195.0 → 8.196.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 8.196.0 - 2022-01-12
+* [#1328](https://github.com/stripe/stripe-node/pull/1328) API Updates
+  * Add support for `customer_creation` on `CheckoutSessionCreateParams` and `Checkout.Session`
+  * Add support for `fpx` and `grabpay` on `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentIntentConfirmParams.payment_method_options`, and `PaymentIntent.payment_method_options`
+* [#1315](https://github.com/stripe/stripe-node/pull/1315) API Updates
+  * Add support for `mandate_options` on `SubscriptionCreateParams.payment_settings.payment_method_options.card`, `SubscriptionUpdateParams.payment_settings.payment_method_options.card`, and `Subscription.payment_settings.payment_method_options.card`
+* [#1327](https://github.com/stripe/stripe-node/pull/1327) Remove DOM type references.
+* [#1325](https://github.com/stripe/stripe-node/pull/1325) Add comment documenting makeRequest#headers type.
+
 ## 8.195.0 - 2021-12-22
 * [#1314](https://github.com/stripe/stripe-node/pull/1314) API Updates
   * Add support for `au_becs_debit` on `PaymentIntentCreateParams.payment_method_options`, `PaymentIntentUpdateParams.payment_method_options`, `PaymentIntentConfirmParams.payment_method_options`, and `PaymentIntent.payment_method_options`

package/VERSION

@@ -1 +1 @@
-8.195.0
+8.196.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "8.195.0",
+  "version": "8.196.0",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",

package/types/2020-08-27/BillingPortal/Configurations.d.ts

@@ -442,7 +442,7 @@ declare module 'stripe' {
 
             interface Product {
               /**
-               * The list of prices IDs that a subscription can be updated to.
+               * The list of price IDs for the product that a subscription can be updated to.
                */
               prices: Array<string>;
 
@@ -678,7 +678,7 @@ declare module 'stripe' {
 
             interface Product {
               /**
-               * The list of prices IDs that a subscription can be updated to.
+               * The list of price IDs for the product that a subscription can be updated to.
                */
               prices: Array<string>;
 

package/types/2020-08-27/Checkout/Sessions.d.ts

@@ -81,6 +81,11 @@ declare module 'stripe' {
          */
         customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
 
+        /**
+         * Configure whether a Checkout Session creates a Customer when the Checkout Session completes.
+         */
+        customer_creation: Session.CustomerCreation | null;
+
         /**
          * The customer details including the customer's tax exempt status and the customer's tax IDs. Only present on Sessions in `payment` or `subscription` mode.
          */
@@ -289,6 +294,8 @@ declare module 'stripe' {
           promotions: 'auto' | null;
         }
 
+        type CustomerCreation = 'always' | 'if_required';
+
         interface CustomerDetails {
           /**
            * The email associated with the Customer, if one exists, on the Checkout Session at the time of checkout or at time of session expiry.
@@ -914,7 +921,7 @@ declare module 'stripe' {
          * ID of an existing Customer, if one exists. In `payment` mode, the customer's most recent card
          * payment method will be used to prefill the email, name, card details, and billing address
          * on the Checkout page. In `subscription` mode, the customer's [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)
-         * will be used if it's a card, and otherwise the most recent card will be used. A valid billing address is required for Checkout to prefill the customer's card details.
+         * will be used if it's a card, and otherwise the most recent card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.
          *
          * If the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.
          * If the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.
@@ -925,6 +932,18 @@ declare module 'stripe' {
          */
         customer?: string;
 
+        /**
+         * Configure whether a Checkout Session creates a [Customer](https://stripe.com/docs/api/customers) during Session confirmation.
+         *
+         * When a Customer is not created, you can still retrieve email, address, and other customer data entered in Checkout
+         * with [customer_details](https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-customer_details).
+         *
+         * Sessions that do not create Customers will instead create [Guest Customers](https://support.stripe.com/questions/guest-customer-faq) in the Dashboard.
+         *
+         * Can only be set in `payment` and `setup` mode.
+         */
+        customer_creation?: SessionCreateParams.CustomerCreation;
+
         /**
          * If provided, this value will be used when the Customer object is created.
          * If not provided, customers will be asked to enter their email address.
@@ -1089,6 +1108,8 @@ declare module 'stripe' {
           promotions?: 'auto';
         }
 
+        type CustomerCreation = 'always' | 'if_required';
+
         interface CustomerUpdate {
           /**
            * Describes whether Checkout saves the billing address onto `customer.address`.
@@ -1383,9 +1404,12 @@ declare module 'stripe' {
            * customer that their payment details will be saved and used for future
            * payments.
            *
-           * For both values, Checkout will attach the payment method to either the
-           * provided Customer for the session, or a new Customer created by Checkout
-           * if one has not been provided.
+           * If a Customer has been provided or Checkout creates a new Customer,
+           * Checkout will attach the payment method to the Customer.
+           *
+           * If Checkout does not create a Customer, the payment method is not attached
+           * to a Customer. To reuse the payment method, you can retrieve it from the
+           * Checkout Session's PaymentIntent.
            *
            * When processing card payments, Checkout also uses `setup_future_usage`
            * to dynamically optimize your payment flow and comply with regional

package/types/2020-08-27/InvoiceLineItems.d.ts

@@ -183,7 +183,7 @@ declare module 'stripe' {
       customer_details?: InvoiceLineItemListUpcomingParams.CustomerDetails;
 
       /**
-       * The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead.
+       * The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead.
        */
       discounts?: Stripe.Emptyable<
         Array<InvoiceLineItemListUpcomingParams.Discount>

package/types/2020-08-27/Invoices.d.ts

@@ -1414,7 +1414,7 @@ declare module 'stripe' {
       customer_details?: InvoiceRetrieveUpcomingParams.CustomerDetails;
 
       /**
-       * The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead.
+       * The coupons to redeem into discounts for the invoice preview. If not specified, inherits the discount from the customer or subscription. This only works for coupons directly applied to the invoice. To apply a coupon to a subscription, you must use the `coupon` parameter instead. Pass an empty string to avoid inheriting any discounts. To preview the upcoming invoice for a subscription that hasn't been created, use `coupon` instead.
        */
       discounts?: Stripe.Emptyable<
         Array<InvoiceRetrieveUpcomingParams.Discount>

package/types/2020-08-27/PaymentIntents.d.ts

@@ -526,8 +526,12 @@ declare module 'stripe' {
 
         card_present?: PaymentMethodOptions.CardPresent;
 
+        fpx?: PaymentMethodOptions.Fpx;
+
         giropay?: PaymentMethodOptions.Giropay;
 
+        grabpay?: PaymentMethodOptions.Grabpay;
+
         ideal?: PaymentMethodOptions.Ideal;
 
         interac_present?: PaymentMethodOptions.InteracPresent;
@@ -720,8 +724,12 @@ declare module 'stripe' {
 
         interface CardPresent {}
 
+        interface Fpx {}
+
         interface Giropay {}
 
+        interface Grabpay {}
+
         interface Ideal {}
 
         interface InteracPresent {}
@@ -1518,11 +1526,21 @@ declare module 'stripe' {
          */
         card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
 
+        /**
+         * If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
+         */
+        fpx?: Stripe.Emptyable<PaymentMethodOptions.Fpx>;
+
         /**
          * If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
          */
         giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
 
+        /**
+         * If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
+         */
+        grabpay?: Stripe.Emptyable<PaymentMethodOptions.Grabpay>;
+
         /**
          * If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
          */
@@ -1738,8 +1756,12 @@ declare module 'stripe' {
 
         interface CardPresent {}
 
+        interface Fpx {}
+
         interface Giropay {}
 
+        interface Grabpay {}
+
         interface Ideal {}
 
         interface InteracPresent {}
@@ -2469,11 +2491,21 @@ declare module 'stripe' {
          */
         card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
 
+        /**
+         * If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
+         */
+        fpx?: Stripe.Emptyable<PaymentMethodOptions.Fpx>;
+
         /**
          * If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
          */
         giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
 
+        /**
+         * If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
+         */
+        grabpay?: Stripe.Emptyable<PaymentMethodOptions.Grabpay>;
+
         /**
          * If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
          */
@@ -2689,8 +2721,12 @@ declare module 'stripe' {
 
         interface CardPresent {}
 
+        interface Fpx {}
+
         interface Giropay {}
 
+        interface Grabpay {}
+
         interface Ideal {}
 
         interface InteracPresent {}
@@ -3534,11 +3570,21 @@ declare module 'stripe' {
          */
         card_present?: Stripe.Emptyable<PaymentMethodOptions.CardPresent>;
 
+        /**
+         * If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
+         */
+        fpx?: Stripe.Emptyable<PaymentMethodOptions.Fpx>;
+
         /**
          * If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
          */
         giropay?: Stripe.Emptyable<PaymentMethodOptions.Giropay>;
 
+        /**
+         * If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
+         */
+        grabpay?: Stripe.Emptyable<PaymentMethodOptions.Grabpay>;
+
         /**
          * If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
          */
@@ -3754,8 +3800,12 @@ declare module 'stripe' {
 
         interface CardPresent {}
 
+        interface Fpx {}
+
         interface Giropay {}
 
+        interface Grabpay {}
+
         interface Ideal {}
 
         interface InteracPresent {}

package/types/2020-08-27/Subscriptions.d.ts

@@ -297,6 +297,8 @@ declare module 'stripe' {
           }
 
           interface Card {
+            mandate_options?: Card.MandateOptions;
+
             /**
              * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
              */
@@ -304,6 +306,27 @@ declare module 'stripe' {
           }
 
           namespace Card {
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments.
+               */
+              amount: number | null;
+
+              /**
+               * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
+               */
+              amount_type: MandateOptions.AmountType | null;
+
+              /**
+               * A description of the mandate or subscription that is meant to be displayed to the customer.
+               */
+              description: string | null;
+            }
+
+            namespace MandateOptions {
+              type AmountType = 'fixed' | 'maximum';
+            }
+
             type RequestThreeDSecure = 'any' | 'automatic';
           }
         }
@@ -798,6 +821,11 @@ declare module 'stripe' {
           }
 
           interface Card {
+            /**
+             * Configuration options for setting up an eMandate for cards issued in India.
+             */
+            mandate_options?: Card.MandateOptions;
+
             /**
              * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
              */
@@ -805,6 +833,27 @@ declare module 'stripe' {
           }
 
           namespace Card {
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments.
+               */
+              amount?: number;
+
+              /**
+               * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
+               */
+              amount_type?: MandateOptions.AmountType;
+
+              /**
+               * A description of the mandate or subscription that is meant to be displayed to the customer.
+               */
+              description?: string;
+            }
+
+            namespace MandateOptions {
+              type AmountType = 'fixed' | 'maximum';
+            }
+
             type RequestThreeDSecure = 'any' | 'automatic';
           }
         }
@@ -1304,6 +1353,11 @@ declare module 'stripe' {
           }
 
           interface Card {
+            /**
+             * Configuration options for setting up an eMandate for cards issued in India.
+             */
+            mandate_options?: Card.MandateOptions;
+
             /**
              * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
              */
@@ -1311,6 +1365,27 @@ declare module 'stripe' {
           }
 
           namespace Card {
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments.
+               */
+              amount?: number;
+
+              /**
+               * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
+               */
+              amount_type?: MandateOptions.AmountType;
+
+              /**
+               * A description of the mandate or subscription that is meant to be displayed to the customer.
+               */
+              description?: string;
+            }
+
+            namespace MandateOptions {
+              type AmountType = 'fixed' | 'maximum';
+            }
+
             type RequestThreeDSecure = 'any' | 'automatic';
           }
         }

package/types/crypto/crypto.d.ts

@@ -47,7 +47,13 @@ declare module 'stripe' {
      * defaults to the `crypto.subtle` object in the global scope.
      */
     export const createSubtleCryptoProvider: (
-      subtleCrypto?: WindowOrWorkerGlobalScope['crypto']['subtle']
+      /**
+       * The SubtleCrypto type cannot be specified without pulling in DOM types.
+       * This corresponds to WindowOrWorkerGlobalScope['crypto']['subtle'] for
+       * applications which pull in DOM types.
+       */
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      subtleCrypto?: any
     ) => CryptoProvider;
   }
 }

package/types/net/net.d.ts

@@ -1,5 +1,4 @@
 /// <reference types="node" />
-/// <reference lib="dom" />
 
 import {IncomingMessage} from 'http';
 declare module 'stripe' {
@@ -19,6 +18,11 @@ declare module 'stripe' {
         port: string | number,
         path: string,
         method: 'GET' | 'POST' | 'PUT' | 'DELETE',
+        // object is used here as this is implementation-specific. This is
+        // generally {[key: string]: string}, but various underlying clients
+        // support other types as well. As examples:
+        // - Node supports {[key: string]: string | number | string[]}.
+        // - Fetch supports a Headers object.
         headers: object,
         requestData: string | null,
         protocol: Stripe.HttpProtocol,
@@ -71,11 +75,24 @@ declare module 'stripe' {
      * passed, will default to the default `fetch` function in the global scope.
      */
     export const createFetchHttpClient: (
-      fetchFn?: WindowOrWorkerGlobalScope['fetch']
+      /** When specified, interface should match the Web Fetch API function. */
+      fetchFn?: Function
     ) => HttpClient<
       HttpClientResponse<
-        ReturnType<WindowOrWorkerGlobalScope['fetch']>,
-        ReadableStream<Uint8Array>
+        /**
+         * The response type cannot be specified without pulling in DOM types.
+         * This corresponds to ReturnType<WindowOrWorkerGlobalScope['fetch']>
+         * for applications which pull in DOM types.
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        any,
+        /**
+         * The stream type cannot be specified without pulling in DOM types.
+         * This corresponds to ReadableStream<Uint8Array> for applications which
+         * pull in DOM types.
+         */
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        any
       >
     >;
   }

package/types/test/typescriptTest.ts

@@ -228,7 +228,7 @@ async (): Promise<void> => {
 
 // Test FetchHttpClient request processing.
 async (): Promise<void> => {
-  const client = Stripe.createFetchHttpClient(window.fetch);
+  const client = Stripe.createFetchHttpClient();
 
   const response = await client.makeRequest(
     'api.stripe.com',
@@ -244,7 +244,7 @@ async (): Promise<void> => {
     80000
   );
 
-  const stream: ReadableStream = response.toStream(() => {
+  const stream = response.toStream(() => {
     return;
   });