stripe 18.2.0-beta.1 → 18.2.0

package/types/Payouts.d.ts

@@ -5,9 +5,9 @@ declare module 'stripe' {
     /**
      * A `Payout` object is created when you receive funds from Stripe, or when you
      * initiate a payout to either a bank account or debit card of a [connected
-     * Stripe account](https://stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
+     * Stripe account](https://docs.stripe.com/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,
      * and list all payouts. Payouts are made on [varying
-     * schedules](https://stripe.com/docs/connect/manage-payout-schedule), depending on your country and
+     * schedules](https://docs.stripe.com/docs/connect/manage-payout-schedule), depending on your country and
      * industry.
      *
      * Related guide: [Receiving payouts](https://stripe.com/docs/payouts)
@@ -112,11 +112,6 @@ declare module 'stripe' {
        */
       original_payout: string | Stripe.Payout | null;
 
-      /**
-       * ID of the v2 FinancialAccount the funds are sent to.
-       */
-      payout_method?: string | null;
-
       /**
        * If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout.
        */

package/types/PayoutsResource.d.ts

@@ -38,11 +38,6 @@ declare module 'stripe' {
        */
       method?: PayoutCreateParams.Method;
 
-      /**
-       * The ID of a v2 FinancialAccount to send funds to.
-       */
-      payout_method?: string;
-
       /**
        * The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.
        */
@@ -127,11 +122,11 @@ declare module 'stripe' {
 
     class PayoutsResource {
       /**
-       * To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://stripe.com/docs/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
+       * To send funds to your own bank account, create a new payout object. Your [Stripe balance](https://docs.stripe.com/api#balance) must cover the payout amount. If it doesn't, you receive an “Insufficient Funds” error.
        *
        * If your API key is in test mode, money won't actually be sent, though every other action occurs as if you're in live mode.
        *
-       * If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://stripe.com/docs/api#balance_object) details available and pending amounts by source type.
+       * If you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The [balance object](https://docs.stripe.com/api#balance_object) details available and pending amounts by source type.
        */
       create(
         params: PayoutCreateParams,

package/types/Persons.d.ts

@@ -25,9 +25,9 @@ declare module 'stripe' {
     /**
      * This is an object representing a person associated with a Stripe account.
      *
-     * A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
+     * A platform can only access a subset of data in a person for an account where [account.controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.
      *
-     * See the [Standard onboarding](https://stripe.com/connect/standard-accounts) or [Express onboarding](https://stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://stripe.com/connect/handling-api-verification#person-information).
+     * See the [Standard onboarding](https://docs.stripe.com/connect/standard-accounts) or [Express onboarding](https://docs.stripe.com/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](https://docs.stripe.com/connect/handling-api-verification#person-information).
      */
     interface Person {
       /**
@@ -72,27 +72,27 @@ declare module 'stripe' {
       dob?: Person.Dob;
 
       /**
-       * The person's email address. Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
+       * The person's email address. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
        */
       email?: string | null;
 
       /**
-       * The person's first name. Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
+       * The person's first name. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
        */
       first_name?: string | null;
 
       /**
-       * The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
+       * The Kana variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
        */
       first_name_kana?: string | null;
 
       /**
-       * The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
+       * The Kanji variation of the person's first name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
        */
       first_name_kanji?: string | null;
 
       /**
-       * A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
+       * A list of alternate names or aliases that the person is known by. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
        */
       full_name_aliases?: Array<string>;
 
@@ -117,17 +117,17 @@ declare module 'stripe' {
       id_number_secondary_provided?: boolean;
 
       /**
-       * The person's last name. Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
+       * The person's last name. Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
        */
       last_name?: string | null;
 
       /**
-       * The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
+       * The Kana variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
        */
       last_name_kana?: string | null;
 
       /**
-       * The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](https://stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
+       * The Kanji variation of the person's last name (Japan only). Also available for accounts where [controller.requirement_collection](https://docs.stripe.com/api/accounts/object#account_object-controller-requirement_collection) is `stripe`.
        */
       last_name_kanji?: string | null;
 

package/types/PlansResource.d.ts

@@ -248,7 +248,7 @@ declare module 'stripe' {
 
     class PlansResource {
       /**
-       * You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
+       * You can now model subscriptions more flexibly using the [Prices API](https://docs.stripe.com/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.
        */
       create(
         params: PlanCreateParams,

package/types/Prices.d.ts

@@ -93,11 +93,6 @@ declare module 'stripe' {
        */
       metadata: Stripe.Metadata;
 
-      /**
-       * Subscriptions using this price will be migrated to use the new referenced price.
-       */
-      migrate_to?: Price.MigrateTo | null;
-
       /**
        * A brief description of the price, hidden from customers.
        */
@@ -244,23 +239,6 @@ declare module 'stripe' {
         preset: number | null;
       }
 
-      interface MigrateTo {
-        /**
-         * The behavior controlling at what point in the subscription lifecycle to migrate the price
-         */
-        behavior: 'at_cycle_end';
-
-        /**
-         * The unix timestamp after at which subscriptions will start to migrate to the new price.
-         */
-        effective_after: number;
-
-        /**
-         * The id of the price being migrated to
-         */
-        price: string;
-      }
-
       interface Recurring {
         /**
          * The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`.

package/types/PricesResource.d.ts

@@ -361,11 +361,6 @@ declare module 'stripe' {
        */
       metadata?: Stripe.Emptyable<Stripe.MetadataParam>;
 
-      /**
-       * If specified, subscriptions using this price will be updated to use the new referenced price.
-       */
-      migrate_to?: Stripe.Emptyable<PriceUpdateParams.MigrateTo>;
-
       /**
        * A brief description of the price, hidden from customers.
        */
@@ -463,23 +458,6 @@ declare module 'stripe' {
         }
       }
 
-      interface MigrateTo {
-        /**
-         * The behavior controlling the point in the subscription lifecycle after which to migrate the price. Currently must be `at_cycle_end`.
-         */
-        behavior: 'at_cycle_end';
-
-        /**
-         * The time after which subscriptions should start using the new price.
-         */
-        effective_after?: number;
-
-        /**
-         * The ID of the price object.
-         */
-        price: string;
-      }
-
       type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
     }
 
@@ -606,7 +584,7 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.Price>>;
 
       /**
-       * Returns a list of your active prices, excluding [inline prices](https://stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
+       * Returns a list of your active prices, excluding [inline prices](https://docs.stripe.com/docs/products-prices/pricing-models#inline-pricing). For the list of inactive prices, set active to false.
        */
       list(
         params?: PriceListParams,
@@ -615,7 +593,7 @@ declare module 'stripe' {
       list(options?: RequestOptions): ApiListPromise<Stripe.Price>;
 
       /**
-       * Search for prices you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Search for prices you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
        * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
        * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
        * to an hour behind during outages. Search functionality is not available to merchants in India.

package/types/Products.d.ts

@@ -98,11 +98,6 @@ declare module 'stripe' {
        */
       package_dimensions: Product.PackageDimensions | null;
 
-      /**
-       * Provisioning configuration for this product.
-       */
-      provisioning?: Product.Provisioning | null;
-
       /**
        * Whether this product is shipped (i.e., physical goods).
        */
@@ -169,40 +164,6 @@ declare module 'stripe' {
         width: number;
       }
 
-      interface Provisioning {
-        gift_card: Provisioning.GiftCard | null;
-
-        /**
-         * The type of provisioning, only `gift_card` currently supported.
-         */
-        type: 'gift_card';
-      }
-
-      namespace Provisioning {
-        interface GiftCard {
-          fixed_amount: GiftCard.FixedAmount | null;
-
-          /**
-           * The specific type of gift_card provisioning, only `fixed_amount` currently supported.
-           */
-          type: 'fixed_amount';
-        }
-
-        namespace GiftCard {
-          interface FixedAmount {
-            /**
-             * The initial amount with which the provisioned gift card will be created.
-             */
-            amount: number;
-
-            /**
-             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
-             */
-            currency: string;
-          }
-        }
-      }
-
       type Type = 'good' | 'service';
     }
   }

package/types/ProductsResource.d.ts

@@ -53,11 +53,6 @@ declare module 'stripe' {
        */
       package_dimensions?: ProductCreateParams.PackageDimensions;
 
-      /**
-       * Provisioning configuration for this product.
-       */
-      provisioning?: ProductCreateParams.Provisioning;
-
       /**
        * Whether this product is shipped (i.e., physical goods).
        */
@@ -288,37 +283,6 @@ declare module 'stripe' {
         width: number;
       }
 
-      interface Provisioning {
-        gift_card?: Provisioning.GiftCard;
-
-        /**
-         * The type of provisioning, only `gift_card` currently supported.
-         */
-        type: 'gift_card';
-      }
-
-      namespace Provisioning {
-        interface GiftCard {
-          fixed_amount?: GiftCard.FixedAmount;
-
-          /**
-           * The specific type of gift_card provisioning, only `fixed_amount` currently supported.
-           */
-          type: 'fixed_amount';
-        }
-
-        namespace GiftCard {
-          interface FixedAmount {
-            /**
-             * The initial amount with which the provisioned gift card will be created.
-             */
-            amount: number;
-
-            currency: string;
-          }
-        }
-      }
-
       type Type = 'good' | 'service';
     }
 
@@ -638,7 +602,7 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.ProductFeature>>;
 
       /**
-       * Search for products you've previously created using Stripe's [Search Query Language](https://stripe.com/docs/search#search-query-language).
+       * Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
        * Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
        * conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
        * to an hour behind during outages. Search functionality is not available to merchants in India.

package/types/PromotionCodes.d.ts

@@ -44,11 +44,6 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer | null;
 
-      /**
-       * The account that this promotion code can be used by.
-       */
-      customer_account?: string | null;
-
       /**
        * Date at which the promotion code can no longer be redeemed.
        */

package/types/PromotionCodesResource.d.ts

@@ -25,11 +25,6 @@ declare module 'stripe' {
        */
       customer?: string;
 
-      /**
-       * The account that this promotion code can be used by. If not set, the promotion code can be used by all accounts.
-       */
-      customer_account?: string;
-
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -166,11 +161,6 @@ declare module 'stripe' {
        */
       customer?: string;
 
-      /**
-       * Only return promotion codes that are restricted to this account.
-       */
-      customer_account?: string;
-
       /**
        * Specifies which fields in the response should be expanded.
        */
@@ -187,7 +177,7 @@ declare module 'stripe' {
       ): Promise<Stripe.Response<Stripe.PromotionCode>>;
 
       /**
-       * Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://stripe.com/docs/api/promotion_codes/list) with the desired code.
+       * Retrieves the promotion code with the given ID. In order to retrieve a promotion code by the customer-facing code use [list](https://docs.stripe.com/docs/api/promotion_codes/list) with the desired code.
        */
       retrieve(
         id: string,