@wix/pricing-plans 1.0.106 → 1.0.107

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/pricing-plans",
-  "version": "1.0.106",
+  "version": "1.0.107",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -22,7 +22,7 @@
   ],
   "dependencies": {
     "@wix/pricing-plans_orders": "1.0.49",
-    "@wix/pricing-plans_plans": "1.0.48"
+    "@wix/pricing-plans_plans": "1.0.49"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -47,5 +47,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "b96a79ff901c637f80194fbc4f7d8cd258b39325b3e0d440edb60773"
+  "falconPackageHash": "711f75048a0f3d070099b8467db45b775f38a9fbaa1bfa92dd61390a"
 }

package/type-bundles/context.bundle.d.ts

@@ -2677,11 +2677,7 @@ interface Plan {
     name?: string | null;
     /** Plan description. */
     description?: string | null;
-    /**
-     * List of text strings that promote what is included with this plan.
-     *
-     * For example, "Plenty of parking" or "Free gift on your birthday".
-     */
+    /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */
     perks?: StringList;
     /** Plan price, payment schedule, and expiration. */
     pricing?: Pricing;
@@ -2693,9 +2689,7 @@ interface Plan {
      */
     archived?: boolean;
     /**
-     * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
-     *
-     * Default: `false`.
+     * Whether the plan is marked as primary.
      * @readonly
      */
     primary?: boolean;
@@ -2725,23 +2719,17 @@ interface Plan {
      * - Value of `1`, meaning limited to one purchase per buyer.
      */
     maxPurchasesPerBuyer?: number | null;
-    /**
-     * Whether the buyer can start the plan at a later date.
-     *
-     * Default: `false`.
-     *
-     */
+    /** Whether the buyer can start the plan at a later date. Defaults to false. */
     allowFutureStartDate?: boolean | null;
-    /**
-     * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.
-     *
-     * Default: `true`.
-     *
-     */
+    /** Whether the buyer is allowed to cancel their plan. Defaults to false. */
     buyerCanCancel?: boolean | null;
     /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
     termsAndConditions?: string | null;
-    /** ID of the form associated with the plan at checkout. */
+    /**
+     * ID of the form associated with the plan at checkout.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     */
     formId?: string | null;
 }
 /** This wrapper type exist in order to distinguish an empty string list from no list at all in update requests. */
@@ -2750,19 +2738,15 @@ interface StringList {
 }
 /** Plan pricing information. Includes the price of the plan and payment details. */
 interface Pricing extends PricingPricingModelOneOf {
-    /**
-     * Pricing model indicating that the plan has recurring payments.
-     *
-     * Note: This type of subscription is not a "Wix subscription," which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and *all* pricing plan models.
-     */
+    /** Plan has recurring payments. */
     subscription?: Recurrence;
-    /** Pricing model indicating a single payment per cycle and the length of the cycle. The cycle is the duration of the plan, not a payment cycle. */
+    /** One time payment, plan is valid for the specified duration. */
     singlePaymentForDuration?: Duration;
-    /** Pricing model indicating the plan is paid in one single payment. The plan is valid until canceled.   */
+    /** One time payment, plan is valid until it is canceled. */
     singlePaymentUnlimited?: boolean | null;
-    /** Amount for a single payment. For subscriptions, this is the amount to pay each payment cycle and it is required. For plans that are not recurring plans, it is the single payment amount for the whole subscription.  */
+    /** Amount for a single payment (or the whole subscription if it's not a recurring plan) */
     price?: Money;
-    /** Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`. Set to `0` to remove the free trial.  */
+    /** Free trial period for the plan in days. It’s available only for recurring plans. Set to 0 to remove free trial. */
     freeTrialDays?: number | null;
 }
 /** @oneof */
@@ -2776,18 +2760,18 @@ interface PricingPricingModelOneOf {
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
 interface Recurrence {
-    /** Length of one payment cycle. For example, 1 month to have monthly payments. Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration. Currently, only a value of `1` is supported.  */
+    /** Length of one payment cycle. */
     cycleDuration?: Duration;
     /**
-     * Amount of payment cycles the subscription is valid for.
+     * Amount of payment cycles this subscription is valid for.
      *
-     * `0` for unlimited plans or for plans that are valid until canceled.
+     * `0` for unlimited or until-canceled.
      */
     cycleCount?: number | null;
 }
 /** A duration expressed in number of time units. */
 interface Duration {
-    /** Number of days days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.  */
+    /** The amount of a duration `unit` in a single payment cycle. */
     count?: number | null;
     /** Unit of time for the cycle duration. */
     unit?: PeriodUnit;
@@ -2800,12 +2784,9 @@ declare enum PeriodUnit {
     YEAR = "YEAR"
 }
 interface Money {
-    /** Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Cannot be a negative value.   */
+    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
     value?: string;
-    /**
-     * Currency code. Three-letter currency code in
-     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`.
-     */
+    /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
     currency?: string;
 }
 interface FeeConfig {
@@ -2826,25 +2807,17 @@ declare enum AppliedAt {
     FIRST_PAYMENT = "FIRST_PAYMENT"
 }
 interface ListPublicPlansRequest {
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
+    /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
+    /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     offset?: number | null;
-    /** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs. */
     planIds?: string[];
 }
 interface ListPublicPlansResponse {
     /** List of public pricing plans. */
     plans?: PublicPlan[];
-    /** Details on the paged set of public pricing plans returned.  */
+    /** Object containing paging-related data (number of plans returned, offset). */
     pagingMetadata?: PagingMetadataV2;
 }
 /** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
@@ -2875,7 +2848,11 @@ interface PublicPlan {
     buyerCanCancel?: boolean | null;
     /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
     termsAndConditions?: string | null;
-    /** ID of the form associated with the plan at checkout. */
+    /**
+     * ID of the form associated with the plan at checkout.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     */
     formId?: string | null;
 }
 interface PagingMetadataV2 {
@@ -2935,36 +2912,19 @@ interface GetPlanRequest {
     _id: string;
 }
 interface GetPlanResponse {
-    /** Pricing plan info.  */
+    /** Pricing plan. */
     plan?: Plan;
 }
 interface ListPlansRequest {
-    /**
-     * Archived filter.
-     *
-     * Default: `ACTIVE` (not archived).
-     */
+    /** Archived filter. Defaults to ACTIVE (not archived) only. */
     archived?: ArchivedFilter;
-    /**
-     * Visibility filter.
-     *
-     * Default: `PUBLIC_AND_HIDDEN` (meaning, both public and hidden plans are listed).
-     *
-     */
+    /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */
     public?: PublicFilter;
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
+    /** Number of pricing plans to list. Defaults to 75. */
     limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
+    /** Number of pricing plans to skip. Defaults to 0. */
     offset?: number | null;
-    /** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs. */
     planIds?: string[];
 }
 declare enum ArchivedFilter {
@@ -2986,7 +2946,7 @@ declare enum PublicFilter {
 interface ListPlansResponse {
     /** List of all public and hidden pricing plans. */
     plans?: Plan[];
-    /** Details on the paged set of pricing plans returned.  */
+    /** Object containing paging-related data (number of plans returned, offset). */
     pagingMetadata?: PagingMetadataV2;
 }
 interface GetPlanStatsRequest {
@@ -2996,19 +2956,19 @@ interface GetPlanStatsResponse {
     totalPlans?: number;
 }
 interface CreatePlanRequest {
-    /** Information for the plan being created. */
+    /** Plan info. */
     plan: Plan;
 }
 interface CreatePlanResponse {
-    /** Plan info.  */
+    /** Created plan. */
     plan?: Plan;
 }
 interface UpdatePlanRequest {
-    /** Plan info to update. */
+    /** Plan info. */
     plan: Plan;
 }
 interface UpdatePlanResponse {
-    /** Updated plan info. */
+    /** Updated plan. */
     plan?: Plan;
 }
 interface BuyerCanCancelUpdated {
@@ -3016,21 +2976,20 @@ interface BuyerCanCancelUpdated {
     plan?: Plan;
 }
 interface SetPlanVisibilityRequest {
-    /** The ID of the plan to either display or hide on the site page.  */
+    /** Plan ID. */
     _id: string;
-    /** Whether to set the plan as visible. */
+    /** Whether a plan is visible to members and site visitors. Updates the `public` field. */
     visible: boolean;
 }
 interface SetPlanVisibilityResponse {
-    /** Plan info.  */
+    /** Pricing plan. */
     plan?: Plan;
 }
 interface MakePlanPrimaryRequest {
-    /** ID of the pricing plan to set as the primary plan. */
     _id: string;
 }
 interface MakePlanPrimaryResponse {
-    /** Primary plan info. */
+    /** Pricing plan. */
     plan?: Plan;
 }
 interface ClearPrimaryRequest {
@@ -3042,7 +3001,7 @@ interface ArchivePlanRequest {
     _id: string;
 }
 interface ArchivePlanResponse {
-    /** Archived plan info.  */
+    /** Archived plan. */
     plan?: Plan;
 }
 interface PlanArchived {
@@ -3094,7 +3053,7 @@ interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 interface ArrangePlansRequest {
-    /** IDs of all non-archived plans in the order you want them arranged. */
+    /** List of plan IDs. */
     ids?: string[];
 }
 interface ArrangePlansResponse {
@@ -3373,19 +3332,11 @@ interface PlanUpdatedEnvelope {
     metadata: EventMetadata;
 }
 interface ListPublicPlansOptions {
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
+    /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
+    /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     offset?: number | null;
-    /** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs. */
     planIds?: string[];
 }
 interface QueryOffsetResult {
@@ -3449,32 +3400,15 @@ interface PlansQueryBuilder {
     find: () => Promise<PlansQueryResult>;
 }
 interface ListPlansOptions {
-    /**
-     * Archived filter.
-     *
-     * Default: `ACTIVE` (not archived).
-     */
+    /** Archived filter. Defaults to ACTIVE (not archived) only. */
     archived?: ArchivedFilter;
-    /**
-     * Visibility filter.
-     *
-     * Default: `PUBLIC_AND_HIDDEN` (meaning, both public and hidden plans are listed).
-     *
-     */
+    /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */
     public?: PublicFilter;
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
+    /** Number of pricing plans to list. Defaults to 75. */
     limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
+    /** Number of pricing plans to skip. Defaults to 0. */
     offset?: number | null;
-    /** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs. */
     planIds?: string[];
 }
 interface UpdatePlan {
@@ -3487,11 +3421,7 @@ interface UpdatePlan {
     name?: string | null;
     /** Plan description. */
     description?: string | null;
-    /**
-     * List of text strings that promote what is included with this plan.
-     *
-     * For example, "Plenty of parking" or "Free gift on your birthday".
-     */
+    /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */
     perks?: StringList;
     /** Plan price, payment schedule, and expiration. */
     pricing?: Pricing;
@@ -3503,9 +3433,7 @@ interface UpdatePlan {
      */
     archived?: boolean;
     /**
-     * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
-     *
-     * Default: `false`.
+     * Whether the plan is marked as primary.
      * @readonly
      */
     primary?: boolean;
@@ -3535,35 +3463,25 @@ interface UpdatePlan {
      * - Value of `1`, meaning limited to one purchase per buyer.
      */
     maxPurchasesPerBuyer?: number | null;
-    /**
-     * Whether the buyer can start the plan at a later date.
-     *
-     * Default: `false`.
-     *
-     */
+    /** Whether the buyer can start the plan at a later date. Defaults to false. */
     allowFutureStartDate?: boolean | null;
-    /**
-     * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.
-     *
-     * Default: `true`.
-     *
-     */
+    /** Whether the buyer is allowed to cancel their plan. Defaults to false. */
     buyerCanCancel?: boolean | null;
     /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
     termsAndConditions?: string | null;
-    /** ID of the form associated with the plan at checkout. */
+    /**
+     * ID of the form associated with the plan at checkout.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     */
     formId?: string | null;
 }
 
 declare function listPublicPlans$1(httpClient: HttpClient): ListPublicPlansSignature;
 interface ListPublicPlansSignature {
     /**
-     * Retrieves a list of public pricing plans.
-     *
-     *
-     * The `listPublicPlans()` function returns a Promise that resolves to a list of up to 100 public pricing plans. Public plans are visible plans that site visitors can see on the site and purchase.
+     * Retrieves a list of up to 100 public pricing plans.
      * @param - Options for filtering and paging the list of public plans.
-     * @returns Fulfilled - List of public pricing plans.
      */
     (options?: ListPublicPlansOptions | undefined): Promise<ListPublicPlansResponse & ListPublicPlansResponseNonNullableFields>;
 }
@@ -3573,54 +3491,43 @@ interface QueryPublicPlansSignature {
      * Creates a query to retrieve a list of public pricing plans.
      *
      *
-     * The `queryPublicPlans()` function builds a query to retrieve a list of up to 1,000 public plans and returns a [`PublicPlansQueryBuilder`](#plansquerybuilder) object.
+     * The `queryPublicPlans()` method builds a query to retrieve a list of up to 1,000 public plans and returns a [`PublicPlansQueryBuilder`](#plansquerybuilder) object.
      *
-     * The returned object contains the query definition which is typically used to run the query using the [`find()`](#plansquerybuilder/find) function.
+     * The returned object contains the query definition which is typically used to run the query using the [`find()`](#plansquerybuilder/find) method.
      *
-     * You can refine the query by chaining `PublicPlansQueryBuilder` functions onto the query. `PublicPlansQueryBuilder` functions enable you to sort, filter, and control the results that `queryPublicPlans()` returns.
+     * You can refine the query by chaining `PublicPlansQueryBuilder` methods onto the query. `PublicPlansQueryBuilder` methods enable you to sort, filter, and control the results that `queryPublicPlans()` returns.
      *
      * `queryPublicPlans()` runs with the following `PublicPlansQueryBuilder` defaults that you can override:
      * - [`skip`](#plansquerybuilder/skip): `0`
      * - [`limit`](#plansquerybuilder/limit): `50`
      *
-     * The functions that are chained to `queryPublicPlans()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the `_id` property in ascending order, the results are sorted first by the created date of the items and then, if there are multiple results with the same date, the items are sorted by `_id` in ascending order, per created date value.
+     * The methods that are chained to `queryPublicPlans()` are applied in the order they are called. For example, if you sort on the `_createdDate` property in ascending order and then on the `_id` property in ascending order, the results are sorted first by the created date of the items and then, if there are multiple results with the same date, the items are sorted by `_id` in ascending order, per created date value.
      *
-     * The following `PublicPlansQueryBuilder` functions are supported for the `queryPublicPlans()` function. For a full description of the Plans object, see the object returned for the [`items`](#plansqueryresult/items) property in [`PublicPlansQueryResult`](#plansqueryresult).
+     * The following `PublicPlansQueryBuilder` methods are supported for the `queryPublicPlans()` method. For a full description of the Plans object, see the object returned for the [`items`](#plansqueryresult/items) property in [`PublicPlansQueryResult`](#plansqueryresult).
      */
     (): PlansQueryBuilder;
 }
 declare function getPlan$1(httpClient: HttpClient): GetPlanSignature;
 interface GetPlanSignature {
     /**
-     * Retrieves a pricing plan by the specified ID.
-     *
-     * The `getPlan()` function returns a Promise that resolves to a plan whose ID matched the specified ID.
+     * Retrieves a pricing plan by ID.
      * @param - Plan ID.
-     * @returns Fulfilled - The retrieved plan's information.
+     * @returns Pricing plan.
      */
     (_id: string): Promise<Plan & PlanNonNullableFields>;
 }
 declare function listPlans$1(httpClient: HttpClient): ListPlansSignature;
 interface ListPlansSignature {
     /**
-     * Retrieves a list of pricing plans.
-     *
-     * The `listPlans()` function returns a Promise that resolves to a list of up to 100 pricing plans. This includes public, hidden, and archived plans.
+     * Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans).
      * @param - Options for filtering and paging the list of plans.
-     * @returns Fulfilled - List of plans that match the given criteria.
      */
     (options?: ListPlansOptions | undefined): Promise<ListPlansResponse & ListPlansResponseNonNullableFields>;
 }
 declare function getPlanStats$1(httpClient: HttpClient): GetPlanStatsSignature;
 interface GetPlanStatsSignature {
     /**
-     * Retrieves statistics about the pricing plans.
-     *
-     *
-     * The `getPlanStats()` function returns a Promise that resolves to statistics about the plan on the site.
-     *
-     * Currently this function provides only the total number of pricing plans, including archived plans.
-     * @returns Fulfilled - Overall statistics about the pricing plans.
+     * Gets statistics about the pricing plans. Currently providing only the total number of pricing plans.
      */
     (): Promise<GetPlanStatsResponse & GetPlanStatsResponseNonNullableFields>;
 }
@@ -3628,20 +3535,8 @@ declare function createPlan$1(httpClient: HttpClient): CreatePlanSignature;
 interface CreatePlanSignature {
     /**
      * Creates a pricing plan.
-     *
-     *
-     * The `createPlan()` function returns a Promise that resolves to a newly-created pricing plan after is has successfully been created.
-     *
-     * The passed `plan` object must contain a [pricing model](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/pricing-models). A pricing model can be one of the following:
-     * - **A subscription**: A subscription with recurring payment and how often the plan occurs. Subscriptions can have free trial days.
-     * - **A plan that does not renew**: A single payment for a specific duration that doesn't renew.
-     * - **An unlimited plan**: A single payment for an unlimited amount of time (until canceled).
-     *
-     * Pricing plans created by this function are available to the site owner in the Pricing Plans section in the Dashboard.
      * @param - Information for the plan being created.
-     * @returns Fulfilled - The created plan.
-     *
-     * Rejected - Error message.
+     * @returns Created plan.
      */
     (plan: Plan): Promise<Plan & PlanNonNullableFields>;
 }
@@ -3649,66 +3544,38 @@ declare function updatePlan$1(httpClient: HttpClient): UpdatePlanSignature;
 interface UpdatePlanSignature {
     /**
      * Updates a pricing plan.
-     *
-     *
-     * The `updatePlan()` function returns a Promise that resolves to an updated plan.
-     *
-     * Updating a plan does not impact existing purchases made for the plan. All purchases keep the details of the original plan that was active at the time of the purchase.
+     * Updating a plan does not impact existing orders made for the plan. All orders keep the details of the original plan that was active at the time of purchase.
      * @param - ID of the plan to update.
      * @param - Options for updating the plan.
-     * @returns Fulfilled - The updated plan.
-     *
-     * Rejected - Error message.
+     * @returns Updated plan.
      */
     (_id: string, plan: UpdatePlan): Promise<Plan & PlanNonNullableFields>;
 }
 declare function setPlanVisibility$1(httpClient: HttpClient): SetPlanVisibilitySignature;
 interface SetPlanVisibilitySignature {
     /**
-     * Sets visibility for non-archived pricing plans.
-     *
-     * The `setPlanVisibility()` functions returns a Promise that resolves to a pricing plan when its visibility has successfully been set.
-     *
-     * By default, pricing plans are public, meaning they are visible. [Plans can be hidden](https://support.wix.com/en/article/pricing-plans-removing-a-plan-from-your-site#hiding-plans) so that site members and visitors cannot see or choose them.
-     *
-     * As opposed to archiving, setting visibility can be reversed. This means that a public plan can be hidden, and a hidden plan can be made public (visible).
-     *
-     * >**Note:** An archived plan always remains archived and cannot be made active again. When archiving a plan, its `public` property is automatically set to `false` so that it is hidden.
-     *
-     * Changing a plan's visibility does not impact existing orders for the plan. All orders for hidden plans are still active and keep their terms and payment options.
-     * @param - Whether to set the plan as visible.
+     * Sets visibility for pricing plans. Visible plans are considered public plans.
+     * By default, pricing plans are public, meaning they are visible. Plans can be hidden so that site members and visitors cannot choose them.
+     * As opposed to archiving, setting visibility can be reversed. This means that a public plan can be hidden, and a hidden plan can be made public (visible). (An archived plan always remains archived and cannot be made active again.)
+     * Changing a plan’s visibility does not impact existing orders for the plan. All orders for hidden plans are still active and keep their perks.
+     * @param - Whether a plan is visible to members and site visitors. Updates the `public` field.
      * @param - The ID of the plan to either display or hide on the site page.
      * @param - Plan visibility options.
-     * @returns Fulfilled - The plan's information.
-     *
-     * Rejected - Error message.
      */
     (_id: string, visible: boolean): Promise<SetPlanVisibilityResponse & SetPlanVisibilityResponseNonNullableFields>;
 }
 declare function makePlanPrimary$1(httpClient: HttpClient): MakePlanPrimarySignature;
 interface MakePlanPrimarySignature {
     /**
-     * Marks a pricing plan as the primary pricing plan.
-     *
-     *
-     * The `makePlanPrimary()` function returns a Promise that resolves to the now primary pricing plan.
-     *
-     * Only a single plan can be marked as a primary plan at any given time. If there is an existing plan marked as primary, calling `makePlanPrimary()` causes the existing primary plan to lose its primary status.
-     *
-     * When viewing pricing plans on the site, the primary plan is highlighted with a customizable ribbon.
+     * Marks a pricing plan as the primary pricing plan. When viewing pricing plans on the site, the primary plan is highlighted with a customizable ribbon.
      * @param - ID of the pricing plan to set as the primary plan.
-     * @returns Fulfilled - The primary plan.
      */
     (_id: string): Promise<MakePlanPrimaryResponse & MakePlanPrimaryResponseNonNullableFields>;
 }
 declare function clearPrimary$1(httpClient: HttpClient): ClearPrimarySignature;
 interface ClearPrimarySignature {
     /**
-     * Sets all pricing plans to no longer be primary.
-     *
-     * The `clearPrimary()` function returns a Promise that is resolved when there are no pricing plans marked as `primary`.
-     *
-     * After clearing the primary plan, when viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.
+     * Sets all pricing plans as not primary. When viewing pricing plans on the site, no plan is highlighted with a customizable ribbon.
      */
     (): Promise<void>;
 }
@@ -3716,24 +3583,11 @@ declare function archivePlan$1(httpClient: HttpClient): ArchivePlanSignature;
 interface ArchivePlanSignature {
     /**
      * Archives a single plan.
-     *
-     *
-     * The `archivePlan()` function returns a Promise that resolves to the newly-archived plan.
-     *
-     * When a plan is archived, the plan
-     * - Is no longer available for display or selection by visitors. This is because the plan's `public` property is automatically set to `false`.
-     * - Cannot be purchased.
-     * - Cannot be "un-archived", meaning the plan cannot be made active again.
-     *
-     * Plan archiving does not impact existing purchases made for the plan. All purchases for the plan are still active and keep their payment options and terms.
-     *
-     * Site owners can see archived plans in the Dashboard under **Pricing Plans -> Archived Plans**.
-     *
-     * >**Note:** An attempt to archive an already-archived plan throws an error.
+     * When a plan is archived, it is no longer visible as a public plan that can be chosen by site members or visitors. Archived plans cannot be purchased.
+     * An archived plan cannot be made active again.
+     * Plan archiving does not impact existing orders made for the plan. All orders for the plan are still active and keep their perks.
+     * Site owners can see archived plans in the Dashboard under Pricing Plans -> Archived Plans.
      * @param - ID of the active plan to archive.
-     * @returns Fulfilled - The archived plan.
-     *
-     * Rejected - Error message.
      */
     (_id: string): Promise<ArchivePlanResponse & ArchivePlanResponseNonNullableFields>;
 }