Update generated code (#1787)

* Update generated code for v339 * Update generated code for v340 * Update generated code for v342 * Update generated code for v343 * Update generated code for v344 * Update generated code for v345 * Update generated code for v349 * Update generated code for v350 --------- Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
stripe · May 19, 2023 · c464ba7 · c464ba7
1 parent 286e8a2
commit c464ba7
Show file tree

Hide file tree

Showing 60 changed files with 253 additions and 81 deletions.
diff --git a/OPENAPI_VERSION b/OPENAPI_VERSION
@@ -1 +1 @@
-v338
+v350
diff --git a/types/AccountLinks.d.ts b/types/AccountLinks.d.ts
@@ -6,7 +6,7 @@ declare module 'stripe' {
      * Account Links are the means by which a Connect platform grants a connected account permission to access
      * Stripe-hosted applications, such as Connect Onboarding.
      *
-     * Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding).
+     * Related guide: [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding)
      */
     interface AccountLink {
       /**

diff --git a/types/Accounts.d.ts b/types/Accounts.d.ts
@@ -84,7 +84,7 @@ declare module 'stripe' {
        * A platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.
        * See the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform pre-filling and account onboarding steps.
        *
-       * Related guide: [Handling Identity Verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information).
+       * Related guide: [Handling identity verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information)
        */
       individual?: Stripe.Person;
 

diff --git a/types/Apps/Secrets.d.ts b/types/Apps/Secrets.d.ts
@@ -12,7 +12,7 @@ declare module 'stripe' {
        *
        * A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
        *
-       * Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects).
+       * Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)
        */
       interface Secret {
         /**

diff --git a/types/Balance.d.ts b/types/Balance.d.ts
@@ -13,7 +13,7 @@ declare module 'stripe' {
      * The available and pending amounts for each currency are broken down further by
      * payment source types.
      *
-     * Related guide: [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances).
+     * Related guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)
      */
     interface Balance {
       /**

diff --git a/types/BalanceTransactions.d.ts b/types/BalanceTransactions.d.ts
@@ -6,7 +6,7 @@ declare module 'stripe' {
      * Balance transactions represent funds moving through your Stripe account.
      * They're created for every type of transaction that comes into or flows out of your Stripe account balance.
      *
-     * Related guide: [Balance Transaction Types](https://stripe.com/docs/reports/balance-transaction-types).
+     * Related guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)
      */
     interface BalanceTransaction {
       /**

diff --git a/types/BankAccounts.d.ts b/types/BankAccounts.d.ts
@@ -9,7 +9,7 @@ declare module 'stripe' {
      * destinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).
      * They can be bank accounts or debit cards as well, and are documented in the links above.
      *
-     * Related guide: [Bank Debits and Transfers](https://stripe.com/docs/payments/bank-debits-transfers).
+     * Related guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)
      */
     interface BankAccount {
       /**

diff --git a/types/BillingPortal/Sessions.d.ts b/types/BillingPortal/Sessions.d.ts
@@ -85,6 +85,16 @@ declare module 'stripe' {
            */
           subscription_cancel: Flow.SubscriptionCancel | null;
 
+          /**
+           * Configuration when `flow.type=subscription_update`.
+           */
+          subscription_update: Flow.SubscriptionUpdate | null;
+
+          /**
+           * Configuration when `flow.type=subscription_update_confirm`.
+           */
+          subscription_update_confirm: Flow.SubscriptionUpdateConfirm | null;
+
           /**
            * Type of flow that the customer will go through.
            */
@@ -134,7 +144,66 @@ declare module 'stripe' {
             subscription: string;
           }
 
-          type Type = 'payment_method_update' | 'subscription_cancel';
+          interface SubscriptionUpdate {
+            /**
+             * The ID of the subscription to be updated.
+             */
+            subscription: string;
+          }
+
+          interface SubscriptionUpdateConfirm {
+            /**
+             * The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
+             */
+            discounts: Array<SubscriptionUpdateConfirm.Discount> | null;
+
+            /**
+             * The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+             */
+            items: Array<SubscriptionUpdateConfirm.Item>;
+
+            /**
+             * The ID of the subscription to be updated.
+             */
+            subscription: string;
+          }
+
+          namespace SubscriptionUpdateConfirm {
+            interface Discount {
+              /**
+               * The ID of the coupon to apply to this subscription update.
+               */
+              coupon: string | null;
+
+              /**
+               * The ID of a promotion code to apply to this subscription update.
+               */
+              promotion_code: string | null;
+            }
+
+            interface Item {
+              /**
+               * The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+               */
+              id: string | null;
+
+              /**
+               * The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+               */
+              price: string | null;
+
+              /**
+               * [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+               */
+              quantity?: number;
+            }
+          }
+
+          type Type =
+            | 'payment_method_update'
+            | 'subscription_cancel'
+            | 'subscription_update'
+            | 'subscription_update_confirm';
         }
 
         type Locale =

diff --git a/types/BillingPortal/SessionsResource.d.ts b/types/BillingPortal/SessionsResource.d.ts
@@ -52,6 +52,16 @@ declare module 'stripe' {
            */
           subscription_cancel?: FlowData.SubscriptionCancel;
 
+          /**
+           * Configuration when `flow_data.type=subscription_update`.
+           */
+          subscription_update?: FlowData.SubscriptionUpdate;
+
+          /**
+           * Configuration when `flow_data.type=subscription_update_confirm`.
+           */
+          subscription_update_confirm?: FlowData.SubscriptionUpdateConfirm;
+
           /**
            * Type of flow that the customer will go through.
            */
@@ -101,7 +111,66 @@ declare module 'stripe' {
             subscription: string;
           }
 
-          type Type = 'payment_method_update' | 'subscription_cancel';
+          interface SubscriptionUpdate {
+            /**
+             * The ID of the subscription to be updated.
+             */
+            subscription: string;
+          }
+
+          interface SubscriptionUpdateConfirm {
+            /**
+             * The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified.
+             */
+            discounts?: Array<SubscriptionUpdateConfirm.Discount>;
+
+            /**
+             * The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable.
+             */
+            items: Array<SubscriptionUpdateConfirm.Item>;
+
+            /**
+             * The ID of the subscription to be updated.
+             */
+            subscription: string;
+          }
+
+          namespace SubscriptionUpdateConfirm {
+            interface Discount {
+              /**
+               * The ID of the coupon to apply to this subscription update.
+               */
+              coupon?: string;
+
+              /**
+               * The ID of a promotion code to apply to this subscription update.
+               */
+              promotion_code?: string;
+            }
+
+            interface Item {
+              /**
+               * The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated.
+               */
+              id: string;
+
+              /**
+               * The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).
+               */
+              price?: string;
+
+              /**
+               * [Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow.
+               */
+              quantity?: number;
+            }
+          }
+
+          type Type =
+            | 'payment_method_update'
+            | 'subscription_cancel'
+            | 'subscription_update'
+            | 'subscription_update_confirm';
         }
 
         type Locale =

diff --git a/types/Capabilities.d.ts b/types/Capabilities.d.ts
@@ -5,7 +5,7 @@ declare module 'stripe' {
     /**
      * This is an object representing a capability for a Stripe account.
      *
-     * Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities).
+     * Related guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)
      */
     interface Capability {
       /**

diff --git a/types/Cards.d.ts b/types/Cards.d.ts
@@ -7,7 +7,7 @@ declare module 'stripe' {
      * later. You can also store multiple debit cards on a recipient in order to
      * transfer to those cards later.
      *
-     * Related guide: [Card Payments with Sources](https://stripe.com/docs/sources/cards).
+     * Related guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)
      */
     interface Card {
       /**

diff --git a/types/Charges.d.ts b/types/Charges.d.ts
@@ -7,7 +7,7 @@ declare module 'stripe' {
      * retrieve and refund individual charges as well as list all charges. Charges
      * are identified by a unique, random ID.
      *
-     * Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges).
+     * Related guide: [Accept a payment with the Charges API](https://stripe.com/docs/payments/accept-a-payment-charges)
      */
     interface Charge {
       /**
@@ -900,6 +900,8 @@ declare module 'stripe' {
 
             google_pay?: Wallet.GooglePay;
 
+            link?: Wallet.Link;
+
             masterpass?: Wallet.Masterpass;
 
             samsung_pay?: Wallet.SamsungPay;
@@ -919,6 +921,8 @@ declare module 'stripe' {
 
             interface GooglePay {}
 
+            interface Link {}
+
             interface Masterpass {
               /**
                * Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated.
@@ -1140,7 +1144,17 @@ declare module 'stripe' {
           }
         }
 
-        interface Cashapp {}
+        interface Cashapp {
+          /**
+           * A unique and immutable identifier assigned by Cash App to every buyer.
+           */
+          buyer_id?: string | null;
+
+          /**
+           * A public identifier for buyers using Cash App.
+           */
+          cashtag?: string | null;
+        }
 
         interface CustomerBalance {}
 

diff --git a/types/Checkout/Sessions.d.ts b/types/Checkout/Sessions.d.ts
@@ -17,7 +17,7 @@ declare module 'stripe' {
        * You can create a Checkout Session on your server and redirect to its URL
        * to begin Checkout.
        *
-       * Related guide: [Checkout Quickstart](https://stripe.com/docs/checkout/quickstart).
+       * Related guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)
        */
       interface Session {
         /**
@@ -1552,7 +1552,7 @@ declare module 'stripe' {
             /**
              * Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
              *
-             * Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
+             * Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
              */
             rate: Stripe.TaxRate;
 
@@ -1680,7 +1680,7 @@ declare module 'stripe' {
                * 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).
+               * Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
                */
               discount: Stripe.Discount;
             }
@@ -1694,7 +1694,7 @@ declare module 'stripe' {
               /**
                * Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
                *
-               * Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
+               * Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
                */
               rate: Stripe.TaxRate;
 

diff --git a/types/CreditNotes.d.ts b/types/CreditNotes.d.ts
@@ -5,7 +5,7 @@ declare module 'stripe' {
     /**
      * Issue a credit note to adjust an invoice's amount after the invoice is finalized.
      *
-     * Related guide: [Credit Notes](https://stripe.com/docs/billing/invoices/credit-notes).
+     * Related guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)
      */
     interface CreditNote {
       /**
@@ -213,7 +213,7 @@ declare module 'stripe' {
           /**
            * Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.
            *
-           * Related guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).
+           * Related guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)
            */
           rate: Stripe.TaxRate;
 

diff --git a/types/CustomerBalanceTransactions.d.ts b/types/CustomerBalanceTransactions.d.ts
@@ -3,12 +3,12 @@
 declare module 'stripe' {
   namespace Stripe {
     /**
-     * Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) value,
+     * Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,
      * which denotes a debit or credit that's automatically applied to their next invoice upon finalization.
      * You may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),
      * or by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.
      *
-     * Related guide: [Customer Balance](https://stripe.com/docs/billing/customer/balance) to learn more.
+     * Related guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)
      */
     interface CustomerBalanceTransaction {
       /**

diff --git a/types/Customers.d.ts b/types/Customers.d.ts
@@ -5,7 +5,7 @@ declare module 'stripe' {
     /**
      * This object represents a customer of your business. It lets you create recurring charges and track payments that belong to the same customer.
      *
-     * Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment).
+     * Related guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)
      */
     interface Customer {
       /**

diff --git a/types/Discounts.d.ts b/types/Discounts.d.ts
@@ -6,7 +6,7 @@ declare module 'stripe' {
      * 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).
+     * Related guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)
      */
     interface Discount {
       /**

diff --git a/types/Disputes.d.ts b/types/Disputes.d.ts
@@ -9,7 +9,7 @@ declare module 'stripe' {
      * information about the dispute process in our [Disputes and
      * Fraud](https://stripe.com/docs/disputes) documentation.
      *
-     * Related guide: [Disputes and Fraud](https://stripe.com/docs/disputes).
+     * Related guide: [Disputes and fraud](https://stripe.com/docs/disputes)
      */
     interface Dispute {
       /**

diff --git a/types/FeeRefunds.d.ts b/types/FeeRefunds.d.ts
@@ -7,7 +7,7 @@ declare module 'stripe' {
      * has previously been created but not yet refunded. Funds will be refunded to
      * the Stripe account from which the fee was originally collected.
      *
-     * Related guide: [Refunding Application Fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee).
+     * Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)
      */
     interface FeeRefund {
       /**