API Updates for beta branch

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 11.5.0 - 2022-12-22
+* [#1642](https://github.com/stripe/stripe-node/pull/1642) API Updates
+  * Add support for new value `merchant_default` on enums `CashBalanceUpdateParams.settings.reconciliation_mode`, `CustomerCreateParams.cash_balance.settings.reconciliation_mode`, and `CustomerUpdateParams.cash_balance.settings.reconciliation_mode`
+  * Add support for `using_merchant_default` on `CashBalance.settings`
+  * Change `CheckoutSessionCreateParams.cancel_url` to be optional
+  * Change type of `Checkout.Session.cancel_url` from `string` to `string | null`
+
 ## 11.5.0-beta.1 - 2022-12-15
 * [#1640](https://github.com/stripe/stripe-node/pull/1640) API Updates for beta branch
   * Updated stable APIs to the latest version

OPENAPI_VERSION

@@ -1 +1 @@
-v215
+v216

src/resources.js

@@ -49,10 +49,8 @@ module.exports = {
   SubscriptionItems: require('./resources/SubscriptionItems'),
   Subscriptions: require('./resources/Subscriptions'),
   SubscriptionSchedules: require('./resources/SubscriptionSchedules'),
-  TaxCalculations: require('./resources/TaxCalculations'),
   TaxCodes: require('./resources/TaxCodes'),
   TaxRates: require('./resources/TaxRates'),
-  TaxTransactions: require('./resources/TaxTransactions'),
   Tokens: require('./resources/Tokens'),
   Topups: require('./resources/Topups'),
   Transfers: require('./resources/Transfers'),
@@ -103,6 +101,10 @@ module.exports = {
   Sigma: resourceNamespace('sigma', {
     ScheduledQueryRuns: require('./resources/Sigma/ScheduledQueryRuns'),
   }),
+  Tax: resourceNamespace('tax', {
+    Calculations: require('./resources/Tax/Calculations'),
+    Transactions: require('./resources/Tax/Transactions'),
+  }),
   Terminal: resourceNamespace('terminal', {
     Configurations: require('./resources/Terminal/Configurations'),
     ConnectionTokens: require('./resources/Terminal/ConnectionTokens'),

src/resources/TaxCalculations.js → src/resources/Tax/Calculations.js

@@ -2,7 +2,7 @@
 
 'use strict';
 
-const StripeResource = require('../StripeResource');
+const StripeResource = require('../../StripeResource');
 const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({

src/resources/TaxTransactions.js → src/resources/Tax/Transactions.js

@@ -2,7 +2,7 @@
 
 'use strict';
 
-const StripeResource = require('../StripeResource');
+const StripeResource = require('../../StripeResource');
 const stripeMethod = StripeResource.method;
 
 module.exports = StripeResource.extend({

types/CashBalances.d.ts

@@ -37,6 +37,11 @@ declare module 'stripe' {
          * The configuration for how funds that land in the customer cash balance are reconciled.
          */
         reconciliation_mode: Settings.ReconciliationMode;
+
+        /**
+         * A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance
+         */
+        using_merchant_default: boolean;
       }
 
       namespace Settings {

types/Checkout/Sessions.d.ts

@@ -59,9 +59,9 @@ declare module 'stripe' {
         billing_address_collection: Session.BillingAddressCollection | null;
 
         /**
-         * The URL the customer will be directed to if they decide to cancel payment and return to your website.
+         * If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
          */
-        cancel_url: string;
+        cancel_url: string | null;
 
         /**
          * A unique string to reference the Checkout Session. This can be a

types/Checkout/SessionsResource.d.ts

@@ -4,11 +4,6 @@ declare module 'stripe' {
   namespace Stripe {
     namespace Checkout {
       interface SessionCreateParams {
-        /**
-         * The URL the customer will be directed to if they decide to cancel payment and return to your website.
-         */
-        cancel_url: string;
-
         /**
          * The URL to which Stripe should send customers when payment or setup
          * is complete.
@@ -37,6 +32,11 @@ declare module 'stripe' {
          */
         billing_address_collection?: SessionCreateParams.BillingAddressCollection;
 
+        /**
+         * If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.
+         */
+        cancel_url?: string;
+
         /**
          * A unique string to reference the Checkout Session. This can be a
          * customer ID, a cart ID, or similar, and can be used to reconcile the

types/CustomersResource.d.ts

@@ -119,13 +119,13 @@ declare module 'stripe' {
       namespace CashBalance {
         interface Settings {
           /**
-           * Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
+           * Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
            */
           reconciliation_mode?: Settings.ReconciliationMode;
         }
 
         namespace Settings {
-          type ReconciliationMode = 'automatic' | 'manual';
+          type ReconciliationMode = 'automatic' | 'manual' | 'merchant_default';
         }
       }
 
@@ -393,13 +393,13 @@ declare module 'stripe' {
       namespace CashBalance {
         interface Settings {
           /**
-           * Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
+           * Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
            */
           reconciliation_mode?: Settings.ReconciliationMode;
         }
 
         namespace Settings {
-          type ReconciliationMode = 'automatic' | 'manual';
+          type ReconciliationMode = 'automatic' | 'manual' | 'merchant_default';
         }
       }
 
@@ -661,13 +661,13 @@ declare module 'stripe' {
     namespace CashBalanceUpdateParams {
       interface Settings {
         /**
-         * Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic` or `manual`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
+         * Controls how funds transferred by the customer are applied to payment intents and invoices. Valid options are `automatic`, `manual`, or `merchant_default`. For more information about these reconciliation modes, see [Reconciliation](https://stripe.com/docs/payments/customer-balance/reconciliation).
          */
         reconciliation_mode?: Settings.ReconciliationMode;
       }
 
       namespace Settings {
-        type ReconciliationMode = 'automatic' | 'manual';
+        type ReconciliationMode = 'automatic' | 'manual' | 'merchant_default';
       }
     }
 

types/OrdersResource.d.ts

@@ -622,6 +622,9 @@ declare module 'stripe' {
 
             namespace CustomerBalance {
               interface BankTransfer {
+                /**
+                 * Configuration for the eu_bank_transfer funding type.
+                 */
                 eu_bank_transfer?: BankTransfer.EuBankTransfer;
 
                 /**
@@ -1845,6 +1848,9 @@ declare module 'stripe' {
 
             namespace CustomerBalance {
               interface BankTransfer {
+                /**
+                 * Configuration for the eu_bank_transfer funding type.
+                 */
                 eu_bank_transfer?: BankTransfer.EuBankTransfer;
 
                 /**

types/PaymentIntentsResource.d.ts

@@ -1389,6 +1389,9 @@ declare module 'stripe' {
 
         namespace CustomerBalance {
           interface BankTransfer {
+            /**
+             * Configuration for the eu_bank_transfer funding type.
+             */
             eu_bank_transfer?: BankTransfer.EuBankTransfer;
 
             /**
@@ -3282,6 +3285,9 @@ declare module 'stripe' {
 
         namespace CustomerBalance {
           interface BankTransfer {
+            /**
+             * Configuration for the eu_bank_transfer funding type.
+             */
             eu_bank_transfer?: BankTransfer.EuBankTransfer;
 
             /**
@@ -5273,6 +5279,9 @@ declare module 'stripe' {
 
         namespace CustomerBalance {
           interface BankTransfer {
+            /**
+             * Configuration for the eu_bank_transfer funding type.
+             */
             eu_bank_transfer?: BankTransfer.EuBankTransfer;
 
             /**

types/Quotes.d.ts

@@ -552,7 +552,7 @@ declare module 'stripe' {
 
       interface SubscriptionData {
         /**
-         * TODO
+         * Describes what period to bill for upon accepting the quote.
          */
         bill_on_acceptance?: SubscriptionData.BillOnAcceptance | null;
 
@@ -577,7 +577,7 @@ declare module 'stripe' {
         effective_date: number | null;
 
         /**
-         * Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`.
+         * Behavior of the subscription schedule and underlying subscription when it ends.
          */
         end_behavior?: SubscriptionData.EndBehavior | null;
 
@@ -756,7 +756,7 @@ declare module 'stripe' {
         description: string | null;
 
         /**
-         * Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`.
+         * Behavior of the subscription schedule and underlying subscription when it ends.
          */
         end_behavior: SubscriptionDataOverride.EndBehavior | null;
 

types/QuotesResource.d.ts

@@ -1175,7 +1175,7 @@ declare module 'stripe' {
         effective_date?: Stripe.Emptyable<'current_period_end' | number>;
 
         /**
-         * Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
+         * Behavior of the subscription schedule and underlying subscription when it ends.
          */
         end_behavior?: SubscriptionData.EndBehavior;
 
@@ -1359,7 +1359,7 @@ declare module 'stripe' {
         description?: string;
 
         /**
-         * Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
+         * Behavior of the subscription schedule and underlying subscription when it ends.
          */
         end_behavior?: SubscriptionDataOverride.EndBehavior;
 
@@ -2696,7 +2696,7 @@ declare module 'stripe' {
         effective_date?: Stripe.Emptyable<'current_period_end' | number>;
 
         /**
-         * Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
+         * Behavior of the subscription schedule and underlying subscription when it ends.
          */
         end_behavior?: SubscriptionData.EndBehavior;
 
@@ -2870,7 +2870,7 @@ declare module 'stripe' {
         description?: string;
 
         /**
-         * Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
+         * Behavior of the subscription schedule and underlying subscription when it ends.
          */
         end_behavior?: SubscriptionDataOverride.EndBehavior;
 

types/SubscriptionSchedules.d.ts

@@ -65,7 +65,7 @@ declare module 'stripe' {
       default_settings: SubscriptionSchedule.DefaultSettings;
 
       /**
-       * Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` and `cancel`.
+       * Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
        */
       end_behavior: SubscriptionSchedule.EndBehavior;
 

types/SubscriptionSchedulesResource.d.ts

@@ -19,7 +19,7 @@ declare module 'stripe' {
       default_settings?: SubscriptionScheduleCreateParams.DefaultSettings;
 
       /**
-       * Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
+       * Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
        */
       end_behavior?: SubscriptionScheduleCreateParams.EndBehavior;
 
@@ -729,7 +729,7 @@ declare module 'stripe' {
       default_settings?: SubscriptionScheduleUpdateParams.DefaultSettings;
 
       /**
-       * Configures how the subscription schedule behaves when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
+       * Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running.`cancel` will end the subscription schedule and cancel the underlying subscription.
        */
       end_behavior?: SubscriptionScheduleUpdateParams.EndBehavior;
 
@@ -1577,6 +1577,8 @@ declare module 'stripe' {
             | 'duration'
             | 'schedule_end'
             | 'timestamp'
+            | 'trial_end'
+            | 'trial_start'
             | 'upcoming_invoice';
         }
 
@@ -1623,6 +1625,8 @@ declare module 'stripe' {
             | 'now'
             | 'schedule_end'
             | 'timestamp'
+            | 'trial_end'
+            | 'trial_start'
             | 'upcoming_invoice';
         }
 
@@ -2014,7 +2018,7 @@ declare module 'stripe' {
 
       interface ScheduleSettings {
         /**
-         * Configures how the subscription schedule behaves when it ends.
+         * Behavior of the subscription schedule and underlying subscription when it ends.
          */
         end_behavior?: ScheduleSettings.EndBehavior;
       }