stripe 20.0.0 → 20.1.0-alpha.2

package/types/Sources.d.ts

@@ -105,6 +105,8 @@ declare module 'stripe' {
 
       p24?: Source.P24;
 
+      paypal?: Source.Paypal;
+
       receiver?: Source.Receiver;
 
       redirect?: Source.Redirect;
@@ -236,6 +238,8 @@ declare module 'stripe' {
 
         brand?: string | null;
 
+        brand_product?: string | null;
+
         country?: string | null;
 
         cvc_check?: string | null;
@@ -276,6 +280,8 @@ declare module 'stripe' {
 
         brand?: string | null;
 
+        brand_product?: string | null;
+
         country?: string | null;
 
         cvm_type?: string;
@@ -479,6 +485,26 @@ declare module 'stripe' {
         reference?: string | null;
       }
 
+      interface Paypal {
+        billing_agreement?: string | null;
+
+        fingerprint?: string | null;
+
+        payer_id?: string | null;
+
+        reference_id?: string;
+
+        reference_transaction_amount?: string;
+
+        reference_transaction_charged?: boolean;
+
+        statement_descriptor?: string | null;
+
+        transaction_id?: string;
+
+        verified_email?: string | null;
+      }
+
       interface Receiver {
         /**
          * The address of the receiver source. This is the value that should be communicated to the customer to send their funds to.
@@ -680,6 +706,8 @@ declare module 'stripe' {
 
         brand?: string | null;
 
+        brand_product?: string | null;
+
         card?: string | null;
 
         country?: string | null;
@@ -728,6 +756,7 @@ declare module 'stripe' {
         | 'klarna'
         | 'multibanco'
         | 'p24'
+        | 'paypal'
         | 'sepa_credit_transfer'
         | 'sepa_debit'
         | 'sofort'

package/types/SubscriptionItems.d.ts

@@ -37,6 +37,11 @@ declare module 'stripe' {
        */
       object: 'subscription_item';
 
+      /**
+       * The time period the subscription item has been billed for.
+       */
+      billed_until?: number | null;
+
       /**
        * Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period
        */
@@ -57,6 +62,11 @@ declare module 'stripe' {
        */
       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
        */
@@ -108,6 +118,11 @@ declare module 'stripe' {
        * 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<Stripe.TaxRate> | null;
+
+      /**
+       * Options that configure the trial on the subscription item.
+       */
+      trial?: SubscriptionItem.Trial | null;
     }
 
     namespace SubscriptionItem {
@@ -117,6 +132,30 @@ declare module 'stripe' {
          */
         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';
+      }
     }
   }
 }

package/types/SubscriptionItemsResource.d.ts

@@ -15,6 +15,11 @@ declare module 'stripe' {
         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.
        */
@@ -77,6 +82,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>>;
+
+      /**
+       * Options that configure the trial on the subscription item.
+       */
+      trial?: SubscriptionItemCreateParams.Trial;
     }
 
     namespace SubscriptionItemCreateParams {
@@ -87,6 +97,18 @@ declare module 'stripe' {
         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.
@@ -98,12 +120,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';
+        }
+      }
+
       type PaymentBehavior =
         | 'allow_incomplete'
         | 'default_incomplete'
@@ -163,6 +229,22 @@ declare module 'stripe' {
       }
 
       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 Trial {
+        type Type = 'free' | 'paid';
+      }
     }
 
     interface SubscriptionItemRetrieveParams {
@@ -180,6 +262,11 @@ declare module 'stripe' {
         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.
        */
@@ -257,6 +344,18 @@ declare module 'stripe' {
         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.
@@ -268,12 +367,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';
+        }
+      }
+
       type PaymentBehavior =
         | 'allow_incomplete'
         | 'default_incomplete'