@wix/pricing-plans 1.0.107 → 1.0.109

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wix/pricing-plans",
-  "version": "1.0.107",
+  "version": "1.0.109",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -21,8 +21,8 @@
     "type-bundles"
   ],
   "dependencies": {
-    "@wix/pricing-plans_orders": "1.0.49",
-    "@wix/pricing-plans_plans": "1.0.49"
+    "@wix/pricing-plans_orders": "1.0.51",
+    "@wix/pricing-plans_plans": "1.0.51"
   },
   "devDependencies": {
     "glob": "^10.4.1",
@@ -47,5 +47,5 @@
       "fqdn": ""
     }
   },
-  "falconPackageHash": "711f75048a0f3d070099b8467db45b775f38a9fbaa1bfa92dd61390a"
+  "falconPackageHash": "0fc7af022ecd98a1330494f885c5f5630b281c927aceb500ce78e9ba"
 }

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

@@ -709,27 +709,35 @@ interface Tax {
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
 interface Recurrence$1 {
-    /** Length of one payment cycle. */
+    /**
+     * Number of payment cycles the subscription is valid for.
+     * `0` for unlimited plans or for plans that are valid until canceled.
+     */
     cycleDuration?: Duration$1;
     /**
-     * Amount of payment cycles this subscription is valid for.
-     *
-     * `0` for unlimited or until-canceled.
+     * Length of a 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.
      */
     cycleCount?: number | null;
 }
 /** A duration expressed in number of time units. */
 interface Duration$1 {
-    /** The amount of a duration `unit` in a single payment cycle. */
+    /** Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`. */
     count?: number | null;
     /** Unit of time for the cycle duration. */
     unit?: PeriodUnit$1;
 }
 declare enum PeriodUnit$1 {
+    /** Not defined. */
     UNDEFINED = "UNDEFINED",
+    /** Time unit is a day. */
     DAY = "DAY",
+    /** Time unit is a week. */
     WEEK = "WEEK",
+    /** Time unit is a month. */
     MONTH = "MONTH",
+    /** Time unit is a year. */
     YEAR = "YEAR"
 }
 interface Coupon {
@@ -2677,7 +2685,7 @@ interface Plan {
     name?: string | null;
     /** Plan description. */
     description?: string | null;
-    /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */
+    /** List of text strings that promote what is included with this plan. For example, "Plenty of parking" or "Free gift on your birthday." */
     perks?: StringList;
     /** Plan price, payment schedule, and expiration. */
     pricing?: Pricing;
@@ -2716,14 +2724,17 @@ interface Plan {
     /**
      * Number of times the same buyer can purchase the plan. Currently limited to support:
      * - Empty value or a value of `0`, meaning no limitation.
-     * - Value of `1`, meaning limited to one purchase per buyer.
+     * - Value of `1`, meaning limited to 1 purchase per buyer.
      */
     maxPurchasesPerBuyer?: number | null;
     /** 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. Defaults to false. */
+    /**
+     * Whether the buyer is allowed to cancel their plan. Defaults to false.
+     * If false, calling Request Cancellation returns an error.
+     */
     buyerCanCancel?: boolean | null;
-    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
+    /** Any terms and conditions that apply to the plan. This information is displayed during checkout. */
     termsAndConditions?: string | null;
     /**
      * ID of the form associated with the plan at checkout.
@@ -2732,67 +2743,75 @@ interface Plan {
      */
     formId?: string | null;
 }
-/** This wrapper type exist in order to distinguish an empty string list from no list at all in update requests. */
+/** This wrapper type exists to distinguish an empty string list from no list at all in update requests. */
 interface StringList {
     values?: string[];
 }
 /** Plan pricing information. Includes the price of the plan and payment details. */
 interface Pricing extends PricingPricingModelOneOf {
-    /** Plan has recurring payments. */
+    /** Pricing model indicating that the plan has recurring payments. 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. */
     subscription?: Recurrence;
-    /** One time payment, plan is valid for the specified duration. */
+    /** 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. */
     singlePaymentForDuration?: Duration;
-    /** One time payment, plan is valid until it is canceled. */
+    /** Pricing model indicating the plan is paid in a single payment. The plan is valid until canceled. */
     singlePaymentUnlimited?: boolean | null;
-    /** Amount for a single payment (or the whole subscription if it's not a recurring plan) */
+    /** 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. */
     price?: Money;
-    /** Free trial period for the plan in days. It’s available only for recurring plans. Set to 0 to remove free trial. */
+    /** 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. */
     freeTrialDays?: number | null;
 }
 /** @oneof */
 interface PricingPricingModelOneOf {
-    /** Plan has recurring payments. */
+    /** Pricing model indicating that the plan has recurring payments. 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. */
     subscription?: Recurrence;
-    /** One time payment, plan is valid for the specified duration. */
+    /** 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. */
     singlePaymentForDuration?: Duration;
-    /** One time payment, plan is valid until it is canceled. */
+    /** Pricing model indicating the plan is paid in a single payment. The plan is valid until canceled. */
     singlePaymentUnlimited?: boolean | null;
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
 interface Recurrence {
-    /** Length of one payment cycle. */
+    /**
+     * Number of payment cycles the subscription is valid for.
+     * `0` for unlimited plans or for plans that are valid until canceled.
+     */
     cycleDuration?: Duration;
     /**
-     * Amount of payment cycles this subscription is valid for.
-     *
-     * `0` for unlimited or until-canceled.
+     * Length of a 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.
      */
     cycleCount?: number | null;
 }
 /** A duration expressed in number of time units. */
 interface Duration {
-    /** The amount of a duration `unit` in a single payment cycle. */
+    /** Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`. */
     count?: number | null;
     /** Unit of time for the cycle duration. */
     unit?: PeriodUnit;
 }
 declare enum PeriodUnit {
+    /** Not defined. */
     UNDEFINED = "UNDEFINED",
+    /** Time unit is a day. */
     DAY = "DAY",
+    /** Time unit is a week. */
     WEEK = "WEEK",
+    /** Time unit is a month. */
     MONTH = "MONTH",
+    /** Time unit is a year. */
     YEAR = "YEAR"
 }
 interface Money {
-    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
+    /** Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Can't be negative. */
     value?: string;
-    /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
+    /** Currency code. Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`. */
     currency?: string;
 }
 interface FeeConfig {
     /** Fee configuration. */
     fee?: Fee;
-    /** The time this fee will be charged */
+    /** The time this fee will be charged. */
     appliedAt?: AppliedAt;
 }
 interface Fee {
@@ -2803,21 +2822,21 @@ interface Fee {
 }
 declare enum AppliedAt {
     UNKNOWN_CHARGE_EVENT = "UNKNOWN_CHARGE_EVENT",
-    /** Will charge the fee on first payment. If order has a free trial meaning it will charge after the free trial. */
+    /** Will charge the fee on the first payment. If the order has a free trial, it will charge after the free trial. */
     FIRST_PAYMENT = "FIRST_PAYMENT"
 }
 interface ListPublicPlansRequest {
-    /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /** Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */
     limit?: number | null;
-    /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /** Number of items to skip. Defaults to `0`. See paging ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) |[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */
     offset?: number | null;
-    /** IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs. */
+    /** IDs of plans to list. Non-existent IDs are ignored and don't cause errors. You can specify a maximum of 100 IDs. */
     planIds?: string[];
 }
 interface ListPublicPlansResponse {
     /** List of public pricing plans. */
     plans?: PublicPlan[];
-    /** Object containing paging-related data (number of plans returned, offset). */
+    /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */
     pagingMetadata?: PagingMetadataV2;
 }
 /** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
@@ -2828,7 +2847,7 @@ interface PublicPlan {
     name?: string | null;
     /** Plan description. */
     description?: string | null;
-    /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */
+    /** What is included with this plan (for example, 1 weekly entrance to a specific class). */
     perks?: StringList;
     /** Plan price, payment schedule, and expiration. */
     pricing?: Pricing;
@@ -2840,13 +2859,13 @@ interface PublicPlan {
     _updatedDate?: Date | null;
     /** URL-friendly version of plan name. Unique across all plans in the same site. */
     slug?: string | null;
-    /** Number of times the same buyer can purchase the plan. An empty value or a value of zero means no limitation. */
+    /** Number of times the same buyer can purchase the plan. An empty value or a value of 0 means no limitation. */
     maxPurchasesPerBuyer?: number | null;
     /** 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. Defaults to false. */
     buyerCanCancel?: boolean | null;
-    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
+    /** Any terms and conditions that apply to the plan. This information is displayed during checkout. */
     termsAndConditions?: string | null;
     /**
      * ID of the form associated with the plan at checkout.
@@ -2874,15 +2893,15 @@ interface Cursors {
     prev?: string | null;
 }
 interface QueryPublicPlansRequest {
-    /** Query */
+    /** Query options. */
     query?: QueryV2;
 }
 interface QueryV2 {
-    /** A filter object. See [supported fields and operators](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort#wix-pricing-plans_pricing-plans_plans_filter-and-sort_query-public-plans) */
+    /** A filter object. See supported fields and operators ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/query-public-plans) | [REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort#wix-pricing-plans_pricing-plans_plans_filter-and-sort_query-public-plans)). */
     filter?: Record<string, any> | null;
-    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}] */
+    /** Sort object in the form [{"fieldName":"sortField1"},{"fieldName":"sortField2","direction":"DESC"}]. */
     sort?: Sorting[];
-    /** Pointer to page of results using offset. Can not be used together with 'cursorPaging' */
+    /** Pointer to page of results using offset. Can't be used together with 'cursorPaging'. */
     paging?: Paging;
 }
 interface Sorting {
@@ -2904,7 +2923,7 @@ interface Paging {
 interface QueryPublicPlansResponse {
     /** List of public pricing plans that match the specified query. */
     plans?: PublicPlan[];
-    /** Object containing paging-related data (number of plans returned, offset). */
+    /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */
     pagingMetadata?: PagingMetadataV2;
 }
 interface GetPlanRequest {
@@ -2916,15 +2935,15 @@ interface GetPlanResponse {
     plan?: Plan;
 }
 interface ListPlansRequest {
-    /** Archived filter. Defaults to ACTIVE (not archived) only. */
+    /** Archived filter. Defaults to `ACTIVE` (not archived) only. */
     archived?: ArchivedFilter;
-    /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */
+    /** Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed). */
     public?: PublicFilter;
-    /** Number of pricing plans to list. Defaults to 75. */
+    /** Number of pricing plans to list. Defaults to `75`. */
     limit?: number | null;
-    /** Number of pricing plans to skip. Defaults to 0. */
+    /** Number of pricing plans to skip. Defaults to `0`. */
     offset?: number | null;
-    /** Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs. */
+    /** 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 are listed according to the order displayed in a site's dashboard (which you can set with Arrange Plans). You can specify a maximum of 100 IDs. */
     planIds?: string[];
 }
 declare enum ArchivedFilter {
@@ -2946,7 +2965,7 @@ declare enum PublicFilter {
 interface ListPlansResponse {
     /** List of all public and hidden pricing plans. */
     plans?: Plan[];
-    /** Object containing paging-related data (number of plans returned, offset). */
+    /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */
     pagingMetadata?: PagingMetadataV2;
 }
 interface GetPlanStatsRequest {
@@ -2956,7 +2975,7 @@ interface GetPlanStatsResponse {
     totalPlans?: number;
 }
 interface CreatePlanRequest {
-    /** Plan info. */
+    /** Plan details. */
     plan: Plan;
 }
 interface CreatePlanResponse {
@@ -2964,7 +2983,7 @@ interface CreatePlanResponse {
     plan?: Plan;
 }
 interface UpdatePlanRequest {
-    /** Plan info. */
+    /** ID of the plan to update. */
     plan: Plan;
 }
 interface UpdatePlanResponse {
@@ -2976,7 +2995,7 @@ interface BuyerCanCancelUpdated {
     plan?: Plan;
 }
 interface SetPlanVisibilityRequest {
-    /** Plan ID. */
+    /** The ID of the plan to either display or hide on a site page. */
     _id: string;
     /** Whether a plan is visible to members and site visitors. Updates the `public` field. */
     visible: boolean;
@@ -2986,6 +3005,7 @@ interface SetPlanVisibilityResponse {
     plan?: Plan;
 }
 interface MakePlanPrimaryRequest {
+    /** Pricing plan ID. */
     _id: string;
 }
 interface MakePlanPrimaryResponse {
@@ -2997,7 +3017,7 @@ interface ClearPrimaryRequest {
 interface ClearPrimaryResponse {
 }
 interface ArchivePlanRequest {
-    /** ID of the plan to archive. */
+    /** ID of the active plan to archive. */
     _id: string;
 }
 interface ArchivePlanResponse {
@@ -3011,7 +3031,7 @@ interface PlanArchived {
 interface BulkArchivePlanRequest {
     /** List of Plan IDs to archive. */
     ids?: string[];
-    /** Set to true to return Plan entity in response. */
+    /** Set to `true` to return the `Plan` entity in the response. */
     returnFullEntity?: boolean;
 }
 interface BulkArchivePlanResponse {
@@ -3053,7 +3073,7 @@ interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 interface ArrangePlansRequest {
-    /** List of plan IDs. */
+    /** IDs of all non-archived plans in the order you want them arranged. */
     ids?: string[];
 }
 interface ArrangePlansResponse {
@@ -3061,7 +3081,7 @@ interface ArrangePlansResponse {
 interface CountPlansRequest {
     /** The filter. */
     filter?: Record<string, any> | null;
-    /** If true, will count only visible plans (visible and not archived). If no value is given all site's plans will be counted. */
+    /** If true, counts only visible plans (visible and not archived). If no value is specified, all plans are counted. */
     visibility?: boolean | null;
 }
 interface CountPlansResponse {
@@ -3071,21 +3091,21 @@ interface CountPlansResponse {
 interface GetPlansPremiumStatusRequest {
 }
 interface GetPlansPremiumStatusResponse {
-    /** True if site has non-free, non-template plans. */
+    /** True if a site has non-free, non-template plans. */
     hasPaidPlans?: boolean;
-    /** True if site has plans that were created before Pricing Plans became a premium app. */
+    /** True if a site has plans that were created before Pricing Plans became a premium app. */
     hasOldPlans?: boolean;
 }
 interface SearchPlansRequest {
-    /** Query */
+    /** Query options. */
     query?: QueryV2;
-    /** Search phrase for plan name */
+    /** Search phrase for the plan name. */
     searchPhrase?: string | null;
 }
 interface SearchPlansResponse {
     /** List of pricing plans that match the specified filter and search phrase. */
     plans?: Plan[];
-    /** Object containing paging-related data (number of plans returned, offset). */
+    /** Object containing paging-related data (such as the number of plans returned, the offset, and so on). */
     pagingMetadata?: PagingMetadataV2;
 }
 interface DomainEvent extends DomainEventBodyOneOf {
@@ -3332,11 +3352,11 @@ interface PlanUpdatedEnvelope {
     metadata: EventMetadata;
 }
 interface ListPublicPlansOptions {
-    /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /** Number of items to list. Defaults to `75`. See limits ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) | [REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */
     limit?: number | null;
-    /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /** Number of items to skip. Defaults to `0`. See paging ([SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/plans/list-public-plans) |[REST](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#paging)). */
     offset?: number | null;
-    /** IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs. */
+    /** IDs of plans to list. Non-existent IDs are ignored and don't cause errors. You can specify a maximum of 100 IDs. */
     planIds?: string[];
 }
 interface QueryOffsetResult {
@@ -3400,15 +3420,15 @@ interface PlansQueryBuilder {
     find: () => Promise<PlansQueryResult>;
 }
 interface ListPlansOptions {
-    /** Archived filter. Defaults to ACTIVE (not archived) only. */
+    /** Archived filter. Defaults to `ACTIVE` (not archived) only. */
     archived?: ArchivedFilter;
-    /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */
+    /** Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed). */
     public?: PublicFilter;
-    /** Number of pricing plans to list. Defaults to 75. */
+    /** Number of pricing plans to list. Defaults to `75`. */
     limit?: number | null;
-    /** Number of pricing plans to skip. Defaults to 0. */
+    /** Number of pricing plans to skip. Defaults to `0`. */
     offset?: number | null;
-    /** Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs. */
+    /** 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 are listed according to the order displayed in a site's dashboard (which you can set with Arrange Plans). You can specify a maximum of 100 IDs. */
     planIds?: string[];
 }
 interface UpdatePlan {
@@ -3421,7 +3441,7 @@ interface UpdatePlan {
     name?: string | null;
     /** Plan description. */
     description?: string | null;
-    /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */
+    /** List of text strings that promote what is included with this plan. For example, "Plenty of parking" or "Free gift on your birthday." */
     perks?: StringList;
     /** Plan price, payment schedule, and expiration. */
     pricing?: Pricing;
@@ -3460,14 +3480,17 @@ interface UpdatePlan {
     /**
      * Number of times the same buyer can purchase the plan. Currently limited to support:
      * - Empty value or a value of `0`, meaning no limitation.
-     * - Value of `1`, meaning limited to one purchase per buyer.
+     * - Value of `1`, meaning limited to 1 purchase per buyer.
      */
     maxPurchasesPerBuyer?: number | null;
     /** 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. Defaults to false. */
+    /**
+     * Whether the buyer is allowed to cancel their plan. Defaults to false.
+     * If false, calling Request Cancellation returns an error.
+     */
     buyerCanCancel?: boolean | null;
-    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
+    /** Any terms and conditions that apply to the plan. This information is displayed during checkout. */
     termsAndConditions?: string | null;
     /**
      * ID of the form associated with the plan at checkout.
@@ -3480,7 +3503,7 @@ interface UpdatePlan {
 declare function listPublicPlans$1(httpClient: HttpClient): ListPublicPlansSignature;
 interface ListPublicPlansSignature {
     /**
-     * Retrieves a list of up to 100 public pricing plans.
+     * Retrieves a list of up to 100 public pricing plans. Public plans are visible plans that are available to site visitors and can be purchased.
      * @param - Options for filtering and paging the list of public plans.
      */
     (options?: ListPublicPlansOptions | undefined): Promise<ListPublicPlansResponse & ListPublicPlansResponseNonNullableFields>;
@@ -3527,14 +3550,18 @@ interface ListPlansSignature {
 declare function getPlanStats$1(httpClient: HttpClient): GetPlanStatsSignature;
 interface GetPlanStatsSignature {
     /**
-     * Gets statistics about the pricing plans. Currently providing only the total number of pricing plans.
+     * Gets statistics about the pricing plans. Currently provides only the total number of pricing plans, including archived plans.
      */
     (): Promise<GetPlanStatsResponse & GetPlanStatsResponseNonNullableFields>;
 }
 declare function createPlan$1(httpClient: HttpClient): CreatePlanSignature;
 interface CreatePlanSignature {
     /**
-     * Creates a pricing plan.
+     * Creates a pricing plan. The specified `plan` object must contain a pricing model. A pricing model can be 1 of the following:
+     * - **A subscription**: A subscription with recurring payments and how often the plan occurs. Subscriptions can have free trial days.
+     * - **A plan that doesn't 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 are available to the Wix user in the Pricing Plans section in a site's dashboard.
      * @param - Information for the plan being created.
      * @returns Created plan.
      */
@@ -3544,7 +3571,7 @@ declare function updatePlan$1(httpClient: HttpClient): UpdatePlanSignature;
 interface UpdatePlanSignature {
     /**
      * Updates a pricing plan.
-     * 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.
+     * Updating a plan doesn't 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 Updated plan.
@@ -3555,9 +3582,9 @@ declare function setPlanVisibility$1(httpClient: HttpClient): SetPlanVisibilityS
 interface SetPlanVisibilitySignature {
     /**
      * 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.
+     * By default, pricing plans are public, meaning they are visible. Plans can be hidden so that site members and visitors can't 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 can't be made active again.)
+     * Changing a plan’s visibility doesn't 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.
@@ -3567,7 +3594,7 @@ interface SetPlanVisibilitySignature {
 declare function makePlanPrimary$1(httpClient: HttpClient): MakePlanPrimarySignature;
 interface MakePlanPrimarySignature {
     /**
-     * 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.
+     * Marks a pricing plan as the primary pricing plan. When viewing pricing plans on a site, the primary plan is highlighted with a customizable ribbon. 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 Make Plan Primary causes the existing primary plan to lose its primary status.
      * @param - ID of the pricing plan to set as the primary plan.
      */
     (_id: string): Promise<MakePlanPrimaryResponse & MakePlanPrimaryResponseNonNullableFields>;
@@ -3575,7 +3602,7 @@ interface MakePlanPrimarySignature {
 declare function clearPrimary$1(httpClient: HttpClient): ClearPrimarySignature;
 interface ClearPrimarySignature {
     /**
-     * Sets all pricing plans as not primary. 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 a site, no plan is highlighted with a customizable ribbon.
      */
     (): Promise<void>;
 }
@@ -3583,10 +3610,12 @@ declare function archivePlan$1(httpClient: HttpClient): ArchivePlanSignature;
 interface ArchivePlanSignature {
     /**
      * Archives a single plan.
-     * 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.
+     * When a plan is archived, it's no longer visible as a public plan that can be chosen by site members or visitors.
+     * This is because the plan's `public` property is automatically set to `false`.
+     * Archived plans can't be purchased or reactivated.
+     * Plan archiving doesn't impact existing orders made for the plan. All orders for the plan are still active and keep their perks, payment options, and terms.
+     * Wix users can see archived plans in a site's dashboard under **Pricing Plans -> Archived Plans**.
+     * > **Note:** An attempt to archive an already-archived plan throws an error.
      * @param - ID of the active plan to archive.
      */
     (_id: string): Promise<ArchivePlanResponse & ArchivePlanResponseNonNullableFields>;
@@ -3612,25 +3641,25 @@ declare const archivePlan: MaybeContext<BuildRESTFunction<typeof archivePlan$1>
 
 type _publicOnPlanBuyerCanCancelUpdatedType = typeof onPlanBuyerCanCancelUpdated$1;
 /**
- * An event that is triggered when a plan's `buyerCanCancel` field is updated.
+ * Triggered when a plan's `buyerCanCancel` field is updated.
  */
 declare const onPlanBuyerCanCancelUpdated: ReturnType<typeof createEventModule<_publicOnPlanBuyerCanCancelUpdatedType>>;
 
 type _publicOnPlanCreatedType = typeof onPlanCreated$1;
 /**
- * An event that is triggered when a pricing plan is created.
+ * Triggered when a pricing plan is created.
  */
 declare const onPlanCreated: ReturnType<typeof createEventModule<_publicOnPlanCreatedType>>;
 
 type _publicOnPlanArchivedType = typeof onPlanArchived$1;
 /**
- * An event that is triggered when a pricing plan is archived.
+ * Triggered when a pricing plan is archived.
  */
 declare const onPlanArchived: ReturnType<typeof createEventModule<_publicOnPlanArchivedType>>;
 
 type _publicOnPlanUpdatedType = typeof onPlanUpdated$1;
 /**
- * An event that is triggered when a pricing plan is updated.
+ * Triggered when a pricing plan is updated.
  */
 declare const onPlanUpdated: ReturnType<typeof createEventModule<_publicOnPlanUpdatedType>>;