API Updates

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

@@ -126,7 +126,7 @@ declare module 'stripe' {
           }
 
           interface SubscriptionCancel {
-            cancellation_reason?: SubscriptionCancel.CancellationReason;
+            cancellation_reason: SubscriptionCancel.CancellationReason;
 
             /**
              * Whether the feature is enabled.

types/2020-08-27/Charges.d.ts

@@ -924,7 +924,7 @@ declare module 'stripe' {
           brand: string | null;
 
           /**
-           * The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`).
+           * The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
            */
           cardholder_name: string | null;
 
@@ -1252,7 +1252,7 @@ declare module 'stripe' {
           brand: string | null;
 
           /**
-           * The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`).
+           * The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay.
            */
           cardholder_name: string | null;
 

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

@@ -422,6 +422,11 @@ declare module 'stripe' {
                */
               custom_mandate_url?: string;
 
+              /**
+               * List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode.
+               */
+              default_for?: Array<MandateOptions.DefaultFor>;
+
               /**
                * Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
                */
@@ -439,6 +444,8 @@ declare module 'stripe' {
             }
 
             namespace MandateOptions {
+              type DefaultFor = 'invoice' | 'subscription';
+
               type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
 
               type TransactionType = 'business' | 'personal';
@@ -1456,6 +1463,11 @@ declare module 'stripe' {
                */
               custom_mandate_url?: Stripe.Emptyable<string>;
 
+              /**
+               * List of Stripe products where this mandate can be selected automatically. Only usable in `setup` mode.
+               */
+              default_for?: Array<MandateOptions.DefaultFor>;
+
               /**
                * Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
                */
@@ -1473,6 +1485,8 @@ declare module 'stripe' {
             }
 
             namespace MandateOptions {
+              type DefaultFor = 'invoice' | 'subscription';
+
               type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
 
               type TransactionType = 'business' | 'personal';

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

@@ -581,6 +581,11 @@ declare module 'stripe' {
 
       namespace PaymentSettings {
         interface PaymentMethodOptions {
+          /**
+           * If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice's PaymentIntent.
+           */
+          acss_debit: PaymentMethodOptions.AcssDebit | null;
+
           /**
            * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
            */
@@ -593,6 +598,30 @@ declare module 'stripe' {
         }
 
         namespace PaymentMethodOptions {
+          interface AcssDebit {
+            mandate_options?: AcssDebit.MandateOptions;
+
+            /**
+             * Bank account verification method.
+             */
+            verification_method?: AcssDebit.VerificationMethod;
+          }
+
+          namespace AcssDebit {
+            interface MandateOptions {
+              /**
+               * Transaction type of the mandate.
+               */
+              transaction_type: MandateOptions.TransactionType | null;
+            }
+
+            namespace MandateOptions {
+              type TransactionType = 'business' | 'personal';
+            }
+
+            type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
+          }
+
           interface Bancontact {
             /**
              * Preferred language of the Bancontact authorization page that the customer is redirected to.
@@ -619,6 +648,7 @@ declare module 'stripe' {
         type PaymentMethodType =
           | 'ach_credit_transfer'
           | 'ach_debit'
+          | 'acss_debit'
           | 'au_becs_debit'
           | 'bacs_debit'
           | 'bancontact'
@@ -913,6 +943,11 @@ declare module 'stripe' {
 
       namespace PaymentSettings {
         interface PaymentMethodOptions {
+          /**
+           * If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice's PaymentIntent.
+           */
+          acss_debit?: Stripe.Emptyable<PaymentMethodOptions.AcssDebit>;
+
           /**
            * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
            */
@@ -925,6 +960,33 @@ declare module 'stripe' {
         }
 
         namespace PaymentMethodOptions {
+          interface AcssDebit {
+            /**
+             * Additional fields for Mandate creation
+             */
+            mandate_options?: AcssDebit.MandateOptions;
+
+            /**
+             * Verification method for the intent
+             */
+            verification_method?: AcssDebit.VerificationMethod;
+          }
+
+          namespace AcssDebit {
+            interface MandateOptions {
+              /**
+               * Transaction type of the mandate.
+               */
+              transaction_type?: MandateOptions.TransactionType;
+            }
+
+            namespace MandateOptions {
+              type TransactionType = 'business' | 'personal';
+            }
+
+            type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
+          }
+
           interface Bancontact {
             /**
              * Preferred language of the Bancontact authorization page that the customer is redirected to.
@@ -951,6 +1013,7 @@ declare module 'stripe' {
         type PaymentMethodType =
           | 'ach_credit_transfer'
           | 'ach_debit'
+          | 'acss_debit'
           | 'au_becs_debit'
           | 'bacs_debit'
           | 'bancontact'
@@ -1137,6 +1200,11 @@ declare module 'stripe' {
 
       namespace PaymentSettings {
         interface PaymentMethodOptions {
+          /**
+           * If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice's PaymentIntent.
+           */
+          acss_debit?: Stripe.Emptyable<PaymentMethodOptions.AcssDebit>;
+
           /**
            * If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
            */
@@ -1149,6 +1217,33 @@ declare module 'stripe' {
         }
 
         namespace PaymentMethodOptions {
+          interface AcssDebit {
+            /**
+             * Additional fields for Mandate creation
+             */
+            mandate_options?: AcssDebit.MandateOptions;
+
+            /**
+             * Verification method for the intent
+             */
+            verification_method?: AcssDebit.VerificationMethod;
+          }
+
+          namespace AcssDebit {
+            interface MandateOptions {
+              /**
+               * Transaction type of the mandate.
+               */
+              transaction_type?: MandateOptions.TransactionType;
+            }
+
+            namespace MandateOptions {
+              type TransactionType = 'business' | 'personal';
+            }
+
+            type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
+          }
+
           interface Bancontact {
             /**
              * Preferred language of the Bancontact authorization page that the customer is redirected to.
@@ -1175,6 +1270,7 @@ declare module 'stripe' {
         type PaymentMethodType =
           | 'ach_credit_transfer'
           | 'ach_debit'
+          | 'acss_debit'
           | 'au_becs_debit'
           | 'bacs_debit'
           | 'bancontact'

types/2020-08-27/Mandates.d.ts

@@ -101,6 +101,11 @@ declare module 'stripe' {
 
       namespace PaymentMethodDetails {
         interface AcssDebit {
+          /**
+           * List of Stripe products where this mandate can be selected automatically.
+           */
+          default_for?: Array<AcssDebit.DefaultFor>;
+
           /**
            * Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
            */
@@ -118,6 +123,8 @@ declare module 'stripe' {
         }
 
         namespace AcssDebit {
+          type DefaultFor = 'invoice' | 'subscription';
+
           type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
 
           type TransactionType = 'business' | 'personal';

types/2020-08-27/Reporting/ReportTypes.d.ts

@@ -32,6 +32,11 @@ declare module 'stripe' {
          */
         default_columns: Array<string> | null;
 
+        /**
+         * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+         */
+        livemode: boolean;
+
         /**
          * Human-readable name of the Report Type
          */

types/2020-08-27/SetupIntents.d.ts

@@ -302,6 +302,11 @@ declare module 'stripe' {
              */
             custom_mandate_url?: string;
 
+            /**
+             * List of Stripe products where this mandate can be selected automatically.
+             */
+            default_for?: Array<MandateOptions.DefaultFor>;
+
             /**
              * Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'.
              */
@@ -319,6 +324,8 @@ declare module 'stripe' {
           }
 
           namespace MandateOptions {
+            type DefaultFor = 'invoice' | 'subscription';
+
             type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
 
             type TransactionType = 'business' | 'personal';
@@ -521,6 +528,11 @@ declare module 'stripe' {
              */
             custom_mandate_url?: Stripe.Emptyable<string>;
 
+            /**
+             * List of Stripe products where this mandate can be selected automatically.
+             */
+            default_for?: Array<MandateOptions.DefaultFor>;
+
             /**
              * Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
              */
@@ -538,6 +550,8 @@ declare module 'stripe' {
           }
 
           namespace MandateOptions {
+            type DefaultFor = 'invoice' | 'subscription';
+
             type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
 
             type TransactionType = 'business' | 'personal';
@@ -689,6 +703,11 @@ declare module 'stripe' {
              */
             custom_mandate_url?: Stripe.Emptyable<string>;
 
+            /**
+             * List of Stripe products where this mandate can be selected automatically.
+             */
+            default_for?: Array<MandateOptions.DefaultFor>;
+
             /**
              * Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
              */
@@ -706,6 +725,8 @@ declare module 'stripe' {
           }
 
           namespace MandateOptions {
+            type DefaultFor = 'invoice' | 'subscription';
+
             type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
 
             type TransactionType = 'business' | 'personal';
@@ -948,6 +969,11 @@ declare module 'stripe' {
              */
             custom_mandate_url?: Stripe.Emptyable<string>;
 
+            /**
+             * List of Stripe products where this mandate can be selected automatically.
+             */
+            default_for?: Array<MandateOptions.DefaultFor>;
+
             /**
              * Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
              */
@@ -965,6 +991,8 @@ declare module 'stripe' {
           }
 
           namespace MandateOptions {
+            type DefaultFor = 'invoice' | 'subscription';
+
             type PaymentSchedule = 'combined' | 'interval' | 'sporadic';
 
             type TransactionType = 'business' | 'personal';