@wix/pricing-plans 1.0.107 → 1.0.109

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

@@ -217,27 +217,35 @@ interface Tax$1 {
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
 interface Recurrence$3 {
-    /** 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$3;
     /**
-     * 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$3 {
-    /** 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$3;
 }
 declare enum PeriodUnit$3 {
+    /** 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$1 {
@@ -1066,27 +1074,35 @@ interface Tax {
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
 interface Recurrence$2 {
-    /** 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$2;
     /**
-     * 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$2 {
-    /** 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$2;
 }
 declare enum PeriodUnit$2 {
+    /** 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 {
@@ -1763,7 +1779,7 @@ interface Plan$1 {
     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$1;
     /** Plan price, payment schedule, and expiration. */
     pricing?: Pricing$1;
@@ -1802,14 +1818,17 @@ interface Plan$1 {
     /**
      * 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.
@@ -1818,80 +1837,88 @@ interface Plan$1 {
      */
     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$1 {
     values?: string[];
 }
 /** Plan pricing information. Includes the price of the plan and payment details. */
 interface Pricing$1 extends PricingPricingModelOneOf$1 {
-    /** 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$1;
-    /** 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$1;
-    /** 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$1;
-    /** 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$1 {
-    /** 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$1;
-    /** 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$1;
-    /** 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$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 Money$1 {
-    /** 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;
 }
 declare enum AppliedAt$1 {
     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$1 {
-    /** 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$1 {
     /** List of public pricing plans. */
     plans?: PublicPlan$1[];
-    /** 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$1;
 }
 /** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
@@ -1902,7 +1929,7 @@ interface PublicPlan$1 {
     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$1;
     /** Plan price, payment schedule, and expiration. */
     pricing?: Pricing$1;
@@ -1914,13 +1941,13 @@ interface PublicPlan$1 {
     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.
@@ -1948,15 +1975,15 @@ interface Cursors$1 {
     prev?: string | null;
 }
 interface QueryPublicPlansRequest$1 {
-    /** Query */
+    /** Query options. */
     query?: QueryV2$1;
 }
 interface QueryV2$1 {
-    /** 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$1[];
-    /** 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$1;
 }
 interface Sorting$1 {
@@ -1978,7 +2005,7 @@ interface Paging$1 {
 interface QueryPublicPlansResponse$1 {
     /** List of public pricing plans that match the specified query. */
     plans?: PublicPlan$1[];
-    /** 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$1;
 }
 interface GetPlanRequest$1 {
@@ -1990,15 +2017,15 @@ interface GetPlanResponse$1 {
     plan?: Plan$1;
 }
 interface ListPlansRequest$1 {
-    /** Archived filter. Defaults to ACTIVE (not archived) only. */
+    /** Archived filter. Defaults to `ACTIVE` (not archived) only. */
     archived?: ArchivedFilter$1;
-    /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */
+    /** Visibility filter. Defaults to `PUBLIC_AND_HIDDEN` (meaning, both are listed). */
     public?: PublicFilter$1;
-    /** 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$1 {
@@ -2020,7 +2047,7 @@ declare enum PublicFilter$1 {
 interface ListPlansResponse$1 {
     /** List of all public and hidden pricing plans. */
     plans?: Plan$1[];
-    /** 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$1;
 }
 interface GetPlanStatsRequest$1 {
@@ -2030,7 +2057,7 @@ interface GetPlanStatsResponse$1 {
     totalPlans?: number;
 }
 interface CreatePlanRequest$1 {
-    /** Plan info. */
+    /** Plan details. */
     plan: Plan$1;
 }
 interface CreatePlanResponse$1 {
@@ -2038,7 +2065,7 @@ interface CreatePlanResponse$1 {
     plan?: Plan$1;
 }
 interface UpdatePlanRequest$1 {
-    /** Plan info. */
+    /** ID of the plan to update. */
     plan: Plan$1;
 }
 interface UpdatePlanResponse$1 {
@@ -2046,7 +2073,7 @@ interface UpdatePlanResponse$1 {
     plan?: Plan$1;
 }
 interface SetPlanVisibilityRequest$1 {
-    /** 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;
@@ -2056,6 +2083,7 @@ interface SetPlanVisibilityResponse$1 {
     plan?: Plan$1;
 }
 interface MakePlanPrimaryRequest$1 {
+    /** Pricing plan ID. */
     id: string;
 }
 interface MakePlanPrimaryResponse$1 {
@@ -2067,7 +2095,7 @@ interface ClearPrimaryRequest$1 {
 interface ClearPrimaryResponse$1 {
 }
 interface ArchivePlanRequest$1 {
-    /** ID of the plan to archive. */
+    /** ID of the active plan to archive. */
     id: string;
 }
 interface ArchivePlanResponse$1 {
@@ -2157,7 +2185,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;
@@ -2196,14 +2224,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.
@@ -2212,80 +2243,88 @@ 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;
 }
 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. */
@@ -2296,7 +2335,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;
@@ -2308,13 +2347,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.
@@ -2342,15 +2381,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 {
@@ -2372,7 +2411,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 {
@@ -2384,15 +2423,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 {
@@ -2414,7 +2453,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 {
@@ -2424,7 +2463,7 @@ interface GetPlanStatsResponse {
     totalPlans?: number;
 }
 interface CreatePlanRequest {
-    /** Plan info. */
+    /** Plan details. */
     plan: Plan;
 }
 interface CreatePlanResponse {
@@ -2432,7 +2471,7 @@ interface CreatePlanResponse {
     plan?: Plan;
 }
 interface UpdatePlanRequest {
-    /** Plan info. */
+    /** ID of the plan to update. */
     plan: Plan;
 }
 interface UpdatePlanResponse {
@@ -2440,7 +2479,7 @@ interface UpdatePlanResponse {
     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;
@@ -2450,6 +2489,7 @@ interface SetPlanVisibilityResponse {
     plan?: Plan;
 }
 interface MakePlanPrimaryRequest {
+    /** Pricing plan ID. */
     _id: string;
 }
 interface MakePlanPrimaryResponse {
@@ -2461,7 +2501,7 @@ interface ClearPrimaryRequest {
 interface ClearPrimaryResponse {
 }
 interface ArchivePlanRequest {
-    /** ID of the plan to archive. */
+    /** ID of the active plan to archive. */
     _id: string;
 }
 interface ArchivePlanResponse {