Update generated code (#1879)

* Update generated code for v469 * Update generated code for v470 * Update generated code for v471 * Update generated code for v474 * Update generated code for v475 * Update generated code for v476 * Update generated code for v477 * Update generated code for v478 * Update generated code for v481 * Update generated code for v482 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com> Co-authored-by: anniel-stripe <[email protected]>
stripe · Aug 24, 2023 · 247d651 · 247d651
1 parent 2452692
commit 247d651
Show file tree

Hide file tree

Showing 23 changed files with 206 additions and 21 deletions.
diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION
@@ -1 +1 @@
-v468
+v482
diff --git a/types/BillingPortal/Sessions.d.ts b/types/BillingPortal/Sessions.d.ts
@@ -138,12 +138,40 @@ declare module 'stripe' {
           }
 
           interface SubscriptionCancel {
+            /**
+             * Specify a retention strategy to be used in the cancellation flow.
+             */
+            retention: SubscriptionCancel.Retention | null;
+
             /**
              * The ID of the subscription to be canceled.
              */
             subscription: string;
           }
 
+          namespace SubscriptionCancel {
+            interface Retention {
+              /**
+               * Configuration when `retention.type=coupon_offer`.
+               */
+              coupon_offer: Retention.CouponOffer | null;
+
+              /**
+               * Type of retention strategy that will be used.
+               */
+              type: 'coupon_offer';
+            }
+
+            namespace Retention {
+              interface CouponOffer {
+                /**
+                 * The ID of the coupon to be offered.
+                 */
+                coupon: string;
+              }
+            }
+          }
+
           interface SubscriptionUpdate {
             /**
              * The ID of the subscription to be updated.

diff --git a/types/BillingPortal/SessionsResource.d.ts b/types/BillingPortal/SessionsResource.d.ts
@@ -105,12 +105,40 @@ declare module 'stripe' {
           }
 
           interface SubscriptionCancel {
+            /**
+             * Specify a retention strategy to be used in the cancellation flow.
+             */
+            retention?: SubscriptionCancel.Retention;
+
             /**
              * The ID of the subscription to be canceled.
              */
             subscription: string;
           }
 
+          namespace SubscriptionCancel {
+            interface Retention {
+              /**
+               * Configuration when `retention.type=coupon_offer`.
+               */
+              coupon_offer: Retention.CouponOffer;
+
+              /**
+               * Type of retention strategy to use with the customer.
+               */
+              type: 'coupon_offer';
+            }
+
+            namespace Retention {
+              interface CouponOffer {
+                /**
+                 * The ID of the coupon to be offered.
+                 */
+                coupon: string;
+              }
+            }
+          }
+
           interface SubscriptionUpdate {
             /**
              * The ID of the subscription to be updated.

diff --git a/types/Cards.d.ts b/types/Cards.d.ts
@@ -125,7 +125,7 @@ declare module 'stripe' {
       /**
        * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
        *
-       * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
+       * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
        */
       fingerprint?: string | null;
 

diff --git a/types/Charges.d.ts b/types/Charges.d.ts
@@ -709,7 +709,7 @@ declare module 'stripe' {
           /**
            * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
            *
-           * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
+           * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
            */
           fingerprint?: string | null;
 
@@ -1011,7 +1011,7 @@ declare module 'stripe' {
           /**
            * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
            *
-           * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
+           * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
            */
           fingerprint: string | null;
 
@@ -1369,7 +1369,7 @@ declare module 'stripe' {
           /**
            * Uniquely identifies this particular card number. You can use this attribute to check whether two customers who've signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.
            *
-           * *Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*
+           * *As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*
            */
           fingerprint: string | null;
 

diff --git a/types/Checkout/Sessions.d.ts b/types/Checkout/Sessions.d.ts
@@ -1275,6 +1275,11 @@ declare module 'stripe' {
                */
               permissions?: Array<FinancialConnections.Permission>;
 
+              /**
+               * Data features requested to be retrieved upon account creation.
+               */
+              prefetch: Array<'balances'> | null;
+
               /**
                * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
                */

diff --git a/types/Checkout/SessionsResource.d.ts b/types/Checkout/SessionsResource.d.ts
@@ -204,7 +204,7 @@ declare module 'stripe' {
         shipping_address_collection?: SessionCreateParams.ShippingAddressCollection;
 
         /**
-         * The shipping rate options to apply to this Session.
+         * The shipping rate options to apply to this Session. Up to a maximum of 5.
          */
         shipping_options?: Array<SessionCreateParams.ShippingOption>;
 
@@ -783,7 +783,7 @@ declare module 'stripe' {
           transfer_data?: PaymentIntentData.TransferData;
 
           /**
-           * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
+           * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
            */
           transfer_group?: string;
         }
@@ -1524,6 +1524,11 @@ declare module 'stripe' {
                * The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
                */
               permissions?: Array<FinancialConnections.Permission>;
+
+              /**
+               * List of data features that you would like to retrieve upon account creation.
+               */
+              prefetch?: Array<'balances'>;
             }
 
             namespace FinancialConnections {

diff --git a/types/CustomerCashBalanceTransactions.d.ts b/types/CustomerCashBalanceTransactions.d.ts
@@ -67,6 +67,11 @@ declare module 'stripe' {
 
     namespace CustomerCashBalanceTransaction {
       interface AdjustedForOverdraft {
+        /**
+         * The [Balance Transaction](docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.
+         */
+        balance_transaction: string | Stripe.BalanceTransaction;
+
         /**
          * The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds.
          */

diff --git a/types/Disputes.d.ts b/types/Disputes.d.ts
@@ -76,6 +76,8 @@ declare module 'stripe' {
        */
       payment_intent: string | Stripe.PaymentIntent | null;
 
+      payment_method_details?: Dispute.PaymentMethodDetails;
+
       /**
        * Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories).
        */
@@ -247,6 +249,32 @@ declare module 'stripe' {
         submission_count: number;
       }
 
+      interface PaymentMethodDetails {
+        /**
+         * Card specific dispute details.
+         */
+        card: PaymentMethodDetails.Card | null;
+
+        /**
+         * Payment method type.
+         */
+        type: 'card';
+      }
+
+      namespace PaymentMethodDetails {
+        interface Card {
+          /**
+           * Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.
+           */
+          brand: string;
+
+          /**
+           * The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.
+           */
+          network_reason_code: string | null;
+        }
+      }
+
       type Status =
         | 'lost'
         | 'needs_response'

diff --git a/types/FinancialConnections/Sessions.d.ts b/types/FinancialConnections/Sessions.d.ts
@@ -44,6 +44,11 @@ declare module 'stripe' {
          */
         permissions: Array<Session.Permission>;
 
+        /**
+         * Data features requested to be retrieved upon account creation.
+         */
+        prefetch: Array<Session.Prefetch> | null;
+
         /**
          * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
          */
@@ -84,6 +89,8 @@ declare module 'stripe' {
           | 'ownership'
           | 'payment_method'
           | 'transactions';
+
+        type Prefetch = 'balances' | 'ownership';
       }
     }
   }

diff --git a/types/FinancialConnections/SessionsResource.d.ts b/types/FinancialConnections/SessionsResource.d.ts
@@ -26,6 +26,11 @@ declare module 'stripe' {
          */
         filters?: SessionCreateParams.Filters;
 
+        /**
+         * List of data features that you would like to retrieve upon account creation.
+         */
+        prefetch?: Array<SessionCreateParams.Prefetch>;
+
         /**
          * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
          */
@@ -66,6 +71,8 @@ declare module 'stripe' {
           | 'ownership'
           | 'payment_method'
           | 'transactions';
+
+        type Prefetch = 'balances' | 'ownership';
       }
 
       interface SessionRetrieveParams {

diff --git a/types/Invoices.d.ts b/types/Invoices.d.ts
@@ -1025,6 +1025,11 @@ declare module 'stripe' {
                * The list of permissions to request. The `payment_method` permission must be included.
                */
               permissions?: Array<FinancialConnections.Permission>;
+
+              /**
+               * Data features requested to be retrieved upon account creation.
+               */
+              prefetch: Array<'balances'> | null;
             }
 
             namespace FinancialConnections {

diff --git a/types/InvoicesResource.d.ts b/types/InvoicesResource.d.ts
@@ -398,6 +398,11 @@ declare module 'stripe' {
                * The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
                */
               permissions?: Array<FinancialConnections.Permission>;
+
+              /**
+               * List of data features that you would like to retrieve upon account creation.
+               */
+              prefetch?: Array<'balances'>;
             }
 
             namespace FinancialConnections {
@@ -991,6 +996,11 @@ declare module 'stripe' {
                * The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
                */
               permissions?: Array<FinancialConnections.Permission>;
+
+              /**
+               * List of data features that you would like to retrieve upon account creation.
+               */
+              prefetch?: Array<'balances'>;
             }
 
             namespace FinancialConnections {

diff --git a/types/PaymentIntents.d.ts b/types/PaymentIntents.d.ts
@@ -218,7 +218,7 @@ declare module 'stripe' {
       transfer_data: PaymentIntent.TransferData | null;
 
       /**
-       * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
+       * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
        */
       transfer_group: string | null;
     }
@@ -1963,6 +1963,11 @@ declare module 'stripe' {
              */
             permissions?: Array<FinancialConnections.Permission>;
 
+            /**
+             * Data features requested to be retrieved upon account creation.
+             */
+            prefetch: Array<'balances'> | null;
+
             /**
              * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
              */

diff --git a/types/PaymentIntentsResource.d.ts b/types/PaymentIntentsResource.d.ts
@@ -67,7 +67,7 @@ declare module 'stripe' {
       /**
        * This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).
        */
-      mandate_data?: PaymentIntentCreateParams.MandateData;
+      mandate_data?: Stripe.Emptyable<PaymentIntentCreateParams.MandateData>;
 
       /**
        * 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`.
@@ -154,7 +154,7 @@ declare module 'stripe' {
       transfer_data?: PaymentIntentCreateParams.TransferData;
 
       /**
-       * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.
+       * A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details.
        */
       transfer_group?: string;
 
@@ -1903,6 +1903,11 @@ declare module 'stripe' {
              */
             permissions?: Array<FinancialConnections.Permission>;
 
+            /**
+             * List of data features that you would like to retrieve upon account creation.
+             */
+            prefetch?: Array<'balances'>;
+
             /**
              * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
              */
@@ -3825,6 +3830,11 @@ declare module 'stripe' {
              */
             permissions?: Array<FinancialConnections.Permission>;
 
+            /**
+             * List of data features that you would like to retrieve upon account creation.
+             */
+            prefetch?: Array<'balances'>;
+
             /**
              * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
              */
@@ -4066,9 +4076,10 @@ declare module 'stripe' {
       /**
        * This hash contains details about the Mandate to create
        */
-      mandate_data?:
+      mandate_data?: Stripe.Emptyable<
         | PaymentIntentConfirmParams.MandateData1
-        | PaymentIntentConfirmParams.MandateData2;
+        | PaymentIntentConfirmParams.MandateData2
+      >;
 
       /**
        * Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards).
@@ -5887,6 +5898,11 @@ declare module 'stripe' {
              */
             permissions?: Array<FinancialConnections.Permission>;
 
+            /**
+             * List of data features that you would like to retrieve upon account creation.
+             */
+            prefetch?: Array<'balances'>;
+
             /**
              * For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
              */