stripe 16.6.0 → 16.7.0-beta.1

package/types/Subscriptions.d.ts

@@ -146,6 +146,11 @@ 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.
        */
@@ -196,6 +201,11 @@ 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
        */
@@ -382,6 +392,37 @@ 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`.
@@ -608,6 +649,11 @@ 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 {
@@ -620,7 +666,11 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch = 'balances' | 'ownership' | 'transactions';
+              type Prefetch =
+                | 'balances'
+                | 'inferred_balances'
+                | 'ownership'
+                | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -689,6 +739,11 @@ 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.
          */
@@ -705,6 +760,32 @@ 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,6 +157,11 @@ declare module 'stripe' {
         SubscriptionCreateParams.PendingInvoiceItemInterval
       >;
 
+      /**
+       * If specified, the invoicing for the given billing cycle iterations will be processed now.
+       */
+      prebilling?: SubscriptionCreateParams.Prebilling;
+
       /**
        * The ID of a 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.
        */
@@ -233,12 +238,56 @@ 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).
@@ -353,12 +402,56 @@ 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.
@@ -429,6 +522,11 @@ 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 {
@@ -450,12 +548,56 @@ 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).
@@ -507,6 +649,22 @@ 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 =
@@ -745,6 +903,11 @@ 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 {
@@ -757,7 +920,11 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch = 'balances' | 'ownership' | 'transactions';
+              type Prefetch =
+                | 'balances'
+                | 'inferred_balances'
+                | 'ownership'
+                | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -815,6 +982,22 @@ 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 {
@@ -1000,6 +1183,11 @@ 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.
        */
@@ -1076,12 +1264,56 @@ 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).
@@ -1195,12 +1427,56 @@ 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.
@@ -1307,12 +1583,56 @@ 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).
@@ -1618,6 +1938,11 @@ 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 {
@@ -1630,7 +1955,11 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch = 'balances' | 'ownership' | 'transactions';
+              type Prefetch =
+                | 'balances'
+                | 'inferred_balances'
+                | 'ownership'
+                | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -1688,6 +2017,22 @@ 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 {