stripe 22.3.0-beta.1 → 22.3.0

package/cjs/resources/Subscriptions.d.ts

@@ -19,7 +19,7 @@ export declare class SubscriptionResource extends StripeResource {
     /**
      * Cancels a customer's subscription immediately. The customer won't be charged again for the subscription. After it's canceled, the subscription is largely immutable. You can still update its [metadata](https://docs.stripe.com/metadata) and cancellation_details.
      *
-     * Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api/invoiceitems/delete). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to true.
+     * Any pending invoice items that you've created are still charged at the end of the period, unless manually [deleted](https://docs.stripe.com/api/invoiceitems/delete). If you've set the subscription to cancel at the end of the period, any pending prorations are also left in place and collected at the end of the period. But if the subscription is set to cancel immediately, pending prorations are removed if invoice_now and prorate are both set to false.
      *
      * By default, upon subscription cancellation, Stripe stops automatic collection of all finalized invoices for the customer. This is intended to prevent unexpected payment attempts after the customer has canceled a subscription. However, you can resume automatic collection of the invoices manually after subscription cancellation to have us proceed. Or, you could check for unpaid invoices before allowing the customer to cancel the subscription at all.
      */
@@ -81,26 +81,10 @@ export declare class SubscriptionResource extends StripeResource {
      * Upgrade the billing_mode of an existing subscription.
      */
     migrate(id: string, params: SubscriptionMigrateParams, options?: RequestOptions): Promise<Response<Subscription>>;
-    /**
-     * Pauses a subscription by transitioning it to the paused status. A paused subscription does not generate invoices and will not advance to new billing periods. The subscription can be resumed later using the resume endpoint. Cannot pause subscriptions with attached schedules.
-     */
-    pause(id: string, params?: SubscriptionPauseParams, options?: RequestOptions): Promise<Response<Subscription>>;
     /**
      * Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Resume is only available for subscriptions that use charge_automatically collection. If Stripe doesn't generate a resumption invoice, the subscription becomes active immediately. When a resumption invoice is generated, Stripe finalizes it immediately. If the invoice is paid or marked uncollectible, the subscription becomes active. If the invoice is manually voided, the subscription stays paused. If there is no payment attempt within 23 hours, Stripe voids the invoice and the subscription stays paused. Learn more about [resuming subscriptions](https://docs.stripe.com/docs/billing/subscriptions/pause#resume-subscriptions).
      */
     resume(id: string, params?: SubscriptionResumeParams, options?: RequestOptions): Promise<Response<Subscription>>;
-    serializeBatchCancel(subscriptionExposedId: string, params?: Record<string, unknown>, options?: {
-        apiVersion?: string;
-        stripeContext?: string;
-    }): string;
-    serializeBatchUpdate(subscriptionExposedId: string, params?: Record<string, unknown>, options?: {
-        apiVersion?: string;
-        stripeContext?: string;
-    }): string;
-    serializeBatchMigrate(subscription: string, params?: Record<string, unknown>, options?: {
-        apiVersion?: string;
-        stripeContext?: string;
-    }): string;
 }
 export interface Subscription {
     /**
@@ -209,10 +193,6 @@ export interface Subscription {
      * List of subscription items, each with an attached price.
      */
     items: ApiList<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 over its lifecycle (for example, when it cycles or is updated).
      */
@@ -257,10 +237,6 @@ export interface Subscription {
      * If specified, [pending updates](https://docs.stripe.com/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid.
      */
     pending_update: Subscription.PendingUpdate | null;
-    /**
-     * Time period and invoice for a Subscription billed in advance.
-     */
-    prebilling?: Subscription.Prebilling | null;
     presentment_details?: Subscription.PresentmentDetails;
     /**
      * The schedule attached to the subscription
@@ -284,10 +260,6 @@ export interface Subscription {
      * If subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.
      */
     status: Subscription.Status;
-    /**
-     * Describes changes to the subscription's status.
-     */
-    status_details?: Subscription.StatusDetails;
     /**
      * ID of the test clock this subscription belongs to.
      */
@@ -404,21 +376,19 @@ export declare namespace Subscription {
          * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
          */
         account_tax_ids: Array<string | TaxId | DeletedTaxId> | null;
-        issuer: InvoiceSettings.Issuer;
-    }
-    interface LastPriceMigrationError {
         /**
-         * The time at which the price migration encountered an error.
+         * A list of up to 4 custom fields to be displayed on the invoice.
          */
-        errored_at: number;
+        custom_fields: Array<InvoiceSettings.CustomField> | null;
         /**
-         * The involved price pairs in each failed transition.
+         * An arbitrary string attached to the object. Often useful for displaying to users.
          */
-        failed_transitions: Array<LastPriceMigrationError.FailedTransition>;
+        description: string | null;
         /**
-         * The type of error encountered by the price migration.
+         * Footer to be displayed on the invoice.
          */
-        type: 'price_uniqueness_violation';
+        footer: string | null;
+        issuer: InvoiceSettings.Issuer;
     }
     interface ManagedPayments {
         /**
@@ -481,10 +451,6 @@ export declare namespace Subscription {
          * 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: Metadata | null;
-        /**
-         * 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.
          */
@@ -498,24 +464,6 @@ export declare namespace Subscription {
          */
         trial_from_plan: boolean | null;
     }
-    interface Prebilling {
-        /**
-         * ID of the prebilling invoice.
-         */
-        invoice: string | 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;
-    }
     interface PresentmentDetails {
         /**
          * Currency used for customer payments.
@@ -523,12 +471,6 @@ export declare namespace Subscription {
         presentment_currency: string;
     }
     type Status = 'active' | 'canceled' | 'incomplete' | 'incomplete_expired' | 'past_due' | 'paused' | 'trialing' | 'unpaid';
-    interface StatusDetails {
-        /**
-         * Indicates when and why the subscription transitioned to the paused status.
-         */
-        paused: StatusDetails.Paused;
-    }
     interface TransferData {
         /**
          * A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination.
@@ -623,6 +565,16 @@ export declare namespace Subscription {
         type Reason = 'canceled_by_retention_policy' | 'cancellation_requested' | 'payment_disputed' | 'payment_failed';
     }
     namespace InvoiceSettings {
+        interface CustomField {
+            /**
+             * The name of the custom field.
+             */
+            name: string;
+            /**
+             * The value of the custom field.
+             */
+            value: string;
+        }
         interface Issuer {
             /**
              * The connected account being referenced when `type` is `account`.
@@ -637,18 +589,6 @@ export declare namespace Subscription {
             type Type = 'account' | 'self';
         }
     }
-    namespace LastPriceMigrationError {
-        interface FailedTransition {
-            /**
-             * The original price to be migrated.
-             */
-            source_price: string;
-            /**
-             * The intended resulting price of the migration.
-             */
-            target_price: string;
-        }
-    }
     namespace PauseCollection {
         type Behavior = 'keep_as_draft' | 'mark_uncollectible' | 'void';
     }
@@ -662,10 +602,6 @@ export declare namespace Subscription {
              * This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription.
              */
             bancontact: PaymentMethodOptions.Bancontact | null;
-            /**
-             * This sub-hash contains details about the Blik payment method options to pass to invoices created by the subscription.
-             */
-            blik?: PaymentMethodOptions.Blik | null;
             /**
              * This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription.
              */
@@ -674,10 +610,6 @@ export declare namespace Subscription {
              * This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription.
              */
             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.
              */
@@ -703,7 +635,7 @@ export declare namespace Subscription {
              */
             us_bank_account: PaymentMethodOptions.UsBankAccount | null;
         }
-        type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
+        type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
         type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
         namespace PaymentMethodOptions {
             interface AcssDebit {
@@ -719,9 +651,6 @@ export declare namespace Subscription {
                  */
                 preferred_language: Bancontact.PreferredLanguage;
             }
-            interface Blik {
-                mandate_options?: Blik.MandateOptions;
-            }
             interface Card {
                 mandate_options?: Card.MandateOptions;
                 /**
@@ -740,8 +669,6 @@ export declare namespace Subscription {
                  */
                 funding_type: 'bank_transfer' | null;
             }
-            interface IdBankTransfer {
-            }
             interface Konbini {
             }
             interface Payto {
@@ -781,14 +708,6 @@ export declare namespace Subscription {
             namespace Bancontact {
                 type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
             }
-            namespace Blik {
-                interface MandateOptions {
-                    /**
-                     * Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite.
-                     */
-                    expires_after: number | null;
-                }
-            }
             namespace Card {
                 interface MandateOptions {
                     /**
@@ -916,13 +835,9 @@ export declare namespace Subscription {
                          * 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;
                     }
                     type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
-                    type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
+                    type Prefetch = 'balances' | 'ownership' | 'transactions';
                     namespace Filters {
                         type AccountSubcategory = 'checking' | 'savings';
                     }
@@ -933,49 +848,14 @@ export declare namespace Subscription {
     namespace PendingInvoiceItemInterval {
         type Interval = 'day' | 'month' | 'week' | 'year';
     }
-    namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
-    }
-    namespace StatusDetails {
-        interface Paused {
-            /**
-             * Information on the `type=subscription` pause.
-             */
-            subscription: Paused.Subscription;
-            /**
-             * Unix timestamp in seconds of when the subscription status transitioned to `paused`.
-             */
-            transitioned_at: number;
-            /**
-             * The type of pause.
-             */
-            type: 'subscription';
-        }
-        namespace Paused {
-            interface Subscription {
-                /**
-                 * The reason that the subscription was paused.
-                 */
-                type: Subscription.Type;
-            }
-            namespace Subscription {
-                type Type = 'pause_requested' | 'system' | 'trial_end_without_payment_method';
-            }
-        }
-    }
     namespace TrialSettings {
         interface EndBehavior {
-            /**
-             * Indicates how the subscription's billing cycle anchor is reset when a trial ends. If not set, the default is `now`.
-             */
-            billing_cycle_anchor?: EndBehavior.BillingCycleAnchor | null;
             /**
              * Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
              */
             missing_payment_method: EndBehavior.MissingPaymentMethod;
         }
         namespace EndBehavior {
-            type BillingCycleAnchor = 'now' | 'unchanged';
             type MissingPaymentMethod = 'cancel' | 'create_invoice' | 'pause';
         }
     }
@@ -1101,10 +981,6 @@ export interface SubscriptionCreateParams {
      * Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api/invoices/create) for the given subscription at the specified interval.
      */
     pending_invoice_item_interval?: Emptyable<SubscriptionCreateParams.PendingInvoiceItemInterval>;
-    /**
-     * If specified, the invoicing for the given billing cycle iterations will be processed now.
-     */
-    prebilling?: SubscriptionCreateParams.Prebilling;
     /**
      * Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
      */
@@ -1242,10 +1118,6 @@ export declare namespace SubscriptionCreateParams {
          * 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.
          */
@@ -1256,6 +1128,18 @@ export declare namespace SubscriptionCreateParams {
          * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
          */
         account_tax_ids?: Emptyable<Array<string>>;
+        /**
+         * A list of up to 4 custom fields to be displayed on the invoice.
+         */
+        custom_fields?: Emptyable<Array<InvoiceSettings.CustomField>>;
+        /**
+         * An arbitrary string attached to the object. Often useful for displaying to users.
+         */
+        description?: string;
+        /**
+         * Footer to be displayed on the invoice.
+         */
+        footer?: string;
         /**
          * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
          */
@@ -1266,10 +1150,6 @@ export declare namespace SubscriptionCreateParams {
          * 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<Item.BillingThresholds>;
-        /**
-         * The trial offer to apply to this subscription item.
-         */
-        current_trial?: Item.CurrentTrial;
         /**
          * The coupons to redeem into discounts for the subscription item.
          */
@@ -1298,10 +1178,6 @@ export declare namespace SubscriptionCreateParams {
          * 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>>;
-        /**
-         * Define options to configure the trial on the subscription item.
-         */
-        trial?: Item.Trial;
     }
     type PaymentBehavior = 'allow_incomplete' | 'default_incomplete' | 'error_if_incomplete' | 'pending_if_incomplete';
     interface PaymentSettings {
@@ -1328,16 +1204,6 @@ export declare namespace SubscriptionCreateParams {
          */
         interval_count?: number;
     }
-    interface Prebilling {
-        /**
-         * This is used to determine the number of billing cycles to prebill.
-         */
-        iterations: number;
-        /**
-         * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
-         */
-        update_behavior?: Prebilling.UpdateBehavior;
-    }
     type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
     interface TransferData {
         /**
@@ -1365,10 +1231,6 @@ export declare namespace SubscriptionCreateParams {
              * 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.
              */
@@ -1406,38 +1268,6 @@ export declare namespace SubscriptionCreateParams {
              */
             unit_amount_decimal?: Decimal;
         }
-        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 Period {
             interface End {
                 /**
@@ -1539,39 +1369,17 @@ export declare namespace SubscriptionCreateParams {
             }
         }
     }
-    namespace Discount {
-        interface DiscountEnd {
+    namespace InvoiceSettings {
+        interface CustomField {
             /**
-             * Time span for the redeemed discount.
+             * The name of the custom field. This may be up to 40 characters.
              */
-            duration?: DiscountEnd.Duration;
+            name: string;
             /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
+             * The value of the custom field. This may be up to 140 characters.
              */
-            timestamp?: number;
-            /**
-             * The type of calculation made to determine when the discount ends.
-             */
-            type: DiscountEnd.Type;
+            value: string;
         }
-        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 InvoiceSettings {
         interface Issuer {
             /**
              * The connected account being referenced when `type` is `account`.
@@ -1593,16 +1401,6 @@ export declare namespace SubscriptionCreateParams {
              */
             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.
@@ -1612,10 +1410,6 @@ export declare namespace SubscriptionCreateParams {
              * 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.
              */
@@ -1647,48 +1441,6 @@ export declare namespace SubscriptionCreateParams {
              */
             unit_amount_decimal?: Decimal;
         }
-        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 {
                 /**
@@ -1705,9 +1457,6 @@ export declare namespace SubscriptionCreateParams {
                 type Interval = 'day' | 'month' | 'week' | 'year';
             }
         }
-        namespace Trial {
-            type Type = 'free' | 'paid';
-        }
     }
     namespace PaymentSettings {
         interface PaymentMethodOptions {
@@ -1719,10 +1468,6 @@ export declare namespace SubscriptionCreateParams {
              * This sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
              */
             bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
-            /**
-             * This sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
-             */
-            blik?: Emptyable<PaymentMethodOptions.Blik>;
             /**
              * This sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
              */
@@ -1731,10 +1476,6 @@ export declare namespace SubscriptionCreateParams {
              * This sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
              */
             customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
-            /**
-             * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
-             */
-            id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
             /**
              * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
              */
@@ -1760,7 +1501,7 @@ export declare namespace SubscriptionCreateParams {
              */
             us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
         }
-        type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
+        type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
         type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
         namespace PaymentMethodOptions {
             interface AcssDebit {
@@ -1779,12 +1520,6 @@ export declare namespace SubscriptionCreateParams {
                  */
                 preferred_language?: Bancontact.PreferredLanguage;
             }
-            interface Blik {
-                /**
-                 * Configuration options for setting up a mandate
-                 */
-                mandate_options?: Blik.MandateOptions;
-            }
             interface Card {
                 /**
                  * Configuration options for setting up an eMandate for cards issued in India.
@@ -1809,8 +1544,6 @@ export declare namespace SubscriptionCreateParams {
                  */
                 funding_type?: string;
             }
-            interface IdBankTransfer {
-            }
             interface Konbini {
             }
             interface Payto {
@@ -1862,14 +1595,6 @@ export declare namespace SubscriptionCreateParams {
             namespace Bancontact {
                 type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
             }
-            namespace Blik {
-                interface MandateOptions {
-                    /**
-                     * Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite.
-                     */
-                    expires_after?: number;
-                }
-            }
             namespace Card {
                 interface MandateOptions {
                     /**
@@ -1995,13 +1720,9 @@ export declare namespace SubscriptionCreateParams {
                          * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                          */
                         account_subcategories?: Array<Filters.AccountSubcategory>;
-                        /**
-                         * ID of the institution to use to filter for selectable accounts.
-                         */
-                        institution?: string;
                     }
                     type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
-                    type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
+                    type Prefetch = 'balances' | 'ownership' | 'transactions';
                     namespace Filters {
                         type AccountSubcategory = 'checking' | 'savings';
                     }
@@ -2012,22 +1733,14 @@ export declare namespace SubscriptionCreateParams {
     namespace PendingInvoiceItemInterval {
         type Interval = 'day' | 'month' | 'week' | 'year';
     }
-    namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
-    }
     namespace TrialSettings {
         interface EndBehavior {
-            /**
-             * Indicates how the subscription's billing cycle anchor is reset when a trial ends. Defaults to `now`.
-             */
-            billing_cycle_anchor?: EndBehavior.BillingCycleAnchor;
             /**
              * Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
              */
             missing_payment_method: EndBehavior.MissingPaymentMethod;
         }
         namespace EndBehavior {
-            type BillingCycleAnchor = 'now' | 'unchanged';
             type MissingPaymentMethod = 'cancel' | 'create_invoice' | 'pause';
         }
     }
@@ -2143,10 +1856,6 @@ export interface SubscriptionUpdateParams {
      * Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://docs.stripe.com/api/invoices/create) for the given subscription at the specified interval.
      */
     pending_invoice_item_interval?: Emptyable<SubscriptionUpdateParams.PendingInvoiceItemInterval>;
-    /**
-     * If specified, the invoicing for the given billing cycle iterations will be processed now.
-     */
-    prebilling?: SubscriptionUpdateParams.Prebilling;
     /**
      * Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) when the billing cycle changes (e.g., when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial), or if an item's `quantity` changes. The default value is `create_prorations`.
      */
@@ -2263,10 +1972,6 @@ export declare namespace SubscriptionUpdateParams {
          * 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.
          */
@@ -2277,6 +1982,18 @@ export declare namespace SubscriptionUpdateParams {
          * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
          */
         account_tax_ids?: Emptyable<Array<string>>;
+        /**
+         * A list of up to 4 custom fields to be displayed on the invoice.
+         */
+        custom_fields?: Emptyable<Array<InvoiceSettings.CustomField>>;
+        /**
+         * An arbitrary string attached to the object. Often useful for displaying to users.
+         */
+        description?: Emptyable<string>;
+        /**
+         * Footer to be displayed on the invoice.
+         */
+        footer?: Emptyable<string>;
         /**
          * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
          */
@@ -2291,10 +2008,6 @@ export declare namespace SubscriptionUpdateParams {
          * Delete all usage for a given subscription item. You must pass this when deleting a usage records subscription item. `clear_usage` has no effect if the plan has a billing meter attached.
          */
         clear_usage?: boolean;
-        /**
-         * The trial offer to apply to this subscription item.
-         */
-        current_trial?: Item.CurrentTrial;
         /**
          * A flag that, if set to `true`, will delete the specified item.
          */
@@ -2304,7 +2017,7 @@ export declare namespace SubscriptionUpdateParams {
          */
         discounts?: Emptyable<Array<Item.Discount>>;
         /**
-         * Subscription item to update.
+         * Subscription item to update. If you omit `id`, the API adds a new subscription item rather than updating the existing one. See [Changing a subscription's price](https://docs.stripe.com/billing/subscriptions/change-price#changing).
          */
         id?: string;
         /**
@@ -2367,16 +2080,6 @@ export declare namespace SubscriptionUpdateParams {
          */
         interval_count?: number;
     }
-    interface Prebilling {
-        /**
-         * This is used to determine the number of billing cycles to prebill.
-         */
-        iterations: number;
-        /**
-         * Whether to cancel or preserve `prebilling` if the subscription is updated during the prebilled period. The default value is `reset`.
-         */
-        update_behavior?: Prebilling.UpdateBehavior;
-    }
     type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
     interface TransferData {
         /**
@@ -2404,10 +2107,6 @@ export declare namespace SubscriptionUpdateParams {
              * 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.
              */
@@ -2445,38 +2144,6 @@ export declare namespace SubscriptionUpdateParams {
              */
             unit_amount_decimal?: Decimal;
         }
-        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 Period {
             interface End {
                 /**
@@ -2569,39 +2236,17 @@ export declare namespace SubscriptionUpdateParams {
     namespace CancellationDetails {
         type Feedback = 'customer_service' | 'low_quality' | 'missing_features' | 'other' | 'switched_service' | 'too_complex' | 'too_expensive' | 'unused';
     }
-    namespace Discount {
-        interface DiscountEnd {
+    namespace InvoiceSettings {
+        interface CustomField {
             /**
-             * Time span for the redeemed discount.
+             * The name of the custom field. This may be up to 40 characters.
              */
-            duration?: DiscountEnd.Duration;
+            name: string;
             /**
-             * A precise Unix timestamp for the discount to end. Must be in the future.
+             * The value of the custom field. This may be up to 140 characters.
              */
-            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';
-            }
+            value: string;
         }
-    }
-    namespace InvoiceSettings {
         interface Issuer {
             /**
              * The connected account being referenced when `type` is `account`.
@@ -2623,16 +2268,6 @@ export declare namespace SubscriptionUpdateParams {
              */
             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.
@@ -2642,10 +2277,6 @@ export declare namespace SubscriptionUpdateParams {
              * 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.
              */
@@ -2677,38 +2308,6 @@ export declare namespace SubscriptionUpdateParams {
              */
             unit_amount_decimal?: Decimal;
         }
-        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 {
                 /**
@@ -2739,10 +2338,6 @@ export declare namespace SubscriptionUpdateParams {
              * This sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
              */
             bancontact?: Emptyable<PaymentMethodOptions.Bancontact>;
-            /**
-             * This sub-hash contains details about the Blik payment method options to pass to the invoice's PaymentIntent.
-             */
-            blik?: Emptyable<PaymentMethodOptions.Blik>;
             /**
              * This sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
              */
@@ -2751,10 +2346,6 @@ export declare namespace SubscriptionUpdateParams {
              * This sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
              */
             customer_balance?: Emptyable<PaymentMethodOptions.CustomerBalance>;
-            /**
-             * This sub-hash contains details about the Indonesia bank transfer payment method options to pass to the invoice's PaymentIntent.
-             */
-            id_bank_transfer?: Emptyable<PaymentMethodOptions.IdBankTransfer>;
             /**
              * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
              */
@@ -2780,7 +2371,7 @@ export declare namespace SubscriptionUpdateParams {
              */
             us_bank_account?: Emptyable<PaymentMethodOptions.UsBankAccount>;
         }
-        type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'blik' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'id_bank_transfer' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'stripe_balance' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
+        type PaymentMethodType = 'ach_credit_transfer' | 'ach_debit' | 'acss_debit' | 'affirm' | 'amazon_pay' | 'au_becs_debit' | 'bacs_debit' | 'bancontact' | 'boleto' | 'card' | 'cashapp' | 'crypto' | 'custom' | 'customer_balance' | 'eps' | 'fpx' | 'giropay' | 'grabpay' | 'ideal' | 'jp_credit_transfer' | 'kakao_pay' | 'klarna' | 'konbini' | 'kr_card' | 'link' | 'multibanco' | 'naver_pay' | 'nz_bank_account' | 'p24' | 'pay_by_bank' | 'payco' | 'paynow' | 'paypal' | 'payto' | 'pix' | 'promptpay' | 'revolut_pay' | 'satispay' | 'sepa_credit_transfer' | 'sepa_debit' | 'sofort' | 'swish' | 'twint' | 'upi' | 'us_bank_account' | 'wechat_pay';
         type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
         namespace PaymentMethodOptions {
             interface AcssDebit {
@@ -2799,12 +2390,6 @@ export declare namespace SubscriptionUpdateParams {
                  */
                 preferred_language?: Bancontact.PreferredLanguage;
             }
-            interface Blik {
-                /**
-                 * Configuration options for setting up a mandate
-                 */
-                mandate_options?: Blik.MandateOptions;
-            }
             interface Card {
                 /**
                  * Configuration options for setting up an eMandate for cards issued in India.
@@ -2829,8 +2414,6 @@ export declare namespace SubscriptionUpdateParams {
                  */
                 funding_type?: string;
             }
-            interface IdBankTransfer {
-            }
             interface Konbini {
             }
             interface Payto {
@@ -2882,14 +2465,6 @@ export declare namespace SubscriptionUpdateParams {
             namespace Bancontact {
                 type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
             }
-            namespace Blik {
-                interface MandateOptions {
-                    /**
-                     * Date when the mandate expires and no further payments will be charged. If not provided, the mandate will be set to be indefinite.
-                     */
-                    expires_after?: number;
-                }
-            }
             namespace Card {
                 interface MandateOptions {
                     /**
@@ -3015,13 +2590,9 @@ export declare namespace SubscriptionUpdateParams {
                          * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                          */
                         account_subcategories?: Array<Filters.AccountSubcategory>;
-                        /**
-                         * ID of the institution to use to filter for selectable accounts.
-                         */
-                        institution?: string;
                     }
                     type Permission = 'balances' | 'ownership' | 'payment_method' | 'transactions';
-                    type Prefetch = 'balances' | 'inferred_balances' | 'ownership' | 'transactions';
+                    type Prefetch = 'balances' | 'ownership' | 'transactions';
                     namespace Filters {
                         type AccountSubcategory = 'checking' | 'savings';
                     }
@@ -3032,22 +2603,14 @@ export declare namespace SubscriptionUpdateParams {
     namespace PendingInvoiceItemInterval {
         type Interval = 'day' | 'month' | 'week' | 'year';
     }
-    namespace Prebilling {
-        type UpdateBehavior = 'prebill' | 'reset';
-    }
     namespace TrialSettings {
         interface EndBehavior {
-            /**
-             * Indicates how the subscription's billing cycle anchor is reset when a trial ends. Defaults to `now`.
-             */
-            billing_cycle_anchor?: EndBehavior.BillingCycleAnchor;
             /**
              * Indicates how the subscription should change when the trial ends if the user did not provide a payment method.
              */
             missing_payment_method: EndBehavior.MissingPaymentMethod;
         }
         namespace EndBehavior {
-            type BillingCycleAnchor = 'now' | 'unchanged';
             type MissingPaymentMethod = 'cancel' | 'create_invoice' | 'pause';
         }
     }
@@ -3180,57 +2743,6 @@ export declare namespace SubscriptionMigrateParams {
         }
     }
 }
-export interface SubscriptionPauseParams {
-    /**
-     * Controls what to bill for when pausing the subscription.
-     */
-    bill_for?: SubscriptionPauseParams.BillFor;
-    /**
-     * Specifies which fields in the response should be expanded.
-     */
-    expand?: Array<string>;
-    /**
-     * Determines how to handle debits and credits when pausing. The default is `pending_invoice_item`.
-     */
-    invoicing_behavior?: SubscriptionPauseParams.InvoicingBehavior;
-    /**
-     * The type of pause to apply. Defaults to `subscription`.
-     */
-    type?: 'subscription';
-}
-export declare namespace SubscriptionPauseParams {
-    interface BillFor {
-        /**
-         * Controls when to bill for metered usage in the current period. Defaults to `{ type: "now" }`.
-         */
-        outstanding_usage_through?: BillFor.OutstandingUsageThrough;
-        /**
-         * Controls when to credit for unused time on licensed items. Defaults to `{ type: "now" }`.
-         */
-        unused_time_from?: BillFor.UnusedTimeFrom;
-    }
-    type InvoicingBehavior = 'invoice' | 'pending_invoice_item';
-    namespace BillFor {
-        interface OutstandingUsageThrough {
-            /**
-             * When to bill metered usage in the current period.
-             */
-            type: OutstandingUsageThrough.Type;
-        }
-        interface UnusedTimeFrom {
-            /**
-             * When to credit for unused time.
-             */
-            type: UnusedTimeFrom.Type;
-        }
-        namespace OutstandingUsageThrough {
-            type Type = 'none' | 'now';
-        }
-        namespace UnusedTimeFrom {
-            type Type = 'item_current_period_start' | 'none' | 'now';
-        }
-    }
-}
 export interface SubscriptionResumeParams {
     /**
      * The billing cycle anchor that applies when the subscription is resumed. Either `now` or `unchanged`. The default is `now`. For more information, see the billing cycle [documentation](https://docs.stripe.com/billing/subscriptions/billing-cycle).
@@ -3240,10 +2752,6 @@ export interface SubscriptionResumeParams {
      * Specifies which fields in the response should be expanded.
      */
     expand?: Array<string>;
-    /**
-     * Controls whether Stripe attempts payment on the resumption invoice in the resume request, and how payment on that invoice affects the subscription's status. The default is `resume_on_payment_attempt`.
-     */
-    payment_behavior?: SubscriptionResumeParams.PaymentBehavior;
     /**
      * Determines how to handle [prorations](https://docs.stripe.com/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor` being `unchanged`. When the `billing_cycle_anchor` is set to `now` (default value), no prorations are generated. If no value is passed, the default is `create_prorations`.
      */
@@ -3255,7 +2763,6 @@ export interface SubscriptionResumeParams {
 }
 export declare namespace SubscriptionResumeParams {
     type BillingCycleAnchor = 'now' | 'unchanged';
-    type PaymentBehavior = 'resume_on_payment_attempt' | 'resume_on_payment_success';
     type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';
 }
 export interface SubscriptionSearchParams {
@@ -3276,9 +2783,3 @@ export interface SubscriptionSearchParams {
      */
     page?: string;
 }
-export interface SubscriptionSerializeBatchCancelParams {
-}
-export interface SubscriptionSerializeBatchMigrateParams {
-}
-export interface SubscriptionSerializeBatchUpdateParams {
-}