stripe 9.8.0-beta.1 → 9.8.0

package/CHANGELOG.md

@@ -1,8 +1,18 @@
 # CHANGELOG
 
-## 9.8.0-beta.1 - 2022-06-08
-* [#1442](https://github.com/stripe/stripe-node/pull/1442) API Updates
-  * Add support for `network_details` method on resource `ReceivedCredits`/`ReceivedDebits`
+## 9.8.0 - 2022-06-09
+* [#1448](https://github.com/stripe/stripe-node/pull/1448) Add types for extra request options
+* [#1446](https://github.com/stripe/stripe-node/pull/1446) API Updates
+  * Add support for `treasury` on `Account.settings`, `AccountCreateParams.settings`, and `AccountUpdateParams.settings`
+  * Add support for `rendering_options` on `CustomerCreateParams.invoice_settings` and `CustomerUpdateParams.invoice_settings`
+  * Add support for `eu_bank_transfer` on `CustomerCreateFundingInstructionsParams.bank_transfer`, `Invoice.payment_settings.payment_method_options.customer_balance.bank_transfer`, `InvoiceCreateParams.payment_settings.payment_method_options.customer_balance.bank_transfer`, `InvoiceUpdateParams.payment_settings.payment_method_options.customer_balance.bank_transfer`, `Order.payment.settings.payment_method_options.customer_balance.bank_transfer`, `OrderCreateParams.payment.settings.payment_method_options.customer_balance.bank_transfer`, `OrderUpdateParams.payment.settings.payment_method_options.customer_balance.bank_transfer`, `PaymentIntent.payment_method_options.customer_balance.bank_transfer`, `PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer`, `PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer`, `PaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer`, `Subscription.payment_settings.payment_method_options.customer_balance.bank_transfer`, `SubscriptionCreateParams.payment_settings.payment_method_options.customer_balance.bank_transfer`, and `SubscriptionUpdateParams.payment_settings.payment_method_options.customer_balance.bank_transfer`
+  * Change type of `CustomerCreateFundingInstructionsParams.bank_transfer.requested_address_types[]` from `literal('zengin')` to `enum('iban'|'sort_code'|'spei'|'zengin')`
+  * Change type of `CustomerCreateFundingInstructionsParams.bank_transfer.type`, `Order.payment.settings.payment_method_options.customer_balance.bank_transfer.type`, `OrderCreateParams.payment.settings.payment_method_options.customer_balance.bank_transfer.type`, `OrderUpdateParams.payment.settings.payment_method_options.customer_balance.bank_transfer.type`, `PaymentIntent.next_action.display_bank_transfer_instructions.type`, `PaymentIntent.payment_method_options.customer_balance.bank_transfer.type`, `PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer.type`, `PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer.type`, and `PaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer.type` from `literal('jp_bank_transfer')` to `enum('eu_bank_transfer'|'gb_bank_transfer'|'jp_bank_transfer'|'mx_bank_transfer')`
+  * Add support for `iban`, `sort_code`, and `spei` on `FundingInstructions.bank_transfer.financial_addresses[]` and `PaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[]`
+  * Add support for new values `bacs`, `fps`, and `spei` on enums `FundingInstructions.bank_transfer.financial_addresses[].supported_networks[]` and `PaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].supported_networks[]`
+  * Add support for new values `sort_code` and `spei` on enums `FundingInstructions.bank_transfer.financial_addresses[].type` and `PaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].type`
+  * Change type of `Order.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]`, `OrderCreateParams.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]`, `OrderUpdateParams.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]`, `PaymentIntent.payment_method_options.customer_balance.bank_transfer.requested_address_types[]`, `PaymentIntentConfirmParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[]`, `PaymentIntentCreateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[]`, and `PaymentIntentUpdateParams.payment_method_options.customer_balance.bank_transfer.requested_address_types[]` from `literal('zengin')` to `enum`
+  * Add support for `custom_unit_amount` on `PriceCreateParams` and `Price`
 
 ## 9.7.0 - 2022-06-08
 * [#1441](https://github.com/stripe/stripe-node/pull/1441) API Updates

package/VERSION

@@ -1 +1 @@
-9.8.0-beta.1
+9.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stripe",
-  "version": "9.8.0-beta.1",
+  "version": "9.8.0",
   "description": "Stripe API wrapper",
   "keywords": [
     "stripe",

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

@@ -874,6 +874,8 @@ declare module 'stripe' {
         payouts?: Settings.Payouts;
 
         sepa_debit_payments?: Settings.SepaDebitPayments;
+
+        treasury?: Settings.Treasury;
       }
 
       namespace Settings {
@@ -1025,6 +1027,29 @@ declare module 'stripe' {
            */
           creditor_id?: string;
         }
+
+        interface Treasury {
+          tos_acceptance?: Treasury.TosAcceptance;
+        }
+
+        namespace Treasury {
+          interface TosAcceptance {
+            /**
+             * The Unix timestamp marking when the account representative accepted the service agreement.
+             */
+            date: number | null;
+
+            /**
+             * The IP address from which the account representative accepted the service agreement.
+             */
+            ip: string | null;
+
+            /**
+             * The user agent of the browser from which the account representative accepted the service agreement.
+             */
+            user_agent?: string;
+          }
+        }
       }
 
       interface TosAcceptance {
@@ -2069,6 +2094,11 @@ declare module 'stripe' {
          * Settings specific to the account's payouts.
          */
         payouts?: Settings.Payouts;
+
+        /**
+         * Settings specific to the account's Treasury FinancialAccounts.
+         */
+        treasury?: Settings.Treasury;
       }
 
       namespace Settings {
@@ -2216,6 +2246,32 @@ declare module 'stripe' {
               | 'wednesday';
           }
         }
+
+        interface Treasury {
+          /**
+           * Details on the account's acceptance of the Stripe Treasury Services Agreement.
+           */
+          tos_acceptance?: Treasury.TosAcceptance;
+        }
+
+        namespace Treasury {
+          interface TosAcceptance {
+            /**
+             * The Unix timestamp marking when the account representative accepted the service agreement.
+             */
+            date?: number;
+
+            /**
+             * The IP address from which the account representative accepted the service agreement.
+             */
+            ip?: string;
+
+            /**
+             * The user agent of the browser from which the account representative accepted the service agreement.
+             */
+            user_agent?: string;
+          }
+        }
       }
 
       interface TosAcceptance {
@@ -3200,6 +3256,11 @@ declare module 'stripe' {
          * Settings specific to the account's payouts.
          */
         payouts?: Settings.Payouts;
+
+        /**
+         * Settings specific to the account's Treasury FinancialAccounts.
+         */
+        treasury?: Settings.Treasury;
       }
 
       namespace Settings {
@@ -3347,6 +3408,32 @@ declare module 'stripe' {
               | 'wednesday';
           }
         }
+
+        interface Treasury {
+          /**
+           * Details on the account's acceptance of the Stripe Treasury Services Agreement.
+           */
+          tos_acceptance?: Treasury.TosAcceptance;
+        }
+
+        namespace Treasury {
+          interface TosAcceptance {
+            /**
+             * The Unix timestamp marking when the account representative accepted the service agreement.
+             */
+            date?: number;
+
+            /**
+             * The IP address from which the account representative accepted the service agreement.
+             */
+            ip?: string;
+
+            /**
+             * The user agent of the browser from which the account representative accepted the service agreement.
+             */
+            user_agent?: string;
+          }
+        }
       }
 
       interface TosAcceptance {

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

@@ -418,6 +418,11 @@ declare module 'stripe' {
          * Default footer to be displayed on invoices for this customer.
          */
         footer?: string;
+
+        /**
+         * Default options for invoice PDF rendering for this customer.
+         */
+        rendering_options?: InvoiceSettings.RenderingOptions;
       }
 
       namespace InvoiceSettings {
@@ -432,6 +437,19 @@ declare module 'stripe' {
            */
           value: string;
         }
+
+        interface RenderingOptions {
+          /**
+           * How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
+           */
+          amount_tax_display?: Stripe.Emptyable<
+            RenderingOptions.AmountTaxDisplay
+          >;
+        }
+
+        namespace RenderingOptions {
+          type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax';
+        }
       }
 
       interface Shipping {
@@ -685,6 +703,11 @@ declare module 'stripe' {
          * Default footer to be displayed on invoices for this customer.
          */
         footer?: string;
+
+        /**
+         * Default options for invoice PDF rendering for this customer.
+         */
+        rendering_options?: InvoiceSettings.RenderingOptions;
       }
 
       namespace InvoiceSettings {
@@ -699,6 +722,19 @@ declare module 'stripe' {
            */
           value: string;
         }
+
+        interface RenderingOptions {
+          /**
+           * How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.
+           */
+          amount_tax_display?: Stripe.Emptyable<
+            RenderingOptions.AmountTaxDisplay
+          >;
+        }
+
+        namespace RenderingOptions {
+          type AmountTaxDisplay = 'exclude_tax' | 'include_inclusive_tax';
+        }
       }
 
       interface Shipping {
@@ -779,17 +815,39 @@ declare module 'stripe' {
 
     namespace CustomerCreateFundingInstructionsParams {
       interface BankTransfer {
+        /**
+         * Configuration for eu_bank_transfer funding type.
+         */
+        eu_bank_transfer?: BankTransfer.EuBankTransfer;
+
         /**
          * List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
          *
-         * Permitted values include: `zengin`.
+         * Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
          */
-        requested_address_types?: Array<'zengin'>;
+        requested_address_types?: Array<BankTransfer.RequestedAddressType>;
 
         /**
          * The type of the `bank_transfer`
          */
-        type: 'jp_bank_transfer';
+        type: BankTransfer.Type;
+      }
+
+      namespace BankTransfer {
+        interface EuBankTransfer {
+          /**
+           * The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
+           */
+          country: string;
+        }
+
+        type RequestedAddressType = 'iban' | 'sort_code' | 'spei' | 'zengin';
+
+        type Type =
+          | 'eu_bank_transfer'
+          | 'gb_bank_transfer'
+          | 'jp_bank_transfer'
+          | 'mx_bank_transfer';
       }
     }
 
@@ -958,7 +1016,7 @@ declare module 'stripe' {
       ): ApiListPromise<Stripe.PaymentMethod>;
 
       /**
-       * Retrieves a PaymentMethod object.
+       * Retrieves a PaymentMethod object for a given Customer.
        */
       retrievePaymentMethod(
         customerId: string,

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

@@ -49,6 +49,21 @@ declare module 'stripe' {
 
       namespace BankTransfer {
         interface FinancialAddress {
+          /**
+           * Iban Records contain E.U. bank account details per the SEPA format.
+           */
+          iban?: FinancialAddress.Iban;
+
+          /**
+           * Sort Code Records contain U.K. bank account details per the sort code format.
+           */
+          sort_code?: FinancialAddress.SortCode;
+
+          /**
+           * SPEI Records contain Mexico bank account details per the SPEI format.
+           */
+          spei?: FinancialAddress.Spei;
+
           /**
            * The payment networks supported by this FinancialAddress
            */
@@ -66,9 +81,65 @@ declare module 'stripe' {
         }
 
         namespace FinancialAddress {
-          type SupportedNetwork = 'sepa' | 'zengin';
+          interface Iban {
+            /**
+             * The name of the person or business that owns the bank account
+             */
+            account_holder_name: string;
+
+            /**
+             * The BIC/SWIFT code of the account.
+             */
+            bic: string;
+
+            /**
+             * Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
+             */
+            country: string;
+
+            /**
+             * The IBAN of the account.
+             */
+            iban: string;
+          }
+
+          interface SortCode {
+            /**
+             * The name of the person or business that owns the bank account
+             */
+            account_holder_name: string;
+
+            /**
+             * The account number
+             */
+            account_number: string;
+
+            /**
+             * The six-digit sort code
+             */
+            sort_code: string;
+          }
+
+          interface Spei {
+            /**
+             * The three-digit bank code
+             */
+            bank_code: string;
+
+            /**
+             * The short banking institution name
+             */
+            bank_name: string;
+
+            /**
+             * The CLABE number
+             */
+            clabe: string;
+          }
+
+          type SupportedNetwork = 'bacs' | 'fps' | 'sepa' | 'spei' | 'zengin';
 
-          type Type = 'iban' | 'zengin';
+          type Type = 'iban' | 'sort_code' | 'spei' | 'zengin';
 
           interface Zengin {
             /**

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

@@ -696,11 +696,26 @@ declare module 'stripe' {
 
           namespace CustomerBalance {
             interface BankTransfer {
+              eu_bank_transfer?: BankTransfer.EuBankTransfer;
+
               /**
-               * The bank transfer type that can be used for funding. Permitted values include: `jp_bank_transfer`.
+               * The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.
                */
               type: string | null;
             }
+
+            namespace BankTransfer {
+              interface EuBankTransfer {
+                /**
+                 * The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
+                 */
+                country: EuBankTransfer.Country;
+              }
+
+              namespace EuBankTransfer {
+                type Country = 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
+              }
+            }
           }
 
           interface Konbini {}
@@ -1139,10 +1154,24 @@ declare module 'stripe' {
           namespace CustomerBalance {
             interface BankTransfer {
               /**
-               * The bank transfer type that can be used for funding. Permitted values include: `jp_bank_transfer`.
+               * Configuration for eu_bank_transfer funding type.
+               */
+              eu_bank_transfer?: BankTransfer.EuBankTransfer;
+
+              /**
+               * The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.
                */
               type?: string;
             }
+
+            namespace BankTransfer {
+              interface EuBankTransfer {
+                /**
+                 * The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
+                 */
+                country: string;
+              }
+            }
           }
 
           interface Konbini {}
@@ -1480,10 +1509,24 @@ declare module 'stripe' {
           namespace CustomerBalance {
             interface BankTransfer {
               /**
-               * The bank transfer type that can be used for funding. Permitted values include: `jp_bank_transfer`.
+               * Configuration for eu_bank_transfer funding type.
+               */
+              eu_bank_transfer?: BankTransfer.EuBankTransfer;
+
+              /**
+               * The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.
                */
               type?: string;
             }
+
+            namespace BankTransfer {
+              interface EuBankTransfer {
+                /**
+                 * The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
+                 */
+                country: string;
+              }
+            }
           }
 
           interface Konbini {}

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

@@ -405,17 +405,47 @@ declare module 'stripe' {
 
             namespace CustomerBalance {
               interface BankTransfer {
+                eu_bank_transfer?: BankTransfer.EuBankTransfer;
+
                 /**
                  * List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
                  *
-                 * Permitted values include: `zengin`.
+                 * Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
                  */
-                requested_address_types?: Array<'zengin'>;
+                requested_address_types?: Array<
+                  BankTransfer.RequestedAddressType
+                >;
 
                 /**
-                 * The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `jp_bank_transfer`.
+                 * The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.
                  */
-                type: 'jp_bank_transfer' | null;
+                type: BankTransfer.Type | null;
+              }
+
+              namespace BankTransfer {
+                interface EuBankTransfer {
+                  /**
+                   * The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
+                   */
+                  country: EuBankTransfer.Country;
+                }
+
+                namespace EuBankTransfer {
+                  type Country = 'DE' | 'ES' | 'FR' | 'IE' | 'NL';
+                }
+
+                type RequestedAddressType =
+                  | 'iban'
+                  | 'sepa'
+                  | 'sort_code'
+                  | 'spei'
+                  | 'zengin';
+
+                type Type =
+                  | 'eu_bank_transfer'
+                  | 'gb_bank_transfer'
+                  | 'jp_bank_transfer'
+                  | 'mx_bank_transfer';
               }
             }
 
@@ -1363,17 +1393,43 @@ declare module 'stripe' {
 
             namespace CustomerBalance {
               interface BankTransfer {
+                eu_bank_transfer?: BankTransfer.EuBankTransfer;
+
                 /**
                  * List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
                  *
-                 * Permitted values include: `zengin`.
+                 * Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
                  */
-                requested_address_types?: Array<'zengin'>;
+                requested_address_types?: Array<
+                  BankTransfer.RequestedAddressType
+                >;
 
                 /**
-                 * The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `jp_bank_transfer`.
+                 * The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.
                  */
-                type: 'jp_bank_transfer';
+                type: BankTransfer.Type;
+              }
+
+              namespace BankTransfer {
+                interface EuBankTransfer {
+                  /**
+                   * The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
+                   */
+                  country: string;
+                }
+
+                type RequestedAddressType =
+                  | 'iban'
+                  | 'sepa'
+                  | 'sort_code'
+                  | 'spei'
+                  | 'zengin';
+
+                type Type =
+                  | 'eu_bank_transfer'
+                  | 'gb_bank_transfer'
+                  | 'jp_bank_transfer'
+                  | 'mx_bank_transfer';
               }
             }
 
@@ -2385,17 +2441,43 @@ declare module 'stripe' {
 
             namespace CustomerBalance {
               interface BankTransfer {
+                eu_bank_transfer?: BankTransfer.EuBankTransfer;
+
                 /**
                  * List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.
                  *
-                 * Permitted values include: `zengin`.
+                 * Permitted values include: `sort_code`, `zengin`, `iban`, or `spei`.
                  */
-                requested_address_types?: Array<'zengin'>;
+                requested_address_types?: Array<
+                  BankTransfer.RequestedAddressType
+                >;
 
                 /**
-                 * The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `jp_bank_transfer`.
+                 * The list of bank transfer types that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, or `mx_bank_transfer`.
                  */
-                type: 'jp_bank_transfer';
+                type: BankTransfer.Type;
+              }
+
+              namespace BankTransfer {
+                interface EuBankTransfer {
+                  /**
+                   * The desired country code of the bank account information. Permitted values include: `DE`, `ES`, `FR`, `IE`, or `NL`.
+                   */
+                  country: string;
+                }
+
+                type RequestedAddressType =
+                  | 'iban'
+                  | 'sepa'
+                  | 'sort_code'
+                  | 'spei'
+                  | 'zengin';
+
+                type Type =
+                  | 'eu_bank_transfer'
+                  | 'gb_bank_transfer'
+                  | 'jp_bank_transfer'
+                  | 'mx_bank_transfer';
               }
             }