stripe 16.13.0-beta.1 → 17.1.0

package/types/Subscriptions.d.ts

@@ -146,11 +146,6 @@ declare module 'stripe' {
        */
       items: ApiList<Stripe.SubscriptionItem>;
 
-      /**
-       * Details of the most recent price migration that failed for the subscription.
-       */
-      last_price_migration_error?: Subscription.LastPriceMigrationError | null;
-
       /**
        * The most recent invoice this subscription has generated.
        */
@@ -201,11 +196,6 @@ declare module 'stripe' {
        */
       pending_update: Subscription.PendingUpdate | null;
 
-      /**
-       * Time period and invoice for a Subscription billed in advance.
-       */
-      prebilling?: Subscription.Prebilling | null;
-
       /**
        * The schedule attached to the subscription
        */
@@ -392,37 +382,6 @@ declare module 'stripe' {
         }
       }
 
-      interface LastPriceMigrationError {
-        /**
-         * The time at which the price migration encountered an error.
-         */
-        errored_at: number;
-
-        /**
-         * The involved price pairs in each failed transition.
-         */
-        failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
-
-        /**
-         * The type of error encountered by the price migration.
-         */
-        type: 'price_uniqueness_violation';
-      }
-
-      namespace LastPriceMigrationError {
-        interface FailedTransition {
-          /**
-           * The original price to be migrated.
-           */
-          source_price: string;
-
-          /**
-           * The intended resulting price of the migration.
-           */
-          target_price: string;
-        }
-      }
-
       interface PauseCollection {
         /**
          * The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
@@ -650,11 +609,6 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for possible accounts to link. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
-
-                /**
-                 * The institution to use to filter for possible accounts to link.
-                 */
-                institution?: string;
               }
 
               namespace Filters {
@@ -667,11 +621,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -740,11 +690,6 @@ declare module 'stripe' {
          */
         expires_at: number;
 
-        /**
-         * The number of iterations of prebilling to apply.
-         */
-        prebilling_iterations?: number | null;
-
         /**
          * List of subscription items, each with an attached plan, that will be set if the update is applied.
          */
@@ -761,32 +706,6 @@ declare module 'stripe' {
         trial_from_plan: boolean | null;
       }
 
-      interface Prebilling {
-        /**
-         * ID of the prebilling invoice.
-         */
-        invoice: string | Stripe.Invoice;
-
-        /**
-         * The end of the last period for which the invoice pre-bills.
-         */
-        period_end: number;
-
-        /**
-         * The start of the first period for which the invoice pre-bills.
-         */
-        period_start: number;
-
-        /**
-         * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period.
-         */
-        update_behavior?: Prebilling.UpdateBehavior;
-      }
-
-      namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
-      }
-
       type Status =
         | 'active'
         | 'canceled'

package/types/SubscriptionsResource.d.ts

@@ -157,11 +157,6 @@ declare module 'stripe' {
         SubscriptionCreateParams.PendingInvoiceItemInterval
       >;
 
-      /**
-       * If specified, the invoicing for the given billing cycle iterations will be processed now.
-       */
-      prebilling?: SubscriptionCreateParams.Prebilling;
-
       /**
        * The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
        */
@@ -238,56 +233,12 @@ declare module 'stripe' {
            */
           discount?: string;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code?: string;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * Time span for the redeemed discount.
-             */
-            duration?: DiscountEnd.Duration;
-
-            /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
-             */
-            timestamp?: number;
-
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
-          }
-
-          namespace DiscountEnd {
-            interface Duration {
-              /**
-               * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Duration.Interval;
-
-              /**
-               * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-               */
-              interval_count: number;
-            }
-
-            namespace Duration {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type Type = 'duration' | 'timestamp';
-          }
-        }
-
         interface PriceData {
           /**
            * 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).
@@ -402,56 +353,12 @@ declare module 'stripe' {
          */
         discount?: string;
 
-        /**
-         * Details to determine how long the discount should be applied for.
-         */
-        discount_end?: Discount.DiscountEnd;
-
         /**
          * ID of the promotion code to create a new discount for.
          */
         promotion_code?: string;
       }
 
-      namespace Discount {
-        interface DiscountEnd {
-          /**
-           * Time span for the redeemed discount.
-           */
-          duration?: DiscountEnd.Duration;
-
-          /**
-           * A precise Unix timestamp for the discount to end. Must be in the future.
-           */
-          timestamp?: number;
-
-          /**
-           * The type of calculation made to determine when the discount ends.
-           */
-          type: DiscountEnd.Type;
-        }
-
-        namespace DiscountEnd {
-          interface Duration {
-            /**
-             * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-             */
-            interval: Duration.Interval;
-
-            /**
-             * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-             */
-            interval_count: number;
-          }
-
-          namespace Duration {
-            type Interval = 'day' | 'month' | 'week' | 'year';
-          }
-
-          type Type = 'duration' | 'timestamp';
-        }
-      }
-
       interface InvoiceSettings {
         /**
          * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -522,11 +429,6 @@ declare module 'stripe' {
          * A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates) on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.
          */
         tax_rates?: Stripe.Emptyable<Array<string>>;
-
-        /**
-         * Define options to configure the trial on the subscription item.
-         */
-        trial?: Item.Trial;
       }
 
       namespace Item {
@@ -548,56 +450,12 @@ declare module 'stripe' {
            */
           discount?: string;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code?: string;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * Time span for the redeemed discount.
-             */
-            duration?: DiscountEnd.Duration;
-
-            /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
-             */
-            timestamp?: number;
-
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
-          }
-
-          namespace DiscountEnd {
-            interface Duration {
-              /**
-               * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Duration.Interval;
-
-              /**
-               * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-               */
-              interval_count: number;
-            }
-
-            namespace Duration {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type Type = 'duration' | 'timestamp';
-          }
-        }
-
         interface PriceData {
           /**
            * 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).
@@ -649,22 +507,6 @@ declare module 'stripe' {
 
           type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
         }
-
-        interface Trial {
-          /**
-           * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial. Currently only supports at most 1 price ID.
-           */
-          converts_to?: Array<string>;
-
-          /**
-           * Determines the type of trial for this item.
-           */
-          type: Trial.Type;
-        }
-
-        namespace Trial {
-          type Type = 'free' | 'paid';
-        }
       }
 
       type PaymentBehavior =
@@ -904,11 +746,6 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
-
-                /**
-                 * ID of the institution to use to filter for selectable accounts.
-                 */
-                institution?: string;
               }
 
               namespace Filters {
@@ -921,11 +758,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -983,22 +816,6 @@ declare module 'stripe' {
         type Interval = 'day' | 'month' | 'week' | 'year';
       }
 
-      interface Prebilling {
-        /**
-         * This is used to determine the number of billing cycles to prebill.
-         */
-        iterations: number;
-
-        /**
-         * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
-         */
-        update_behavior?: Prebilling.UpdateBehavior;
-      }
-
-      namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
-      }
-
       type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
 
       interface TransferData {
@@ -1184,11 +1001,6 @@ declare module 'stripe' {
         SubscriptionUpdateParams.PendingInvoiceItemInterval
       >;
 
-      /**
-       * If specified, the invoicing for the given billing cycle iterations will be processed now.
-       */
-      prebilling?: SubscriptionUpdateParams.Prebilling;
-
       /**
        * The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
        */
@@ -1265,56 +1077,12 @@ declare module 'stripe' {
            */
           discount?: string;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code?: string;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * Time span for the redeemed discount.
-             */
-            duration?: DiscountEnd.Duration;
-
-            /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
-             */
-            timestamp?: number;
-
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
-          }
-
-          namespace DiscountEnd {
-            interface Duration {
-              /**
-               * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Duration.Interval;
-
-              /**
-               * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-               */
-              interval_count: number;
-            }
-
-            namespace Duration {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type Type = 'duration' | 'timestamp';
-          }
-        }
-
         interface PriceData {
           /**
            * 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).
@@ -1428,56 +1196,12 @@ declare module 'stripe' {
          */
         discount?: string;
 
-        /**
-         * Details to determine how long the discount should be applied for.
-         */
-        discount_end?: Discount.DiscountEnd;
-
         /**
          * ID of the promotion code to create a new discount for.
          */
         promotion_code?: string;
       }
 
-      namespace Discount {
-        interface DiscountEnd {
-          /**
-           * Time span for the redeemed discount.
-           */
-          duration?: DiscountEnd.Duration;
-
-          /**
-           * A precise Unix timestamp for the discount to end. Must be in the future.
-           */
-          timestamp?: number;
-
-          /**
-           * The type of calculation made to determine when the discount ends.
-           */
-          type: DiscountEnd.Type;
-        }
-
-        namespace DiscountEnd {
-          interface Duration {
-            /**
-             * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-             */
-            interval: Duration.Interval;
-
-            /**
-             * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-             */
-            interval_count: number;
-          }
-
-          namespace Duration {
-            type Interval = 'day' | 'month' | 'week' | 'year';
-          }
-
-          type Type = 'duration' | 'timestamp';
-        }
-      }
-
       interface InvoiceSettings {
         /**
          * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
@@ -1584,56 +1308,12 @@ declare module 'stripe' {
            */
           discount?: string;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code?: string;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * Time span for the redeemed discount.
-             */
-            duration?: DiscountEnd.Duration;
-
-            /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
-             */
-            timestamp?: number;
-
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
-          }
-
-          namespace DiscountEnd {
-            interface Duration {
-              /**
-               * Specifies a type of interval unit. Either `day`, `week`, `month` or `year`.
-               */
-              interval: Duration.Interval;
-
-              /**
-               * The number of intervals, as an whole number greater than 0. Stripe multiplies this by the interval type to get the overall duration.
-               */
-              interval_count: number;
-            }
-
-            namespace Duration {
-              type Interval = 'day' | 'month' | 'week' | 'year';
-            }
-
-            type Type = 'duration' | 'timestamp';
-          }
-        }
-
         interface PriceData {
           /**
            * 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).
@@ -1940,11 +1620,6 @@ declare module 'stripe' {
                  * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                  */
                 account_subcategories?: Array<Filters.AccountSubcategory>;
-
-                /**
-                 * ID of the institution to use to filter for selectable accounts.
-                 */
-                institution?: string;
               }
 
               namespace Filters {
@@ -1957,11 +1632,7 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch =
-                | 'balances'
-                | 'inferred_balances'
-                | 'ownership'
-                | 'transactions';
+              type Prefetch = 'balances' | 'ownership' | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -2019,22 +1690,6 @@ declare module 'stripe' {
         type Interval = 'day' | 'month' | 'week' | 'year';
       }
 
-      interface Prebilling {
-        /**
-         * This is used to determine the number of billing cycles to prebill.
-         */
-        iterations: number;
-
-        /**
-         * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
-         */
-        update_behavior?: Prebilling.UpdateBehavior;
-      }
-
-      namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
-      }
-
       type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
 
       interface TransferData {
@@ -2317,11 +1972,11 @@ declare module 'stripe' {
       list(options?: RequestOptions): ApiListPromise<Stripe.Subscription>;
 
       /**
-       * Cancels a customer's subscription immediately. The customer will not be charged again for the subscription.
+       * Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, you can no longer update the subscription or its [metadata](https://stripe.com/metadata).
        *
-       * Note, however, that any pending invoice items that you've created will still be charged for at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations will also be left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations will be removed.
+       * Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://stripe.com/docs/api#delete_invoiceitem). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed.
        *
-       * By default, upon subscription cancellation, Stripe will stop automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
+       * By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
        */
       cancel(
         id: string,

package/types/Tax/Settings.d.ts

@@ -27,7 +27,7 @@ declare module 'stripe' {
         livemode: boolean;
 
         /**
-         * The `active` status indicates you have all required settings to calculate tax. A status can transition out of `active` when new required settings are introduced.
+         * The status of the Tax `Settings`.
          */
         status: Settings.Status;