1
0
mirror of https://github.com/bitwarden/browser synced 2026-02-11 05:53:42 +00:00

docs(billing): refine JSDoc for PremiumOrgUpgradeDialogParams

This commit is contained in:
Stephon Brown
2026-02-04 19:12:08 -05:00
parent a7be6577c2
commit 5931857bc5

View File

@@ -62,10 +62,8 @@ export type PremiumOrgUpgradeDialogResult = {
* In order to open the dialog to a specific step, you must provide the `initialStep` parameter and a `selectedPlan` if the step is `Payment`.
*
* @property {Account} account - The user account information.
* @property {PremiumOrgUpgradeDialogStep | null} PersonalSubscriptionPricingTierId | null} [selectedPlan] - Pre-selected subscription plan (Families, Teams, or Enterprise)y.
* @property {BusinessSubscriptionPricingTierId | null} [selectedPlan] - Pre-selected subscription plan, if any.
* @property {string | null} [dialogTitleMessageOverride] - Optional custom i18n key to override the default dialog title.
* @property {boolean} [hideContinueWithoutUpgradingButton] - Whether to hide the "Continue without upgrading" button.
* @property {PremiumOrgUpgradeDialogStep | null} [initialStep] - The initial step to open the dialog to, if any.
* @property {BusinessSubscriptionPricingTierId | PersonalSubscriptionPricingTierId | null} [selectedPlan] - Pre-selected subscription plan, if any.
* @property {boolean} [redirectOnCompletion] - Whether to redirect after successful upgrade to organization vault.
*/
export type PremiumOrgUpgradeDialogParams = {