stripe 18.2.1 → 18.3.0-beta.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

@@ -108,6 +108,36 @@ 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 {
+      interface BillingThresholds {
+        /**
+         * Usage threshold that triggers the subscription to create an invoice
+         */
+        usage_gte: number | null;
+      }
+
+      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';
+      }
     }
 
     namespace SubscriptionItem {

package/types/SubscriptionItemsResource.d.ts

@@ -77,6 +77,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 {
@@ -98,12 +103,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 +212,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 {
@@ -268,12 +333,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'

package/types/SubscriptionSchedules.d.ts

@@ -27,6 +27,16 @@ 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](https://docs.stripe.com/api/subscriptions/create#create_subscription-billing_mode) that will be used to process all future operations for the subscription schedule.
+       */
+      billing_mode?: SubscriptionSchedule.BillingMode;
+
       /**
        * Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch.
        */
@@ -52,6 +62,11 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
+      /**
+       * ID of the account who owns the subscription schedule.
+       */
+      customer_account?: string | null;
+
       default_settings: SubscriptionSchedule.DefaultSettings;
 
       /**
@@ -59,6 +74,11 @@ 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.
        */
@@ -74,6 +94,11 @@ 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.
        */
@@ -101,6 +126,10 @@ declare module 'stripe' {
     }
 
     namespace SubscriptionSchedule {
+      type BillingBehavior = 'prorate_on_next_phase' | 'prorate_up_front';
+
+      type BillingMode = 'classic' | 'flexible';
+
       interface CurrentPhase {
         /**
          * The end of this phase of the subscription schedule.
@@ -260,6 +289,37 @@ 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.
@@ -338,6 +398,11 @@ 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`.
          */
@@ -353,10 +418,20 @@ 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 {
@@ -394,11 +469,30 @@ 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 AutomaticTax {
@@ -463,12 +557,31 @@ 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.
@@ -541,6 +654,11 @@ 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 {
@@ -562,11 +680,57 @@ 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 =
@@ -585,6 +749,54 @@ 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 =