stripe 9.0.0 → 9.3.0

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

@@ -45,6 +45,16 @@ declare module 'stripe' {
        */
       billing_address_collection: PaymentLink.BillingAddressCollection;
 
+      /**
+       * When set, provides configuration to gather active consent from customers.
+       */
+      consent_collection: PaymentLink.ConsentCollection | null;
+
+      /**
+       * Configuration for Customer creation during checkout.
+       */
+      customer_creation: PaymentLink.CustomerCreation;
+
       /**
        * The line items representing what is being sold.
        */
@@ -65,6 +75,11 @@ declare module 'stripe' {
        */
       on_behalf_of: string | Stripe.Account | null;
 
+      /**
+       * Indicates the parameters to be passed to PaymentIntent creation during checkout.
+       */
+      payment_intent_data: PaymentLink.PaymentIntentData | null;
+
       /**
        * The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods).
        */
@@ -77,11 +92,23 @@ declare module 'stripe' {
        */
       shipping_address_collection: PaymentLink.ShippingAddressCollection | null;
 
+      /**
+       * The shipping rate options applied to the session.
+       */
+      shipping_options: Array<PaymentLink.ShippingOption>;
+
+      /**
+       * Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button.
+       */
+      submit_type: PaymentLink.SubmitType;
+
       /**
        * When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
        */
       subscription_data: PaymentLink.SubscriptionData | null;
 
+      tax_id_collection: PaymentLink.TaxIdCollection;
+
       /**
        * The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
        */
@@ -132,6 +159,33 @@ declare module 'stripe' {
 
       type BillingAddressCollection = 'auto' | 'required';
 
+      interface ConsentCollection {
+        /**
+         * If set to `auto`, enables the collection of customer consent for promotional communications.
+         */
+        promotions: 'auto' | null;
+      }
+
+      type CustomerCreation = 'always' | 'if_required';
+
+      interface PaymentIntentData {
+        /**
+         * Indicates when the funds will be captured from the customer's account.
+         */
+        capture_method: PaymentIntentData.CaptureMethod | null;
+
+        /**
+         * Indicates that you intend to make future payments with the payment method collected during checkout.
+         */
+        setup_future_usage: PaymentIntentData.SetupFutureUsage | null;
+      }
+
+      namespace PaymentIntentData {
+        type CaptureMethod = 'automatic' | 'manual';
+
+        type SetupFutureUsage = 'off_session' | 'on_session';
+      }
+
       interface PhoneNumberCollection {
         /**
          * If `true`, a phone number will be collected during checkout.
@@ -387,6 +441,20 @@ declare module 'stripe' {
           | 'ZZ';
       }
 
+      interface ShippingOption {
+        /**
+         * A non-negative integer in cents representing how much to charge.
+         */
+        shipping_amount: number;
+
+        /**
+         * The ID of the Shipping Rate to use for this shipping option.
+         */
+        shipping_rate: string | Stripe.ShippingRate;
+      }
+
+      type SubmitType = 'auto' | 'book' | 'donate' | 'pay';
+
       interface SubscriptionData {
         /**
          * Integer representing the number of trial period days before the customer is charged for the first time.
@@ -394,6 +462,13 @@ declare module 'stripe' {
         trial_period_days: number | null;
       }
 
+      interface TaxIdCollection {
+        /**
+         * Indicates whether tax ID collection is enabled for the session.
+         */
+        enabled: boolean;
+      }
+
       interface TransferData {
         /**
          * The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
@@ -443,6 +518,16 @@ declare module 'stripe' {
        */
       billing_address_collection?: PaymentLinkCreateParams.BillingAddressCollection;
 
+      /**
+       * Configure fields to gather active consent from customers.
+       */
+      consent_collection?: PaymentLinkCreateParams.ConsentCollection;
+
+      /**
+       * Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
+       */
+      customer_creation?: PaymentLinkCreateParams.CustomerCreation;
+
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -458,6 +543,11 @@ declare module 'stripe' {
        */
       on_behalf_of?: string;
 
+      /**
+       * A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.
+       */
+      payment_intent_data?: PaymentLinkCreateParams.PaymentIntentData;
+
       /**
        * The list of payment method types that customers can use. Only `card` is supported. If no value is passed, Stripe will dynamically show relevant payment methods from your [payment method settings](https://dashboard.stripe.com/settings/payment_methods) (20+ payment methods [supported](https://stripe.com/docs/payments/payment-methods/integration-options#payment-method-product-support)).
        */
@@ -475,11 +565,26 @@ declare module 'stripe' {
        */
       shipping_address_collection?: PaymentLinkCreateParams.ShippingAddressCollection;
 
+      /**
+       * The shipping rate options to apply to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.
+       */
+      shipping_options?: Array<PaymentLinkCreateParams.ShippingOption>;
+
+      /**
+       * Describes the type of transaction being performed in order to customize relevant text on the page, such as the submit button.
+       */
+      submit_type?: PaymentLinkCreateParams.SubmitType;
+
       /**
        * When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`.
        */
       subscription_data?: PaymentLinkCreateParams.SubscriptionData;
 
+      /**
+       * Controls tax ID collection during checkout.
+       */
+      tax_id_collection?: PaymentLinkCreateParams.TaxIdCollection;
+
       /**
        * The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to.
        */
@@ -531,6 +636,17 @@ declare module 'stripe' {
 
       type BillingAddressCollection = 'auto' | 'required';
 
+      interface ConsentCollection {
+        /**
+         * If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout
+         * Session will determine whether to display an option to opt into promotional communication
+         * from the merchant depending on the customer's locale. Only available to US merchants.
+         */
+        promotions?: 'auto';
+      }
+
+      type CustomerCreation = 'always' | 'if_required';
+
       interface LineItem {
         /**
          * When set, provides configuration for this item's quantity to be adjusted by the customer during checkout.
@@ -567,6 +683,34 @@ declare module 'stripe' {
         }
       }
 
+      interface PaymentIntentData {
+        /**
+         * Controls when the funds will be captured from the customer's account.
+         */
+        capture_method?: PaymentIntentData.CaptureMethod;
+
+        /**
+         * Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.
+         *
+         * When setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.
+         *
+         * When setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.
+         *
+         * 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 legislation and network rules, such as SCA.
+         */
+        setup_future_usage?: PaymentIntentData.SetupFutureUsage;
+      }
+
+      namespace PaymentIntentData {
+        type CaptureMethod = 'automatic' | 'manual';
+
+        type SetupFutureUsage = 'off_session' | 'on_session';
+      }
+
       interface PhoneNumberCollection {
         /**
          * Set to `true` to enable phone number collection.
@@ -823,6 +967,15 @@ declare module 'stripe' {
           | 'ZZ';
       }
 
+      interface ShippingOption {
+        /**
+         * The ID of the Shipping Rate to use for this shipping option.
+         */
+        shipping_rate?: string;
+      }
+
+      type SubmitType = 'auto' | 'book' | 'donate' | 'pay';
+
       interface SubscriptionData {
         /**
          * Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.
@@ -830,6 +983,13 @@ declare module 'stripe' {
         trial_period_days?: number;
       }
 
+      interface TaxIdCollection {
+        /**
+         * Set to `true` to enable tax ID collection.
+         */
+        enabled: boolean;
+      }
+
       interface TransferData {
         /**
          * The amount that will be transferred automatically when a charge succeeds.
@@ -879,6 +1039,11 @@ declare module 'stripe' {
        */
       billing_address_collection?: PaymentLinkUpdateParams.BillingAddressCollection;
 
+      /**
+       * Configures whether [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link create a [Customer](https://stripe.com/docs/api/customers).
+       */
+      customer_creation?: PaymentLinkUpdateParams.CustomerCreation;
+
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -952,6 +1117,8 @@ declare module 'stripe' {
 
       type BillingAddressCollection = 'auto' | 'required';
 
+      type CustomerCreation = 'always' | 'if_required';
+
       interface LineItem {
         /**
          * When set, provides configuration for this item's quantity to be adjusted by the customer during checkout.

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

@@ -18,6 +18,8 @@ declare module 'stripe' {
 
       acss_debit?: PaymentMethod.AcssDebit;
 
+      affirm?: PaymentMethod.Affirm;
+
       afterpay_clearpay?: PaymentMethod.AfterpayClearpay;
 
       alipay?: PaymentMethod.Alipay;
@@ -64,6 +66,8 @@ declare module 'stripe' {
 
       konbini?: PaymentMethod.Konbini;
 
+      link?: PaymentMethod.Link;
+
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
        */
@@ -122,6 +126,8 @@ declare module 'stripe' {
         transit_number: string | null;
       }
 
+      interface Affirm {}
+
       interface AfterpayClearpay {}
 
       interface Alipay {}
@@ -548,6 +554,18 @@ declare module 'stripe' {
 
       interface Konbini {}
 
+      interface Link {
+        /**
+         * Account owner's email address.
+         */
+        email: string | null;
+
+        /**
+         * Token used for persistent Link logins.
+         */
+        persistent_token?: string;
+      }
+
       interface Oxxo {}
 
       interface P24 {
@@ -643,6 +661,7 @@ declare module 'stripe' {
 
       type Type =
         | 'acss_debit'
+        | 'affirm'
         | 'afterpay_clearpay'
         | 'alipay'
         | 'au_becs_debit'
@@ -660,6 +679,7 @@ declare module 'stripe' {
         | 'interac_present'
         | 'klarna'
         | 'konbini'
+        | 'link'
         | 'oxxo'
         | 'p24'
         | 'paynow'
@@ -699,6 +719,11 @@ declare module 'stripe' {
          */
         last4: string | null;
 
+        /**
+         * Contains information about US bank account networks that can be used.
+         */
+        networks?: UsBankAccount.Networks | null;
+
         /**
          * Routing number of the bank account.
          */
@@ -709,6 +734,22 @@ declare module 'stripe' {
         type AccountHolderType = 'company' | 'individual';
 
         type AccountType = 'checking' | 'savings';
+
+        interface Networks {
+          /**
+           * The preferred network.
+           */
+          preferred: string | null;
+
+          /**
+           * All supported networks.
+           */
+          supported: Array<Networks.Supported>;
+        }
+
+        namespace Networks {
+          type Supported = 'ach' | 'us_domestic_wire';
+        }
       }
 
       interface WechatPay {}
@@ -720,6 +761,11 @@ declare module 'stripe' {
        */
       acss_debit?: PaymentMethodCreateParams.AcssDebit;
 
+      /**
+       * If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
+       */
+      affirm?: PaymentMethodCreateParams.Affirm;
+
       /**
        * If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
        */
@@ -815,6 +861,11 @@ declare module 'stripe' {
        */
       konbini?: PaymentMethodCreateParams.Konbini;
 
+      /**
+       * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
+       */
+      link?: PaymentMethodCreateParams.Link;
+
       /**
        * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        */
@@ -884,6 +935,8 @@ declare module 'stripe' {
         transit_number: string;
       }
 
+      interface Affirm {}
+
       interface AfterpayClearpay {}
 
       interface Alipay {}
@@ -1112,6 +1165,8 @@ declare module 'stripe' {
 
       interface Konbini {}
 
+      interface Link {}
+
       interface Oxxo {}
 
       interface P24 {
@@ -1172,6 +1227,7 @@ declare module 'stripe' {
 
       type Type =
         | 'acss_debit'
+        | 'affirm'
         | 'afterpay_clearpay'
         | 'alipay'
         | 'au_becs_debit'
@@ -1187,6 +1243,7 @@ declare module 'stripe' {
         | 'ideal'
         | 'klarna'
         | 'konbini'
+        | 'link'
         | 'oxxo'
         | 'p24'
         | 'paynow'
@@ -1244,6 +1301,11 @@ declare module 'stripe' {
        */
       acss_debit?: PaymentMethodUpdateParams.AcssDebit;
 
+      /**
+       * This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.
+       */
+      affirm?: PaymentMethodUpdateParams.Affirm;
+
       /**
        * This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.
        */
@@ -1269,6 +1331,11 @@ declare module 'stripe' {
        */
       expand?: Array<string>;
 
+      /**
+       * If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
+       */
+      link?: PaymentMethodUpdateParams.Link;
+
       /**
        * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        */
@@ -1288,6 +1355,8 @@ declare module 'stripe' {
     namespace PaymentMethodUpdateParams {
       interface AcssDebit {}
 
+      interface Affirm {}
+
       interface AuBecsDebit {}
 
       interface BacsDebit {}
@@ -1332,6 +1401,8 @@ declare module 'stripe' {
         exp_year?: number;
       }
 
+      interface Link {}
+
       interface SepaDebit {}
 
       interface UsBankAccount {
@@ -1366,6 +1437,7 @@ declare module 'stripe' {
     namespace PaymentMethodListParams {
       type Type =
         | 'acss_debit'
+        | 'affirm'
         | 'afterpay_clearpay'
         | 'alipay'
         | 'au_becs_debit'
@@ -1382,6 +1454,7 @@ declare module 'stripe' {
         | 'ideal'
         | 'klarna'
         | 'konbini'
+        | 'link'
         | 'oxxo'
         | 'p24'
         | 'paynow'

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

@@ -28,8 +28,8 @@ declare module 'stripe' {
 
       /**
        * A coupon contains information about a percent-off or amount-off discount you
-       * might want to apply to a customer. Coupons may be applied to [invoices](https://stripe.com/docs/api#invoices) or
-       * [orders](https://stripe.com/docs/api#create_order_legacy-coupon). Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge).
+       * might want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),
+       * [checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).
        */
       coupon: Stripe.Coupon;
 

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

@@ -267,9 +267,8 @@ declare module 'stripe' {
                 amount: number;
 
                 /**
-                 * A discount represents the actual application of a coupon to a particular
-                 * customer. It contains information about when the discount began and when it
-                 * will end.
+                 * A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+                 * It contains information about when the discount began, when it will end, and what it is applied to.
                  *
                  * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
                  */
@@ -353,9 +352,8 @@ declare module 'stripe' {
                 amount: number;
 
                 /**
-                 * A discount represents the actual application of a coupon to a particular
-                 * customer. It contains information about when the discount began and when it
-                 * will end.
+                 * A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+                 * It contains information about when the discount began, when it will end, and what it is applied to.
                  *
                  * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
                  */
@@ -470,9 +468,8 @@ declare module 'stripe' {
             amount: number;
 
             /**
-             * A discount represents the actual application of a coupon to a particular
-             * customer. It contains information about when the discount began and when it
-             * will end.
+             * A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).
+             * It contains information about when the discount began, when it will end, and what it is applied to.
              *
              * Related guide: [Applying Discounts to Subscriptions](https://stripe.com/docs/billing/subscriptions/discounts).
              */

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

@@ -89,7 +89,7 @@ declare module 'stripe' {
       source_transfer_reversal: string | Stripe.TransferReversal | null;
 
       /**
-       * Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details.
+       * Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details.
        */
       status: string | null;
 

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

@@ -87,6 +87,8 @@ declare module 'stripe' {
 
         ideal?: PaymentMethodDetails.Ideal;
 
+        link?: PaymentMethodDetails.Link;
+
         sepa_debit?: PaymentMethodDetails.SepaDebit;
 
         sofort?: PaymentMethodDetails.Sofort;
@@ -283,6 +285,8 @@ declare module 'stripe' {
             | 'TRIONL2U';
         }
 
+        interface Link {}
+
         interface SepaDebit {}
 
         interface Sofort {