stripe 19.3.0 → 19.4.0-alpha.1

package/types/Subscriptions.d.ts

@@ -34,6 +34,11 @@ declare module 'stripe' {
 
       automatic_tax: Subscription.AutomaticTax;
 
+      /**
+       * The Billing Cadence which controls the timing of recurring invoice generation for this subscription.If unset, the subscription will bill according to its own configured schedule and create its own invoices.If set, this subscription will be billed by the cadence instead, potentially sharing invoices with the other subscriptions linked to that Cadence.
+       */
+      billing_cadence?: string;
+
       /**
        * The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format.
        */
@@ -49,6 +54,11 @@ declare module 'stripe' {
        */
       billing_mode: Subscription.BillingMode;
 
+      /**
+       * Billing schedules for this subscription.
+       */
+      billing_schedules?: Array<Subscription.BillingSchedule>;
+
       /**
        * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period
        */
@@ -94,6 +104,11 @@ declare module 'stripe' {
        */
       customer: string | Stripe.Customer | Stripe.DeletedCustomer;
 
+      /**
+       * ID of the account who owns the subscription.
+       */
+      customer_account?: string | null;
+
       /**
        * Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.
        */
@@ -136,6 +151,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.
        */
@@ -186,6 +206,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
        */
@@ -332,6 +357,79 @@ declare module 'stripe' {
         type Type = 'classic' | 'flexible';
       }
 
+      interface BillingSchedule {
+        /**
+         * Specifies which subscription items the billing schedule applies to.
+         */
+        applies_to: Array<BillingSchedule.AppliesTo> | null;
+
+        /**
+         * Specifies the billing period.
+         */
+        bill_until: BillingSchedule.BillUntil;
+
+        /**
+         * Unique identifier for the billing schedule.
+         */
+        key: string;
+      }
+
+      namespace BillingSchedule {
+        interface AppliesTo {
+          /**
+           * The billing schedule will apply to the subscription item with the given price ID.
+           */
+          price: string | Stripe.Price | null;
+
+          /**
+           * Controls which subscription items the billing schedule applies to.
+           */
+          type: 'price';
+        }
+
+        interface BillUntil {
+          /**
+           * The timestamp the billing schedule will apply until.
+           */
+          computed_timestamp: number;
+
+          /**
+           * Specifies the billing period.
+           */
+          duration: BillUntil.Duration | null;
+
+          /**
+           * If specified, the billing schedule will apply until the specified timestamp.
+           */
+          timestamp: number | null;
+
+          /**
+           * Describes how the billing schedule will determine the end date. Either `duration` or `timestamp`.
+           */
+          type: BillUntil.Type;
+        }
+
+        namespace BillUntil {
+          interface Duration {
+            /**
+             * Specifies billing duration. Either `day`, `week`, `month` or `year`.
+             */
+            interval: Duration.Interval;
+
+            /**
+             * The multiplier applied to the interval.
+             */
+            interval_count: number | null;
+          }
+
+          namespace Duration {
+            type Interval = 'day' | 'month' | 'week' | 'year';
+          }
+
+          type Type = 'duration' | 'timestamp';
+        }
+      }
+
       interface BillingThresholds {
         /**
          * Monetary threshold that triggers the subscription to create an invoice
@@ -409,6 +507,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`.
@@ -464,16 +593,31 @@ declare module 'stripe' {
            */
           customer_balance: PaymentMethodOptions.CustomerBalance | null;
 
+          /**
+           * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to invoices created by the subscription.
+           */
+          id_bank_transfer?: PaymentMethodOptions.IdBankTransfer | null;
+
           /**
            * This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription.
            */
           konbini: PaymentMethodOptions.Konbini | null;
 
+          /**
+           * This sub-hash contains details about the Pix payment method options to pass to invoices created by the subscription.
+           */
+          pix?: PaymentMethodOptions.Pix | null;
+
           /**
            * This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription.
            */
           sepa_debit: PaymentMethodOptions.SepaDebit | null;
 
+          /**
+           * This sub-hash contains details about the UPI payment method options to pass to invoices created by the subscription.
+           */
+          upi?: PaymentMethodOptions.Upi | null;
+
           /**
            * This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription.
            */
@@ -603,10 +747,83 @@ declare module 'stripe' {
             }
           }
 
+          interface IdBankTransfer {}
+
           interface Konbini {}
 
+          interface Pix {
+            mandate_options?: Pix.MandateOptions;
+          }
+
+          namespace Pix {
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments.
+               */
+              amount: number | null;
+
+              /**
+               * Determines if the amount includes the IOF tax.
+               */
+              amount_includes_iof: MandateOptions.AmountIncludesIof | null;
+
+              /**
+               * Date when the mandate expires and no further payments will be charged, in `YYYY-MM-DD`.
+               */
+              end_date: string | null;
+
+              /**
+               * Schedule at which the future payments will be charged.
+               */
+              payment_schedule: MandateOptions.PaymentSchedule | null;
+            }
+
+            namespace MandateOptions {
+              type AmountIncludesIof = 'always' | 'never';
+
+              type PaymentSchedule =
+                | 'halfyearly'
+                | 'monthly'
+                | 'quarterly'
+                | 'weekly'
+                | 'yearly';
+            }
+          }
+
           interface SepaDebit {}
 
+          interface Upi {
+            mandate_options?: Upi.MandateOptions;
+          }
+
+          namespace Upi {
+            interface MandateOptions {
+              /**
+               * Amount to be charged for future payments.
+               */
+              amount: number | null;
+
+              /**
+               * One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param.
+               */
+              amount_type: MandateOptions.AmountType | null;
+
+              /**
+               * A description of the mandate or subscription that is meant to be displayed to the customer.
+               */
+              description: string | null;
+
+              /**
+               * End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date.
+               */
+              end_date: number | null;
+            }
+
+            namespace MandateOptions {
+              type AmountType = 'fixed' | 'maximum';
+            }
+          }
+
           interface UsBankAccount {
             financial_connections?: UsBankAccount.FinancialConnections;
 
@@ -637,6 +854,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 {
@@ -649,7 +871,11 @@ declare module 'stripe' {
                 | 'payment_method'
                 | 'transactions';
 
-              type Prefetch = 'balances' | 'ownership' | 'transactions';
+              type Prefetch =
+                | 'balances'
+                | 'inferred_balances'
+                | 'ownership'
+                | 'transactions';
             }
 
             type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
@@ -675,6 +901,7 @@ declare module 'stripe' {
           | 'fpx'
           | 'giropay'
           | 'grabpay'
+          | 'id_bank_transfer'
           | 'ideal'
           | 'jp_credit_transfer'
           | 'kakao_pay'
@@ -689,12 +916,15 @@ declare module 'stripe' {
           | 'payco'
           | 'paynow'
           | 'paypal'
+          | 'pix'
           | 'promptpay'
           | 'revolut_pay'
           | 'sepa_credit_transfer'
           | 'sepa_debit'
           | 'sofort'
+          | 'stripe_balance'
           | 'swish'
+          | 'upi'
           | 'us_bank_account'
           | 'wechat_pay';
 
@@ -728,6 +958,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.
          */
@@ -744,6 +979,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'