stripe 20.1.0-beta.1 → 20.1.0

package/types/SubscriptionSchedules.d.ts

@@ -5,7 +5,7 @@ declare module 'stripe' {
     /**
      * A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.
      *
-     * Related guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)
+     * Related guide: [Subscription schedules](https://docs.stripe.com/billing/subscriptions/subscription-schedules)
      */
     interface SubscriptionSchedule {
       /**
@@ -27,11 +27,6 @@ declare module 'stripe' {
         | Stripe.DeletedApplication
         | null;
 
-      /**
-       * Configures when the subscription schedule generates prorations for phase transitions. Possible values are `prorate_on_next_phase` or `prorate_up_front` with the default being `prorate_on_next_phase`. `prorate_on_next_phase` will apply phase changes and generate prorations at transition time. `prorate_up_front` will bill for all phases within the current billing cycle up front.
-       */
-      billing_behavior?: SubscriptionSchedule.BillingBehavior;
-
       /**
        * The billing mode of the subscription.
        */
@@ -65,7 +60,7 @@ declare module 'stripe' {
       /**
        * ID of the account who owns the subscription schedule.
        */
-      customer_account?: string | null;
+      customer_account: string | null;
 
       default_settings: SubscriptionSchedule.DefaultSettings;
 
@@ -74,18 +69,13 @@ declare module 'stripe' {
        */
       end_behavior: SubscriptionSchedule.EndBehavior;
 
-      /**
-       * Details of the most recent price migration that failed for the subscription schedule.
-       */
-      last_price_migration_error?: SubscriptionSchedule.LastPriceMigrationError | null;
-
       /**
        * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
        */
       livemode: boolean;
 
       /**
-       * 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.
+       * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
        */
       metadata: Stripe.Metadata | null;
 
@@ -94,11 +84,6 @@ declare module 'stripe' {
        */
       phases: Array<SubscriptionSchedule.Phase>;
 
-      /**
-       * Time period and invoice for a Subscription billed in advance.
-       */
-      prebilling?: SubscriptionSchedule.Prebilling | null;
-
       /**
        * Time at which the subscription schedule was released. Measured in seconds since the Unix epoch.
        */
@@ -110,7 +95,7 @@ declare module 'stripe' {
       released_subscription: string | null;
 
       /**
-       * The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules).
+       * The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://docs.stripe.com/billing/subscriptions/subscription-schedules).
        */
       status: SubscriptionSchedule.Status;
 
@@ -126,8 +111,6 @@ declare module 'stripe' {
     }
 
     namespace SubscriptionSchedule {
-      type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
-
       interface BillingMode {
         /**
          * Configure behavior for flexible billing mode
@@ -181,7 +164,7 @@ declare module 'stripe' {
         automatic_tax?: DefaultSettings.AutomaticTax;
 
         /**
-         * Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
+         * Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
          */
         billing_cycle_anchor: DefaultSettings.BillingCycleAnchor;
 
@@ -319,37 +302,6 @@ declare module 'stripe' {
 
       type EndBehavior = 'cancel' | 'none' | 'release' | 'renew';
 
-      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 Phase {
         /**
          * A list of prices and quantities that will generate invoice items appended to the next invoice for this phase.
@@ -364,7 +316,7 @@ declare module 'stripe' {
         automatic_tax?: Phase.AutomaticTax;
 
         /**
-         * Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
+         * Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
          */
         billing_cycle_anchor: Phase.BillingCycleAnchor | null;
 
@@ -419,7 +371,7 @@ declare module 'stripe' {
         items: Array<Phase.Item>;
 
         /**
-         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
+         * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`.
          */
         metadata: Stripe.Metadata | null;
 
@@ -428,11 +380,6 @@ declare module 'stripe' {
          */
         on_behalf_of: string | Stripe.Account | null;
 
-        /**
-         * If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](https://stripe.com/docs/billing/subscriptions/pause-payment).
-         */
-        pause_collection?: Phase.PauseCollection | null;
-
         /**
          * When transitioning phases, controls how prorations are handled (if any). Possible values are `create_prorations`, `none`, and `always_invoice`.
          */
@@ -448,20 +395,10 @@ declare module 'stripe' {
          */
         transfer_data: Phase.TransferData | null;
 
-        /**
-         * Specify behavior of the trial when crossing schedule phase boundaries
-         */
-        trial_continuation?: Phase.TrialContinuation | null;
-
         /**
          * When the trial ends within the phase.
          */
         trial_end: number | null;
-
-        /**
-         * Settings related to any trials on the subscription during this phase.
-         */
-        trial_settings?: Phase.TrialSettings | null;
       }
 
       namespace Phase {
@@ -472,7 +409,7 @@ declare module 'stripe' {
           discounts: Array<AddInvoiceItem.Discount>;
 
           /**
-           * 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.
+           * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
            */
           metadata: Stripe.Metadata | null;
 
@@ -506,31 +443,12 @@ declare module 'stripe' {
              */
             discount: string | Stripe.Discount | null;
 
-            /**
-             * Details to determine how long the discount should be applied for.
-             */
-            discount_end?: Discount.DiscountEnd | null;
-
             /**
              * ID of the promotion code to create a new discount for.
              */
             promotion_code: string | Stripe.PromotionCode | null;
           }
 
-          namespace Discount {
-            interface DiscountEnd {
-              /**
-               * The discount end timestamp.
-               */
-              timestamp: number | null;
-
-              /**
-               * The discount end type.
-               */
-              type: 'timestamp';
-            }
-          }
-
           interface Period {
             end: Period.End;
 
@@ -634,31 +552,12 @@ declare module 'stripe' {
            */
           discount: string | Stripe.Discount | null;
 
-          /**
-           * Details to determine how long the discount should be applied for.
-           */
-          discount_end?: Discount.DiscountEnd | null;
-
           /**
            * ID of the promotion code to create a new discount for.
            */
           promotion_code: string | Stripe.PromotionCode | null;
         }
 
-        namespace Discount {
-          interface DiscountEnd {
-            /**
-             * The discount end timestamp.
-             */
-            timestamp: number | null;
-
-            /**
-             * The discount end type.
-             */
-            type: 'timestamp';
-          }
-        }
-
         interface InvoiceSettings {
           /**
            * The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule.
@@ -708,7 +607,7 @@ declare module 'stripe' {
           discounts: Array<Item.Discount>;
 
           /**
-           * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
+           * Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered.
            */
           metadata: Stripe.Metadata | null;
 
@@ -731,11 +630,6 @@ declare module 'stripe' {
            * The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`.
            */
           tax_rates?: Array<Stripe.TaxRate> | null;
-
-          /**
-           * Options that configure the trial on the subscription item.
-           */
-          trial?: Item.Trial | null;
         }
 
         namespace Item {
@@ -757,57 +651,11 @@ declare module 'stripe' {
              */
             discount: string | Stripe.Discount | null;
 
-            /**
-             * Details to determine how long the discount should be applied for.
-             */
-            discount_end?: Discount.DiscountEnd | null;
-
             /**
              * ID of the promotion code to create a new discount for.
              */
             promotion_code: string | Stripe.PromotionCode | null;
           }
-
-          namespace Discount {
-            interface DiscountEnd {
-              /**
-               * The discount end timestamp.
-               */
-              timestamp: number | null;
-
-              /**
-               * The discount end type.
-               */
-              type: 'timestamp';
-            }
-          }
-
-          interface Trial {
-            /**
-             * List of price IDs which, if present on the subscription following a paid trial, constitute opting-in to the paid trial.
-             */
-            converts_to?: Array<string> | null;
-
-            /**
-             * Determines the type of trial for this item.
-             */
-            type: Trial.Type;
-          }
-
-          namespace Trial {
-            type Type = 'free' | 'paid';
-          }
-        }
-
-        interface PauseCollection {
-          /**
-           * The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`.
-           */
-          behavior: PauseCollection.Behavior;
-        }
-
-        namespace PauseCollection {
-          type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
         }
 
         type ProrationBehavior =
@@ -826,54 +674,6 @@ declare module 'stripe' {
            */
           destination: string | Stripe.Account;
         }
-
-        type TrialContinuation = 'continue' | 'none';
-
-        interface TrialSettings {
-          /**
-           * Defines how the subscription should behave when a trial ends.
-           */
-          end_behavior: TrialSettings.EndBehavior | null;
-        }
-
-        namespace TrialSettings {
-          interface EndBehavior {
-            /**
-             * Configure how an opt-in following a paid trial is billed when using `billing_behavior: prorate_up_front`.
-             */
-            prorate_up_front: EndBehavior.ProrateUpFront | null;
-          }
-
-          namespace EndBehavior {
-            type ProrateUpFront = 'defer' | 'include';
-          }
-        }
-      }
-
-      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 =