@wix/pricing-plans 1.0.4 → 1.0.5

package/build/es/src/pricing-plans-v2-plan.universal.d.ts

@@ -15,7 +15,11 @@ export 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;
@@ -27,7 +31,9 @@ export interface Plan {
      */
     archived?: boolean;
     /**
-     * Whether the plan is marked as primary.
+     * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
+     *
+     * Default: `false`.
      * @readonly
      */
     primary?: boolean;
@@ -57,9 +63,19 @@ export 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. Defaults to false. */
+    /**
+     * Whether the buyer can start the plan at a later date.
+     *
+     * Default: `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. If `false`, calling the `cancelOrder()` function returns an error.
+     *
+     * Default: `false`.
+     *
+     */
     buyerCanCancel?: boolean | null;
     /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
     termsAndConditions?: string | null;
@@ -74,15 +90,19 @@ export interface StringList {
 }
 /** Plan pricing information. Includes the price of the plan and payment details. */
 export interface Pricing extends PricingPricingModelOneOf {
-    /** 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;
-    /** Plan has recurring payments. */
+    /**
+     * 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.
+     */
     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 one single payment. The plan is valid until canceled.   */
     singlePaymentUnlimited?: boolean | null;
 }
 /** @oneof */
@@ -96,24 +116,25 @@ export interface PricingPricingModelOneOf {
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
 export interface Recurrence {
-    /** Length of one payment cycle. */
+    /** 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.  */
     cycleDuration?: Duration;
     /**
-     * Amount of payment cycles this subscription is valid for.
+     * Amount of payment cycles the subscription is valid for.
      *
-     * `0` for unlimited or until-canceled.
+     * `0` for unlimited plans or for plans that are valid until canceled.
      */
     cycleCount?: number | null;
 }
 /** A duration expressed in number of time units. */
 export interface Duration {
+    /** Number of days days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.  */
+    count?: number | null;
     /**
-     * The amount of a duration `unit` in a single payment cycle.
+     * Unit of time for the cycle duration.
+     *
+     * Supported values: `"DAY"`, `"WEEK"`, `"MONTH"`, `"YEAR"`.
      *
-     * Currently limited to support only `1`.
      */
-    count?: number | null;
-    /** Unit of time for the cycle duration. */
     unit?: PeriodUnit;
 }
 export declare enum PeriodUnit {
@@ -124,26 +145,37 @@ export declare enum PeriodUnit {
     YEAR = "YEAR"
 }
 export 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'`. Cannot be a negative value.   */
     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;
 }
 export interface BuyerCanCancelUpdated {
     plan?: Plan;
 }
 export interface ListPublicPlansRequest {
-    /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /**
+     * Number of pricing plans to list.
+     *
+     * Default: `75`.
+     */
     limit?: number | null;
-    /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /**
+     * Number of pricing plans to skip.
+     *
+     * Default: `0`.
+     */
     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 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](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
     planIds?: string[];
 }
 export interface ListPublicPlansResponse {
     /** List of public pricing plans. */
     plans?: PublicPlan[];
-    /** Object containing paging-related data (number of plans returned, offset). */
+    /** Details on the paged set of public pricing plans returned.  */
     pagingMetadata?: PagingMetadataV2;
 }
 /** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
@@ -234,19 +266,40 @@ export interface GetPlanRequest {
     _id: string;
 }
 export interface GetPlanResponse {
-    /** Pricing plan. */
+    /** Pricing plan info.  */
     plan?: Plan;
 }
 export interface ListPlansRequest {
-    /** Archived filter. Defaults to ACTIVE (not archived) only. */
+    /**
+     * Archived filter.
+     *
+     * Supported values: `"ACTIVE"`, `"ARCHIVED"`, `"ARCHIVED_AND_ACTIVE"`.
+     *
+     * Default: `"ACTIVE"` (not archived).
+     */
     archived?: ArchivedFilter;
-    /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */
+    /**
+     * Visibility filter.
+     *
+     * Supported values: `"PUBLIC_AND_HIDDEN"`, `"PUBLIC"`, `"HIDDEN"`.
+     *
+     * Default: `"PUBLIC_AND_HIDDEN"` (meaning, both public and hidden plans are listed).
+     *
+     */
     public?: PublicFilter;
-    /** Number of pricing plans to list. Defaults to 75. */
+    /**
+     * Number of pricing plans to list.
+     *
+     * Default: `75`.
+     */
     limit?: number | null;
-    /** Number of pricing plans to skip. Defaults to 0. */
+    /**
+     * Number of pricing plans to skip.
+     *
+     * Default: `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 (based on `options`) are listed according to the [order](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
     planIds?: string[];
 }
 export declare enum ArchivedFilter {
@@ -268,7 +321,7 @@ export declare enum PublicFilter {
 export interface ListPlansResponse {
     /** List of all public and hidden pricing plans. */
     plans?: Plan[];
-    /** Object containing paging-related data (number of plans returned, offset). */
+    /** Details on the paged set of pricing plans returned.  */
     pagingMetadata?: PagingMetadataV2;
 }
 export interface GetPlanStatsRequest {
@@ -278,29 +331,38 @@ export interface GetPlanStatsResponse {
     totalPlans?: number;
 }
 export interface CreatePlanRequest {
+    /** Information for the plan being created. */
     plan: Plan;
 }
 export interface CreatePlanResponse {
+    /** Plan info.  */
     plan?: Plan;
 }
 export interface UpdatePlanRequest {
+    /** Plan info to update. */
     plan?: Plan;
     fieldMask?: string[];
 }
 export interface UpdatePlanResponse {
+    /** Updated plan info. */
     plan?: Plan;
 }
 export interface SetPlanVisibilityRequest {
+    /** The ID of the plan to either display or hide on the site page.  */
     _id: string;
+    /** Whether to set the plan as visible. */
     visible?: boolean;
 }
 export interface SetPlanVisibilityResponse {
+    /** Plan info.  */
     plan?: Plan;
 }
 export interface MakePlanPrimaryRequest {
+    /** ID of the pricing plan to set as the primary plan. */
     _id: string;
 }
 export interface MakePlanPrimaryResponse {
+    /** Primary plan info. */
     plan?: Plan;
 }
 export interface ClearPrimaryRequest {
@@ -311,6 +373,7 @@ export interface ArchivePlanRequest {
     _id: string;
 }
 export interface ArchivePlanResponse {
+    /** Archived plan info.  */
     plan?: Plan;
 }
 export interface PlanArchived {
@@ -357,67 +420,153 @@ export interface BulkActionMetadata {
     undetailedFailures?: number;
 }
 export interface ArrangePlansRequest {
+    /** IDs of all non-archived plans in the order you want them arranged. */
     ids?: string[];
 }
 export interface ArrangePlansResponse {
 }
 /**
- * Retrieves a list of up to 100 public pricing plans.
+ * 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.
+ *
+ * You do not need "Manage Pricing Plans" permissions to list public plans.
  * @public
  * @documentationMaturity preview
+ * @param options - Options for filtering and paging the list of public plans.
+ * @returns Fulfilled - List of public pricing plans.
  */
 export declare function listPublicPlans(options?: ListPublicPlansOptions): Promise<ListPublicPlansResponse>;
 export interface ListPublicPlansOptions {
-    /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /**
+     * Number of pricing plans to list.
+     *
+     * Default: `75`.
+     */
     limit?: number | null;
-    /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
+    /**
+     * Number of pricing plans to skip.
+     *
+     * Default: `0`.
+     */
     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 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](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
     planIds?: string[];
 }
 /**
- * Retrieves a list of up to 1,000 public pricing plans, given the provided pagination, [sorting, and filtering](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/filter-and-sort).
+ * 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`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansquerybuilder) object.
+ *
+ * The returned object contains the query definition which is typically used to run the query using the [`find()`]() function.
+ *
+ * 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.
+ *
+ * `queryPublicPlans()` runs with the following `PublicPlansQueryBuilder` defaults that you can override:
+ * - [`skip`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansquerybuilder/skip): `0`
+ * - [`limit`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansquerybuilder/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 following `PublicPlansQueryBuilder` functions are supported for the `queryPublicPlans()` function. For a full description of the Plans object, see the object returned for the [`items`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansqueryresult/items) property in [`PublicPlansQueryResult`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansqueryresult).
  * @public
  * @documentationMaturity preview
+ * @returns Fulfilled - The query definition used to run the query using the [`find()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/publicplansquerybuilder/find) function.
  */
 export declare function queryPublicPlans(options?: QueryPublicPlansOptions): Promise<QueryPublicPlansResponse>;
 export interface QueryPublicPlansOptions {
     query?: QueryV2;
 }
 /**
- * Retrieves a pricing plan by ID.
+ * 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.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can get plans.
  * @param _id - Plan ID.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @returns Fulfilled - The retrieved plan's information.
  */
 export declare function getPlan(_id: string): Promise<GetPlanResponse>;
 /**
- * Retrieves a list of up to 100 pricing plans (including public, hidden, and archived plans).
+ * 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.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can use this function to list plans.
  * @public
  * @documentationMaturity preview
+ * @param options - Options for filtering and paging the list of plans.
+ * @returns Fulfilled - List of plans that match the given criteria.
  */
 export declare function listPlans(options?: ListPlansOptions): Promise<ListPlansResponse>;
 export interface ListPlansOptions {
-    /** Archived filter. Defaults to ACTIVE (not archived) only. */
+    /**
+     * Archived filter.
+     *
+     * Supported values: `"ACTIVE"`, `"ARCHIVED"`, `"ARCHIVED_AND_ACTIVE"`.
+     *
+     * Default: `"ACTIVE"` (not archived).
+     */
     archived?: ArchivedFilter;
-    /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */
+    /**
+     * Visibility filter.
+     *
+     * Supported values: `"PUBLIC_AND_HIDDEN"`, `"PUBLIC"`, `"HIDDEN"`.
+     *
+     * Default: `"PUBLIC_AND_HIDDEN"` (meaning, both public and hidden plans are listed).
+     *
+     */
     public?: PublicFilter;
-    /** Number of pricing plans to list. Defaults to 75. */
+    /**
+     * Number of pricing plans to list.
+     *
+     * Default: `75`.
+     */
     limit?: number | null;
-    /** Number of pricing plans to skip. Defaults to 0. */
+    /**
+     * Number of pricing plans to skip.
+     *
+     * Default: `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 (based on `options`) are listed according to the [order](https://www.wix.com/velo/reference/wix-pricing-plans-v2/plans/arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
     planIds?: string[];
 }
 /**
- * Gets statistics about the pricing plans. Currently providing only the total number of pricing plans.
+ * 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.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can get plan statistics.
  * @public
  * @documentationMaturity preview
+ * @returns Fulfilled - Overall statistics about the pricing plans.
  */
 export declare function getPlanStats(): Promise<GetPlanStatsResponse>;
 /**
  * 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](#link to intro). 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.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can create plans.
  * @public
  * @documentationMaturity preview
  * @requiredField plan
@@ -427,21 +576,36 @@ export declare function getPlanStats(): Promise<GetPlanStatsResponse>;
  * @requiredField plan.pricing.subscription.cycleCount
  * @requiredField plan.pricing.subscription.cycleDuration
  * @requiredField plan.pricing.subscription.cycleDuration.count
+ * @param plan - Information for the plan being created.
+ * @returns Fulfilled - The created plan.
+ *
+ * Rejected - Error message.
  */
 export declare function createPlan(plan: Plan): Promise<CreatePlanResponse>;
 /**
  * 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.
- * @param _id - Plan ID.
+ *
+ *
+ * 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.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can update plans.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param _id - ID of the plan to update.
+ * @param options - Options for updating the plan.
+ * @returns Fulfilled - The updated plan.
+ *
+ * Rejected - Error message.
  */
 export declare function updatePlan(_id: string, options?: UpdatePlanOptions): Promise<UpdatePlanResponse>;
 export interface UpdatePlanOptions {
+    /** Plan info to update. */
     plan: {
         /**
-         * Plan ID.
+         * ID of the plan to update.
          * @readonly
          */
         _id?: string;
@@ -449,7 +613,7 @@ export interface UpdatePlanOptions {
         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 the pricing plan. For example, "Plenty of parking" or "Free gift on your birthday". */
         perks?: StringList;
         /** Plan price, payment schedule, and expiration. */
         pricing?: Pricing;
@@ -461,7 +625,9 @@ export interface UpdatePlanOptions {
          */
         archived?: boolean;
         /**
-         * Whether the plan is marked as primary.
+         * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
+         *
+         * Default: `false`.
          * @readonly
          */
         primary?: boolean;
@@ -491,9 +657,18 @@ export interface UpdatePlanOptions {
          * - Value of `1`, meaning limited to one purchase per buyer.
          */
         maxPurchasesPerBuyer?: number | null;
-        /** Whether the buyer can start the plan at a later date. Defaults to false. */
+        /**
+         * Whether the buyer can start the plan at a later date.
+         *
+         * Default: `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.
+         *
+         * Default: `false`.
+         *
+         */
         buyerCanCancel?: boolean | null;
         /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
         termsAndConditions?: string | null;
@@ -504,50 +679,106 @@ export interface UpdatePlanOptions {
     fieldMask?: string[];
 }
 /**
- * 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.
+ * 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.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can change a plans visibility.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param _id - The ID of the plan to either display or hide on the site page.
+ * @param options - Plan visibility options.
+ * @returns Fulfilled - The plan's information.
+ *
+ * Rejected - Error message.
  */
 export declare function setPlanVisibility(_id: string, options?: SetPlanVisibilityOptions): Promise<SetPlanVisibilityResponse>;
 export interface SetPlanVisibilityOptions {
+    /** Whether to set the plan as visible.  */
     visible?: boolean;
 }
 /**
- * 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.
+ *
+ *
+ * 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.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can mark a plan as a primary plan.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param _id - ID of the pricing plan to set as the primary plan.
+ * @returns Fulfilled - The primary plan.
  */
 export declare function makePlanPrimary(_id: string): Promise<MakePlanPrimaryResponse>;
 /**
- * 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 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.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can clear the primary plan.
  * @public
  * @documentationMaturity preview
  */
 export declare function clearPrimary(): Promise<void>;
 /**
  * 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.
+ *
+ *
+ * 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**.
+ *
+ * Only users with "Manage Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can archive plans.
+ *
+ * >**Note:** An attempt to archive an already-archived plan throws an error.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param _id - ID of the active plan to archive.
+ * @returns Fulfilled - The archived plan.
+ *
+ * Rejected - Error message.
  */
 export declare function archivePlan(_id: string): Promise<ArchivePlanResponse>;
 /**
- * Changes the display order of the plans on the site. To rearrange the order of the plans, provide a list of plan IDs in the desired order.
- * Include all public and hidden plans in the list you provide.
- * Make sure to provide all non-archived plan IDs to avoid unpredictable results
+ * Changes the display order of the pricing plans on the site page and in the Dashboard.
+ *
+ *
+ * The `arrangePlans()` function returns a Promise that resolves when the plans are rearranged on the site page and in the Dashboard.
+ *
+ * To rearrange the order of the plans, provide a list of the IDs for all non-archived plans in the desired order, including hidden plans.
+ *
+ * Only users with "Managing Pricing Plans" [permissions](https://support.wix.com/en/article/roles-permissions-accessing-roles-permissions) can arrange plans.
+ *
+ * >**Note:** Make sure to provide *all* non-archived plan IDs to avoid unpredictable results.
  * @public
  * @documentationMaturity preview
  */
 export declare function arrangePlans(options?: ArrangePlansOptions): Promise<void>;
 export interface ArrangePlansOptions {
+    /** IDs of all non-archived plans in the order you want them arranged.  */
     ids?: string[];
 }