stripe 22.3.0 → 22.4.0-beta.1

package/cjs/resources/SubscriptionItems.d.ts

@@ -56,6 +56,10 @@ export interface SubscriptionItem {
      * The start time of this subscription item's current billing period.
      */
     current_period_start: number;
+    /**
+     * The current trial that is applied to this subscription item.
+     */
+    current_trial?: SubscriptionItem.CurrentTrial | null;
     /**
      * Always true for a deleted object
      */
@@ -100,6 +104,10 @@ export interface SubscriptionItem {
      * The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`.
      */
     tax_rates: Array<TaxRate> | null;
+    /**
+     * Options that configure the trial on the subscription item.
+     */
+    trial?: SubscriptionItem.Trial | null;
 }
 export interface DeletedSubscriptionItem {
     /**
@@ -122,6 +130,24 @@ export declare namespace SubscriptionItem {
          */
         usage_gte: number | null;
     }
+    interface CurrentTrial {
+        end_date: number;
+        start_date: number;
+        trial_offer: string;
+    }
+    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';
+    }
 }
 export interface SubscriptionItemCreateParams {
     /**
@@ -132,6 +158,10 @@ export interface SubscriptionItemCreateParams {
      * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
      */
     billing_thresholds?: Emptyable<SubscriptionItemCreateParams.BillingThresholds>;
+    /**
+     * The trial offer to apply to this subscription item.
+     */
+    current_trial?: SubscriptionItemCreateParams.CurrentTrial;
     /**
      * The coupons to redeem into discounts for the subscription item.
      */
@@ -176,6 +206,10 @@ export interface SubscriptionItemCreateParams {
      * A list of [Tax Rate](https://docs.stripe.com/api/tax_rates) ids. These Tax Rates will override the [`default_tax_rates`](https://docs.stripe.com/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?: Emptyable<Array<string>>;
+    /**
+     * Options that configure the trial on the subscription item.
+     */
+    trial?: SubscriptionItemCreateParams.Trial;
 }
 export declare namespace SubscriptionItemCreateParams {
     interface BillingThresholds {
@@ -184,6 +218,16 @@ export declare namespace SubscriptionItemCreateParams {
          */
         usage_gte: number;
     }
+    interface CurrentTrial {
+        /**
+         * Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
+         */
+        trial_end?: number;
+        /**
+         * The ID of the trial offer to apply to the subscription item.
+         */
+        trial_offer: string;
+    }
     interface Discount {
         /**
          * ID of the coupon to create a new discount for.
@@ -193,6 +237,10 @@ export declare namespace SubscriptionItemCreateParams {
          * ID of an existing discount on the object (or one of its ancestors) to reuse.
          */
         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.
          */
@@ -226,6 +274,48 @@ export declare namespace SubscriptionItemCreateParams {
         unit_amount_decimal?: Decimal;
     }
     type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
+    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 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;
+            }
+            type Type = 'duration' | 'timestamp';
+            namespace Duration {
+                type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+        }
+    }
     namespace PriceData {
         interface Recurring {
             /**
@@ -242,6 +332,9 @@ export declare namespace SubscriptionItemCreateParams {
             type Interval = 'day' | 'month' | 'week' | 'year';
         }
     }
+    namespace Trial {
+        type Type = 'free' | 'paid';
+    }
 }
 export interface SubscriptionItemRetrieveParams {
     /**
@@ -254,6 +347,10 @@ export interface SubscriptionItemUpdateParams {
      * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.
      */
     billing_thresholds?: Emptyable<SubscriptionItemUpdateParams.BillingThresholds>;
+    /**
+     * The trial offer to apply to this subscription item.
+     */
+    current_trial?: SubscriptionItemUpdateParams.CurrentTrial;
     /**
      * The coupons to redeem into discounts for the subscription item.
      */
@@ -310,6 +407,16 @@ export declare namespace SubscriptionItemUpdateParams {
          */
         usage_gte: number;
     }
+    interface CurrentTrial {
+        /**
+         * Unix timestamp representing the end of the trial offer period. Required when the trial offer has `duration.type=timestamp`. Cannot be specified when `duration.type=relative`.
+         */
+        trial_end?: number;
+        /**
+         * The ID of the trial offer to apply to the subscription item.
+         */
+        trial_offer: string;
+    }
     interface Discount {
         /**
          * ID of the coupon to create a new discount for.
@@ -319,6 +426,10 @@ export declare namespace SubscriptionItemUpdateParams {
          * ID of an existing discount on the object (or one of its ancestors) to reuse.
          */
         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.
          */
@@ -352,6 +463,38 @@ export declare namespace SubscriptionItemUpdateParams {
         unit_amount_decimal?: Decimal;
     }
     type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
+    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;
+            }
+            type Type = 'duration' | 'timestamp';
+            namespace Duration {
+                type Interval = 'day' | 'month' | 'week' | 'year';
+            }
+        }
+    }
     namespace PriceData {
         interface Recurring {
             /**