FM / types

/home/techb158/balavpn.abdallabala.com/node_modules/stripe/types/

/home/techb158/balavpn.abdallabala.com/node_modules/stripe/types

Name	Size	Mode	Actions
Apps/	-	0777	rm
Billing/	-	0777	rm
BillingPortal/	-	0777	rm
Checkout/	-	0777	rm
Climate/	-	0777	rm
crypto/	-	0777	rm
Entitlements/	-	0777	rm
FinancialConnections/	-	0777	rm
Forwarding/	-	0777	rm
Identity/	-	0777	rm
Issuing/	-	0777	rm
net/	-	0777	rm
Radar/	-	0777	rm
Reporting/	-	0777	rm
Sigma/	-	0777	rm
Tax/	-	0777	rm
Terminal/	-	0777	rm
test/	-	0777	rm
TestHelpers/	-	0777	rm
Treasury/	-	0777	rm
V2/	-	0777	rm
.eslintrc.js	620	0666	edit dl rm
AccountLinks.d.ts	893	0666	edit dl rm
AccountLinksResource.d.ts	2898	0666	edit dl rm
Accounts.d.ts	63448	0666	edit dl rm
AccountSessions.d.ts	17282	0666	edit dl rm
AccountSessionsResource.d.ts	19316	0666	edit dl rm
AccountsResource.d.ts	181754	0666	edit dl rm
ApplePayDomains.d.ts	1241	0666	edit dl rm
ApplePayDomainsResource.d.ts	1962	0666	edit dl rm
ApplicationFees.d.ts	3040	0666	edit dl rm
ApplicationFeesResource.d.ts	6115	0666	edit dl rm
Applications.d.ts	1064	0666	edit dl rm
Balance.d.ts	8675	0666	edit dl rm
BalanceResource.d.ts	817	0666	edit dl rm
BalanceTransactions.d.ts	6553	0666	edit dl rm
BalanceTransactionSources.d.ts	499	0666	edit dl rm
BalanceTransactionsResource.d.ts	3247	0666	edit dl rm
BankAccounts.d.ts	18753	0666	edit dl rm
Capabilities.d.ts	17891	0666	edit dl rm
Cards.d.ts	8674	0666	edit dl rm
CashBalances.d.ts	1711	0666	edit dl rm
Charges.d.ts	81258	0666	edit dl rm
ChargesResource.d.ts	19232	0666	edit dl rm
ConfirmationTokens.d.ts	54015	0666	edit dl rm
ConfirmationTokensResource.d.ts	698	0666	edit dl rm
ConnectCollectionTransfers.d.ts	1063	0666	edit dl rm
CountrySpecs.d.ts	2759	0666	edit dl rm
CountrySpecsResource.d.ts	1145	0666	edit dl rm
Coupons.d.ts	4525	0666	edit dl rm
CouponsResource.d.ts	7997	0666	edit dl rm
CreditNoteLineItems.d.ts	5515	0666	edit dl rm
CreditNotes.d.ts	10417	0666	edit dl rm
CreditNotesResource.d.ts	21683	0666	edit dl rm
CustomerBalanceTransactions.d.ts	3534	0666	edit dl rm
CustomerCashBalanceTransactions.d.ts	7655	0666	edit dl rm
Customers.d.ts	10312	0666	edit dl rm
CustomerSessions.d.ts	6659	0666	edit dl rm
CustomerSessionsResource.d.ts	5543	0666	edit dl rm
CustomerSources.d.ts	227	0666	edit dl rm
CustomersResource.d.ts	49272	0666	edit dl rm
Deprecations.d.ts	6759	0666	edit dl rm
Discounts.d.ts	5697	0666	edit dl rm
Disputes.d.ts	18934	0666	edit dl rm
DisputesResource.d.ts	15462	0666	edit dl rm
EphemeralKeys.d.ts	975	0666	edit dl rm
EphemeralKeysResource.d.ts	1793	0666	edit dl rm
Errors.d.ts	9706	0666	edit dl rm
Events.d.ts	14107	0666	edit dl rm
EventsResource.d.ts	2309	0666	edit dl rm
EventTypes.d.ts	120304	0666	edit dl rm
ExchangeRates.d.ts	2348	0666	edit dl rm
ExchangeRatesResource.d.ts	1294	0666	edit dl rm
ExternalAccounts.d.ts	210	0666	edit dl rm
FeeRefunds.d.ts	1730	0666	edit dl rm
FileLinks.d.ts	1529	0666	edit dl rm
FileLinksResource.d.ts	3788	0666	edit dl rm
Files.d.ts	2560	0666	edit dl rm
FilesResource.d.ts	4886	0666	edit dl rm
FundingInstructions.d.ts	7588	0666	edit dl rm
index.d.ts	26330	0666	edit dl rm
InvoiceItems.d.ts	5720	0666	edit dl rm
InvoiceItemsResource.d.ts	16679	0666	edit dl rm
InvoiceLineItems.d.ts	8170	0666	edit dl rm
InvoiceRenderingTemplates.d.ts	1735	0666	edit dl rm
InvoiceRenderingTemplatesResource.d.ts	3109	0666	edit dl rm
Invoices.d.ts	59291	0666	edit dl rm
InvoicesResource.d.ts	272335	0666	edit dl rm
lib.d.ts	9208	0666	edit dl rm
LineItems.d.ts	3747	0666	edit dl rm
LoginLinks.d.ts	805	0666	edit dl rm
Mandates.d.ts	6963	0666	edit dl rm
MandatesResource.d.ts	629	0666	edit dl rm
OAuth.d.ts	13056	0666	edit dl rm
PaymentIntents.d.ts	126400	0666	edit dl rm
PaymentIntentsResource.d.ts	425657	0666	edit dl rm
PaymentLinks.d.ts	26988	0666	edit dl rm
PaymentLinksResource.d.ts	61599	0666	edit dl rm
PaymentMethodConfigurations.d.ts	46290	0666	edit dl rm
PaymentMethodConfigurationsResource.d.ts	82027	0666	edit dl rm
PaymentMethodDomains.d.ts	5253	0666	edit dl rm
PaymentMethodDomainsResource.d.ts	4080	0666	edit dl rm
PaymentMethods.d.ts	48133	0666	edit dl rm
PaymentMethodsResource.d.ts	31934	0666	edit dl rm
Payouts.d.ts	6830	0666	edit dl rm
PayoutsResource.d.ts	8033	0666	edit dl rm
Persons.d.ts	28323	0666	edit dl rm
Plans.d.ts	7540	0666	edit dl rm
PlansResource.d.ts	11964	0666	edit dl rm
Prices.d.ts	12348	0666	edit dl rm
PricesResource.d.ts	23771	0666	edit dl rm
ProductFeatures.d.ts	1595	0666	edit dl rm
Products.d.ts	5225	0666	edit dl rm
ProductsResource.d.ts	22445	0666	edit dl rm
PromotionCodes.d.ts	4009	0666	edit dl rm
PromotionCodesResource.d.ts	7472	0666	edit dl rm
Quotes.d.ts	22541	0666	edit dl rm
QuotesResource.d.ts	32380	0666	edit dl rm
Refunds.d.ts	12150	0666	edit dl rm
RefundsResource.d.ts	6972	0666	edit dl rm
ReserveTransactions.d.ts	812	0666	edit dl rm
Reviews.d.ts	3939	0666	edit dl rm
ReviewsResource.d.ts	1895	0666	edit dl rm
SetupAttempts.d.ts	30914	0666	edit dl rm
SetupAttemptsResource.d.ts	972	0666	edit dl rm
SetupIntents.d.ts	35147	0666	edit dl rm
SetupIntentsResource.d.ts	130075	0666	edit dl rm
shared.d.ts	4263	0666	edit dl rm
ShippingRates.d.ts	4744	0666	edit dl rm
ShippingRatesResource.d.ts	8383	0666	edit dl rm
SourceMandateNotifications.d.ts	3491	0666	edit dl rm
Sources.d.ts	20443	0666	edit dl rm
SourcesResource.d.ts	19833	0666	edit dl rm
SourceTransactions.d.ts	5248	0666	edit dl rm
SubscriptionItems.d.ts	4653	0666	edit dl rm
SubscriptionItemsResource.d.ts	23230	0666	edit dl rm
Subscriptions.d.ts	30567	0666	edit dl rm
SubscriptionSchedules.d.ts	23402	0666	edit dl rm
SubscriptionSchedulesResource.d.ts	61127	0666	edit dl rm
SubscriptionsResource.d.ts	88064	0666	edit dl rm
TaxCodes.d.ts	685	0666	edit dl rm
TaxCodesResource.d.ts	1291	0666	edit dl rm
TaxDeductedAtSources.d.ts	886	0666	edit dl rm
TaxIds.d.ts	6322	0666	edit dl rm
TaxIdsResource.d.ts	6265	0666	edit dl rm
TaxRates.d.ts	5056	0666	edit dl rm
TaxRatesResource.d.ts	6537	0666	edit dl rm
ThinEvent.d.ts	847	0666	edit dl rm
Tokens.d.ts	3363	0666	edit dl rm
TokensResource.d.ts	34353	0666	edit dl rm
Topups.d.ts	3284	0666	edit dl rm
TopupsResource.d.ts	5249	0666	edit dl rm
TransferReversals.d.ts	2543	0666	edit dl rm
Transfers.d.ts	3676	0666	edit dl rm
TransfersResource.d.ts	10601	0666	edit dl rm
UpcomingInvoices.d.ts	108	0666	edit dl rm
UsageRecords.d.ts	1261	0666	edit dl rm
UsageRecordSummaries.d.ts	1474	0666	edit dl rm
WebhookEndpoints.d.ts	2865	0666	edit dl rm
WebhookEndpointsResource.d.ts	26655	0666	edit dl rm
Webhooks.d.ts	4627	0666	edit dl rm

Edit: /home/techb158/balavpn.abdallabala.com/node_modules/stripe/types/SubscriptionsResource.d.ts (88064B)

// File generated from our OpenAPI spec

declare module 'stripe' {
  namespace Stripe {
    interface SubscriptionCreateParams {
      /**
       * The identifier of the customer to subscribe.
       */
      customer: string;

/**
       * A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
       */
      add_invoice_items?: Array<SubscriptionCreateParams.AddInvoiceItem>;

/**
       * 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 application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).
       */
      application_fee_percent?: Stripe.Emptyable<number>;

/**
       * Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
       */
      automatic_tax?: SubscriptionCreateParams.AutomaticTax;

/**
       * For new subscriptions, a past timestamp to backdate the subscription's start date to. If set, the first invoice will contain a proration for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.
       */
      backdate_start_date?: number;

/**
       * A future timestamp in UTC format to anchor the subscription's [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle). The anchor is the reference point that aligns future 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.
       */
      billing_cycle_anchor?: number;

/**
       * Mutually exclusive with billing_cycle_anchor and only valid with monthly and yearly price intervals. When provided, the billing_cycle_anchor is set to the next occurence of the day_of_month at the hour, minute, and second UTC.
       */
      billing_cycle_anchor_config?: SubscriptionCreateParams.BillingCycleAnchorConfig;

/**
       * 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?: Stripe.Emptyable<
        SubscriptionCreateParams.BillingThresholds
      >;

/**
       * A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.
       */
      cancel_at?: number;

/**
       * Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
       */
      cancel_at_period_end?: boolean;

/**
       * Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`.
       */
      collection_method?: SubscriptionCreateParams.CollectionMethod;

/**
       * The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
       */
      coupon?: string;

/**
       * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
       */
      currency?: string;

/**
       * Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `collection_method` is set to `send_invoice`.
       */
      days_until_due?: number;

/**
       * ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
       */
      default_payment_method?: string;

/**
       * ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).
       */
      default_source?: string;

/**
       * The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.
       */
      default_tax_rates?: Stripe.Emptyable<Array<string>>;

/**
       * The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.
       */
      description?: string;

/**
       * The coupons to redeem into discounts for the subscription. If not specified or empty, inherits the discount from the subscription's customer.
       */
      discounts?: Stripe.Emptyable<Array<SubscriptionCreateParams.Discount>>;

/**
       * Specifies which fields in the response should be expanded.
       */
      expand?: Array<string>;

/**
       * All invoices will be billed using the specified settings.
       */
      invoice_settings?: SubscriptionCreateParams.InvoiceSettings;

/**
       * A list of up to 20 subscription items, each with an attached price.
       */
      items?: Array<SubscriptionCreateParams.Item>;

/**
       * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
       */
      metadata?: Stripe.Emptyable<Stripe.MetadataParam>;

/**
       * Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
       */
      off_session?: boolean;

/**
       * The account on behalf of which to charge, for each of the subscription's invoices.
       */
      on_behalf_of?: Stripe.Emptyable<string>;

/**
       * Only applies to subscriptions with `collection_method=charge_automatically`.
       *
       * Use `allow_incomplete` to create Subscriptions with `status=incomplete` if the first invoice can't be paid. Creating Subscriptions with this status allows you to manage scenarios where additional customer actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
       *
       * Use `default_incomplete` to create Subscriptions with `status=incomplete` when the first invoice requires payment, otherwise start as active. Subscriptions transition to `status=active` when successfully confirming the PaymentIntent on the first invoice. This allows simpler management of scenarios where additional customer actions are needed to pay a subscription's invoice, such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method. If the PaymentIntent is not confirmed within 23 hours Subscriptions transition to `status=incomplete_expired`, which is a terminal state.
       *
       * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's first invoice can't be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further customer action is needed, this parameter doesn't create a Subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
       *
       * `pending_if_incomplete` is only used with updates and cannot be passed when creating a Subscription.
       *
       * Subscriptions with `collection_method=send_invoice` are automatically activated regardless of the first Invoice status.
       */
      payment_behavior?: SubscriptionCreateParams.PaymentBehavior;

/**
       * Payment settings to pass to invoices created by the subscription.
       */
      payment_settings?: SubscriptionCreateParams.PaymentSettings;

/**
       * Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval.
       */
      pending_invoice_item_interval?: Stripe.Emptyable<
        SubscriptionCreateParams.PendingInvoiceItemInterval
      >;

/**
       * The promotion code to apply to this subscription. A promotion code applied to a subscription will only affect invoices created for that particular subscription. This field has been deprecated and will be removed in a future API version. Use `discounts` instead.
       */
      promotion_code?: string;

/**
       * Determines how to handle [prorations](https://stripe.com/docs/billing/subscriptions/prorations) resulting from the `billing_cycle_anchor`. If no value is passed, the default is `create_prorations`.
       */
      proration_behavior?: SubscriptionCreateParams.ProrationBehavior;

/**
       * If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.
       */
      transfer_data?: SubscriptionCreateParams.TransferData;

/**
       * Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
       */
      trial_end?: 'now' | number;

/**
       * Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
       */
      trial_from_plan?: boolean;

/**
       * Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more.
       */
      trial_period_days?: number;

/**
       * Settings related to subscription trials.
       */
      trial_settings?: SubscriptionCreateParams.TrialSettings;
    }

namespace SubscriptionCreateParams {
      interface AddInvoiceItem {
        /**
         * The coupons to redeem into discounts for the item.
         */
        discounts?: Array<AddInvoiceItem.Discount>;

/**
         * The ID of the price object. One of `price` or `price_data` is required.
         */
        price?: string;

/**
         * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline. One of `price` or `price_data` is required.
         */
        price_data?: AddInvoiceItem.PriceData;

/**
         * Quantity for this item. Defaults to 1.
         */
        quantity?: number;

/**
         * The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item.
         */
        tax_rates?: Stripe.Emptyable<Array<string>>;
      }

namespace AddInvoiceItem {
        interface Discount {
          /**
           * ID of the coupon to create a new discount for.
           */
          coupon?: string;

/**
           * ID of an existing discount on the object (or one of its ancestors) to reuse.
           */
          discount?: string;

/**
           * ID of the promotion code to create a new discount for.
           */
          promotion_code?: string;
        }

interface PriceData {
          /**
           * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
           */
          currency: string;

/**
           * The ID of the product that this price will belong to.
           */
          product: string;

/**
           * Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
           */
          tax_behavior?: PriceData.TaxBehavior;

/**
           * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge or a negative integer representing the amount to credit to the customer.
           */
          unit_amount?: number;

/**
           * Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
           */
          unit_amount_decimal?: string;
        }

namespace PriceData {
          type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
        }
      }

interface AutomaticTax {
        /**
         * Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.
         */
        enabled: boolean;

/**
         * The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.
         */
        liability?: AutomaticTax.Liability;
      }

namespace AutomaticTax {
        interface Liability {
          /**
           * The connected account being referenced when `type` is `account`.
           */
          account?: string;

/**
           * Type of the account referenced in the request.
           */
          type: Liability.Type;
        }

namespace Liability {
          type Type = 'account' | 'self';
        }
      }

interface BillingCycleAnchorConfig {
        /**
         * The day of the month the billing_cycle_anchor should be. Ranges from 1 to 31.
         */
        day_of_month: number;

/**
         * The hour of the day the billing_cycle_anchor should be. Ranges from 0 to 23.
         */
        hour?: number;

/**
         * The minute of the hour the billing_cycle_anchor should be. Ranges from 0 to 59.
         */
        minute?: number;

/**
         * The month to start full cycle billing periods. Ranges from 1 to 12.
         */
        month?: number;

/**
         * The second of the minute the billing_cycle_anchor should be. Ranges from 0 to 59.
         */
        second?: number;
      }

interface BillingThresholds {
        /**
         * Monetary threshold that triggers the subscription to advance to a new billing period
         */
        amount_gte?: number;

/**
         * Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.
         */
        reset_billing_cycle_anchor?: boolean;
      }

type CollectionMethod = 'charge_automatically' | 'send_invoice';

interface Discount {
        /**
         * ID of the coupon to create a new discount for.
         */
        coupon?: string;

/**
         * ID of an existing discount on the object (or one of its ancestors) to reuse.
         */
        discount?: string;

/**
         * ID of the promotion code to create a new discount for.
         */
        promotion_code?: string;
      }

interface InvoiceSettings {
        /**
         * The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription.
         */
        account_tax_ids?: Stripe.Emptyable<Array<string>>;

/**
         * The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.
         */
        issuer?: InvoiceSettings.Issuer;
      }

namespace InvoiceSettings {
        interface Issuer {
          /**
           * The connected account being referenced when `type` is `account`.
           */
          account?: string;

/**
           * Type of the account referenced in the request.
           */
          type: Issuer.Type;
        }

namespace Issuer {
          type Type = 'account' | 'self';
        }
      }

interface Item {
        /**
         * Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. When updating, pass an empty string to remove previously-defined thresholds.
         */
        billing_thresholds?: Stripe.Emptyable<Item.BillingThresholds>;

/**
         * The coupons to redeem into discounts for the subscription item.
         */
        discounts?: Stripe.Emptyable<Array<Item.Discount>>;

/**
         * Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
         */
        metadata?: Stripe.MetadataParam;

/**
         * Plan ID for this item, as a string.
         */
        plan?: string;

/**
         * The ID of the price object.
         */
        price?: string;

/**
         * Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.
         */
        price_data?: Item.PriceData;

/**
         * Quantity for this item.
         */
        quantity?: number;

/**
         * 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>>;
      }

namespace Item {
        interface BillingThresholds {
          /**
           * Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 [monetary threshold](https://stripe.com/docs/api/subscriptions/update#update_subscription-billing_thresholds-amount_gte))
           */
          usage_gte: number;
        }

interface Discount {
          /**
           * ID of the coupon to create a new discount for.
           */
          coupon?: string;

/**
           * ID of an existing discount on the object (or one of its ancestors) to reuse.
           */
          discount?: string;

/**
           * ID of the promotion code to create a new discount for.
           */
          promotion_code?: string;
        }

/**
           * The ID of the product that this price will belong to.
           */
          product: string;

/**
           * The recurring components of a price such as `interval` and `interval_count`.
           */
          recurring: PriceData.Recurring;

/**
           * A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
           */
          unit_amount?: number;

namespace PriceData {
          interface Recurring {
            /**
             * Specifies billing frequency. Either `day`, `week`, `month` or `year`.
             */
            interval: Recurring.Interval;

/**
             * The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
             */
            interval_count?: number;
          }

namespace Recurring {
            type Interval = 'day' | 'month' | 'week' | 'year';
          }

type TaxBehavior = 'exclusive' | 'inclusive' | 'unspecified';
        }
      }

type PaymentBehavior =
        | 'allow_incomplete'
        | 'default_incomplete'
        | 'error_if_incomplete'
        | 'pending_if_incomplete';

interface PaymentSettings {
        /**
         * Payment-method-specific configuration to provide to invoices created by the subscription.
         */
        payment_method_options?: PaymentSettings.PaymentMethodOptions;

/**
         * The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice). Should not be specified with payment_method_configuration
         */
        payment_method_types?: Stripe.Emptyable<
          Array<PaymentSettings.PaymentMethodType>
        >;

/**
         * Configure whether Stripe updates `subscription.default_payment_method` when payment succeeds. Defaults to `off` if unspecified.
         */
        save_default_payment_method?: PaymentSettings.SaveDefaultPaymentMethod;
      }

namespace PaymentSettings {
        interface PaymentMethodOptions {
          /**
           * This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice's PaymentIntent.
           */
          acss_debit?: Stripe.Emptyable<PaymentMethodOptions.AcssDebit>;

/**
           * This sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
           */
          bancontact?: Stripe.Emptyable<PaymentMethodOptions.Bancontact>;

/**
           * This sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
           */
          card?: Stripe.Emptyable<PaymentMethodOptions.Card>;

/**
           * This sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
           */
          customer_balance?: Stripe.Emptyable<
            PaymentMethodOptions.CustomerBalance
          >;

/**
           * This sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
           */
          konbini?: Stripe.Emptyable<PaymentMethodOptions.Konbini>;

/**
           * This sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice's PaymentIntent.
           */
          sepa_debit?: Stripe.Emptyable<PaymentMethodOptions.SepaDebit>;

/**
           * This sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
           */
          us_bank_account?: Stripe.Emptyable<
            PaymentMethodOptions.UsBankAccount
          >;
        }

namespace PaymentMethodOptions {
          interface AcssDebit {
            /**
             * Additional fields for Mandate creation
             */
            mandate_options?: AcssDebit.MandateOptions;

/**
             * Verification method for the intent
             */
            verification_method?: AcssDebit.VerificationMethod;
          }

namespace AcssDebit {
            interface MandateOptions {
              /**
               * Transaction type of the mandate.
               */
              transaction_type?: MandateOptions.TransactionType;
            }

namespace MandateOptions {
              type TransactionType = 'business' | 'personal';
            }

type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
          }

interface Bancontact {
            /**
             * Preferred language of the Bancontact authorization page that the customer is redirected to.
             */
            preferred_language?: Bancontact.PreferredLanguage;
          }

namespace Bancontact {
            type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
          }

interface Card {
            /**
             * Configuration options for setting up an eMandate for cards issued in India.
             */
            mandate_options?: Card.MandateOptions;

/**
             * Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time.
             */
            network?: Card.Network;

/**
             * We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
             */
            request_three_d_secure?: Card.RequestThreeDSecure;
          }

namespace Card {
            interface MandateOptions {
              /**
               * Amount to be charged for future payments.
               */
              amount?: number;

/**
               * 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;

/**
               * A description of the mandate or subscription that is meant to be displayed to the customer.
               */
              description?: string;
            }

namespace MandateOptions {
              type AmountType = 'fixed' | 'maximum';
            }

type RequestThreeDSecure = 'any' | 'automatic' | 'challenge';
          }

interface CustomerBalance {
            /**
             * Configuration for the bank transfer funding type, if the `funding_type` is set to `bank_transfer`.
             */
            bank_transfer?: CustomerBalance.BankTransfer;

/**
             * The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
             */
            funding_type?: string;
          }

namespace CustomerBalance {
            interface BankTransfer {
              /**
               * Configuration for eu_bank_transfer funding type.
               */
              eu_bank_transfer?: BankTransfer.EuBankTransfer;

/**
               * The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
               */
              type?: string;
            }

namespace BankTransfer {
              interface EuBankTransfer {
                /**
                 * The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
                 */
                country: string;
              }
            }
          }

interface Konbini {}

interface SepaDebit {}

interface UsBankAccount {
            /**
             * Additional fields for Financial Connections Session creation
             */
            financial_connections?: UsBankAccount.FinancialConnections;

/**
             * Verification method for the intent
             */
            verification_method?: UsBankAccount.VerificationMethod;
          }

namespace UsBankAccount {
            interface FinancialConnections {
              /**
               * Provide filters for the linked accounts that the customer can select for the payment method.
               */
              filters?: FinancialConnections.Filters;

/**
               * The list of permissions to request. If this parameter is passed, the `payment_method` permission must be included. Valid permissions include: `balances`, `ownership`, `payment_method`, and `transactions`.
               */
              permissions?: Array<FinancialConnections.Permission>;

/**
               * List of data features that you would like to retrieve upon account creation.
               */
              prefetch?: Array<FinancialConnections.Prefetch>;
            }

namespace FinancialConnections {
              interface Filters {
                /**
                 * The account subcategories to use to filter for selectable accounts. Valid subcategories are `checking` and `savings`.
                 */
                account_subcategories?: Array<Filters.AccountSubcategory>;
              }

namespace Filters {
                type AccountSubcategory = 'checking' | 'savings';
              }

type Permission =
                | 'balances'
                | 'ownership'
                | 'payment_method'
                | 'transactions';

type Prefetch = 'balances' | 'ownership' | 'transactions';
            }

type VerificationMethod = 'automatic' | 'instant' | 'microdeposits';
          }
        }

type SaveDefaultPaymentMethod = 'off' | 'on_subscription';
      }

interface PendingInvoiceItemInterval {
        /**
         * Specifies invoicing frequency. Either `day`, `week`, `month` or `year`.
         */
        interval: PendingInvoiceItemInterval.Interval;

/**
         * The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).
         */
        interval_count?: number;
      }

namespace PendingInvoiceItemInterval {
        type Interval = 'day' | 'month' | 'week' | 'year';
      }

type ProrationBehavior = 'always_invoice' | 'create_prorations' | 'none';

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.
         */
        amount_percent?: number;

/**
         * ID of an existing, connected Stripe account.
         */
        destination: string;
      }

interface TrialSettings {
        /**
         * Defines how the subscription should behave when the user's free trial ends.
         */
        end_behavior: TrialSettings.EndBehavior;
      }

namespace TrialSettings {
        interface EndBehavior {
          /**
           * 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 MissingPaymentMethod = 'cancel' | 'create_invoice' | 'pause';
        }
      }
    }

interface SubscriptionRetrieveParams {
      /**
       * Specifies which fields in the response should be expanded.
       */
      expand?: Array<string>;
    }

interface SubscriptionUpdateParams {
      /**
       * A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.
       */
      add_invoice_items?: Array<SubscriptionUpdateParams.AddInvoiceItem>;

/**
       * Automatic tax settings for this subscription. We recommend you only include this parameter when the existing value is being changed.
       */
      automatic_tax?: SubscriptionUpdateParams.AutomaticTax;

/**
       * Either `now` or `unchanged`. Setting the value to `now` resets the subscription's billing cycle anchor to the current time (in UTC). For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle).
       */
      billing_cycle_anchor?: SubscriptionUpdateParams.BillingCycleAnchor;

/**
       * Indicate whether this subscription should cancel at the end of the current period (`current_period_end`). Defaults to `false`.
       */
      cancel_at_period_end?: boolean;

/**
       * Details about why this subscription was cancelled
       */
      cancellation_details?: SubscriptionUpdateParams.CancellationDetails;

/**
       * The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription. Pass an empty string to remove previously-defined tax rates.
       */
      default_tax_rates?: Stripe.Emptyable<Array<string>>;

/**
       * Specifies which fields in the response should be expanded.
       */
      expand?: Array<string>;

/**
       * All invoices will be billed using the specified settings.
       */
      invoice_settings?: SubscriptionUpdateParams.InvoiceSettings;

/**
       * A list of up to 20 subscription items, each with an attached price.
       */
      items?: Array<SubscriptionUpdateParams.Item>;

/**
       * Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `false` (on-session).
       */
      off_session?: boolean;

/**
       * The account on behalf of which to charge, for each of the subscription's invoices.
       */
      on_behalf_of?: Stripe.Emptyable<string>;

/**
       * 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?: Stripe.Emptyable<
        SubscriptionUpdateParams.PauseCollection
      >;

/**
       * Use `allow_incomplete` to transition the subscription to `status=past_due` if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription's invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication) for Billing to learn more. This is the default behavior.
       *
       * Use `default_incomplete` to transition the subscription to `status=past_due` when payment is required and await explicit confirmation of the invoice's payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription's invoice. Such as failed payments, [SCA regulation](https://stripe.com/docs/billing/migration/strong-customer-authentication), or collecting a mandate for a bank debit payment method.
       *
       * Use `pending_if_incomplete` to update the subscription using [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates). When you use `pending_if_incomplete` you can only pass the parameters [supported by pending updates](https://stripe.com/docs/billing/pending-updates-reference#supported-attributes).
       *
       * Use `error_if_incomplete` if you want Stripe to return an HTTP 402 status code if a subscription's invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the [changelog](https://stripe.com/docs/upgrades#2019-03-14) to learn more.
       */
      payment_behavior?: SubscriptionUpdateParams.PaymentBehavior;

/**
       * Payment settings to pass to invoices created by the subscription.
       */
      payment_settings?: SubscriptionUpdateParams.PaymentSettings;

/**
       * Determines how to handle [prorations](https://stripe.com/docs/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`.
       */
      proration_behavior?: SubscriptionUpdateParams.ProrationBehavior;

/**
       * If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same proration that was previewed with [upcoming invoice](https://stripe.com/docs/api#upcoming_invoice) endpoint. It can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.
       */
      proration_date?: number;

/**
       * If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges. This will be unset if you POST an empty value.
       */
      transfer_data?: Stripe.Emptyable<SubscriptionUpdateParams.TransferData>;

/**
       * Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately. Can be at most two years from `billing_cycle_anchor`.
       */
      trial_end?: 'now' | number;

/**
       * Settings related to subscription trials.
       */
      trial_settings?: SubscriptionUpdateParams.TrialSettings;
    }

namespace SubscriptionUpdateParams {
      interface AddInvoiceItem {
        /**
         * The coupons to redeem into discounts for the item.
         */
        discounts?: Array<AddInvoiceItem.Discount>;