@wix/pricing-plans 1.0.106 → 1.0.107

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

@@ -2157,11 +2157,7 @@ interface Plan {
     name?: string | null;
     /** Plan description. */
     description?: string | null;
-    /**
-     * List of text strings that promote what is included with this plan.
-     *
-     * For example, "Plenty of parking" or "Free gift on your birthday".
-     */
+    /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */
     perks?: StringList;
     /** Plan price, payment schedule, and expiration. */
     pricing?: Pricing;
@@ -2173,9 +2169,7 @@ interface Plan {
      */
     archived?: boolean;
     /**
-     * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
-     *
-     * Default: `false`.
+     * Whether the plan is marked as primary.
      * @readonly
      */
     primary?: boolean;
@@ -2205,23 +2199,17 @@ interface Plan {
      * - Value of `1`, meaning limited to one purchase per buyer.
      */
     maxPurchasesPerBuyer?: number | null;
-    /**
-     * Whether the buyer can start the plan at a later date.
-     *
-     * Default: `false`.
-     *
-     */
+    /** Whether the buyer can start the plan at a later date. Defaults to false. */
     allowFutureStartDate?: boolean | null;
-    /**
-     * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.
-     *
-     * Default: `true`.
-     *
-     */
+    /** Whether the buyer is allowed to cancel their plan. Defaults to false. */
     buyerCanCancel?: boolean | null;
     /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
     termsAndConditions?: string | null;
-    /** ID of the form associated with the plan at checkout. */
+    /**
+     * ID of the form associated with the plan at checkout.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     */
     formId?: string | null;
 }
 /** This wrapper type exist in order to distinguish an empty string list from no list at all in update requests. */
@@ -2230,19 +2218,15 @@ interface StringList {
 }
 /** Plan pricing information. Includes the price of the plan and payment details. */
 interface Pricing extends PricingPricingModelOneOf {
-    /**
-     * Pricing model indicating that the plan has recurring payments.
-     *
-     * Note: This type of subscription is not a "Wix subscription," which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and *all* pricing plan models.
-     */
+    /** Plan has recurring payments. */
     subscription?: Recurrence;
-    /** Pricing model indicating a single payment per cycle and the length of the cycle. The cycle is the duration of the plan, not a payment cycle. */
+    /** One time payment, plan is valid for the specified duration. */
     singlePaymentForDuration?: Duration;
-    /** Pricing model indicating the plan is paid in one single payment. The plan is valid until canceled.   */
+    /** One time payment, plan is valid until it is canceled. */
     singlePaymentUnlimited?: boolean | null;
-    /** Amount for a single payment. For subscriptions, this is the amount to pay each payment cycle and it is required. For plans that are not recurring plans, it is the single payment amount for the whole subscription.  */
+    /** Amount for a single payment (or the whole subscription if it's not a recurring plan) */
     price?: Money;
-    /** Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`. Set to `0` to remove the free trial.  */
+    /** Free trial period for the plan in days. It’s available only for recurring plans. Set to 0 to remove free trial. */
     freeTrialDays?: number | null;
 }
 /** @oneof */
@@ -2256,18 +2240,18 @@ interface PricingPricingModelOneOf {
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
 interface Recurrence {
-    /** Length of one payment cycle. For example, 1 month to have monthly payments. Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration. Currently, only a value of `1` is supported.  */
+    /** Length of one payment cycle. */
     cycleDuration?: Duration;
     /**
-     * Amount of payment cycles the subscription is valid for.
+     * Amount of payment cycles this subscription is valid for.
      *
-     * `0` for unlimited plans or for plans that are valid until canceled.
+     * `0` for unlimited or until-canceled.
      */
     cycleCount?: number | null;
 }
 /** A duration expressed in number of time units. */
 interface Duration {
-    /** Number of days days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.  */
+    /** The amount of a duration `unit` in a single payment cycle. */
     count?: number | null;
     /** Unit of time for the cycle duration. */
     unit?: PeriodUnit;
@@ -2280,12 +2264,9 @@ declare enum PeriodUnit {
     YEAR = "YEAR"
 }
 interface Money {
-    /** Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Cannot be a negative value.   */
+    /** Monetary amount. Decimal string with a period as a decimal separator (e.g., 3.99). */
     value?: string;
-    /**
-     * Currency code. Three-letter currency code in
-     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`.
-     */
+    /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
     currency?: string;
 }
 declare enum AppliedAt {
@@ -2294,25 +2275,17 @@ declare enum AppliedAt {
     FIRST_PAYMENT = "FIRST_PAYMENT"
 }
 interface ListPublicPlansRequest {
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
+    /** Number of items to list. Defaults to 75. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
+    /** Number of items to skip. Defaults to 0. See [Pagination](https://dev.wix.com/api/rest/getting-started/pagination). */
     offset?: number | null;
-    /** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** IDs of plans to list. Non-existent IDs will be ignored and won't cause errors. You can pass a maximum of 100 IDs. */
     planIds?: string[];
 }
 interface ListPublicPlansResponse {
     /** List of public pricing plans. */
     plans?: PublicPlan[];
-    /** Details on the paged set of public pricing plans returned.  */
+    /** Object containing paging-related data (number of plans returned, offset). */
     pagingMetadata?: PagingMetadataV2;
 }
 /** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
@@ -2343,7 +2316,11 @@ interface PublicPlan {
     buyerCanCancel?: boolean | null;
     /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
     termsAndConditions?: string | null;
-    /** ID of the form associated with the plan at checkout. */
+    /**
+     * ID of the form associated with the plan at checkout.
+     *
+     * Learn more about [forms](https://support.wix.com/en/article/wix-forms-an-overview).
+     */
     formId?: string | null;
 }
 interface PagingMetadataV2 {
@@ -2403,36 +2380,19 @@ interface GetPlanRequest {
     _id: string;
 }
 interface GetPlanResponse {
-    /** Pricing plan info.  */
+    /** Pricing plan. */
     plan?: Plan;
 }
 interface ListPlansRequest {
-    /**
-     * Archived filter.
-     *
-     * Default: `ACTIVE` (not archived).
-     */
+    /** Archived filter. Defaults to ACTIVE (not archived) only. */
     archived?: ArchivedFilter;
-    /**
-     * Visibility filter.
-     *
-     * Default: `PUBLIC_AND_HIDDEN` (meaning, both public and hidden plans are listed).
-     *
-     */
+    /** Visibility filter. Defaults to PUBLIC_AND_HIDDEN (meaning, both are listed). */
     public?: PublicFilter;
-    /**
-     * Number of pricing plans to list.
-     *
-     * Default: `75`.
-     */
+    /** Number of pricing plans to list. Defaults to 75. */
     limit?: number | null;
-    /**
-     * Number of pricing plans to skip.
-     *
-     * Default: `0`.
-     */
+    /** Number of pricing plans to skip. Defaults to 0. */
     offset?: number | null;
-    /** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    /** Plan ID filter. Non-existent IDs are ignored, and won't cause errors. You can pass a maximum of 100 IDs. */
     planIds?: string[];
 }
 declare enum ArchivedFilter {
@@ -2454,7 +2414,7 @@ declare enum PublicFilter {
 interface ListPlansResponse {
     /** List of all public and hidden pricing plans. */
     plans?: Plan[];
-    /** Details on the paged set of pricing plans returned.  */
+    /** Object containing paging-related data (number of plans returned, offset). */
     pagingMetadata?: PagingMetadataV2;
 }
 interface GetPlanStatsRequest {
@@ -2464,37 +2424,36 @@ interface GetPlanStatsResponse {
     totalPlans?: number;
 }
 interface CreatePlanRequest {
-    /** Information for the plan being created. */
+    /** Plan info. */
     plan: Plan;
 }
 interface CreatePlanResponse {
-    /** Plan info.  */
+    /** Created plan. */
     plan?: Plan;
 }
 interface UpdatePlanRequest {
-    /** Plan info to update. */
+    /** Plan info. */
     plan: Plan;
 }
 interface UpdatePlanResponse {
-    /** Updated plan info. */
+    /** Updated plan. */
     plan?: Plan;
 }
 interface SetPlanVisibilityRequest {
-    /** The ID of the plan to either display or hide on the site page.  */
+    /** Plan ID. */
     _id: string;
-    /** Whether to set the plan as visible. */
+    /** Whether a plan is visible to members and site visitors. Updates the `public` field. */
     visible: boolean;
 }
 interface SetPlanVisibilityResponse {
-    /** Plan info.  */
+    /** Pricing plan. */
     plan?: Plan;
 }
 interface MakePlanPrimaryRequest {
-    /** ID of the pricing plan to set as the primary plan. */
     _id: string;
 }
 interface MakePlanPrimaryResponse {
-    /** Primary plan info. */
+    /** Pricing plan. */
     plan?: Plan;
 }
 interface ClearPrimaryRequest {
@@ -2506,7 +2465,7 @@ interface ArchivePlanRequest {
     _id: string;
 }
 interface ArchivePlanResponse {
-    /** Archived plan info.  */
+    /** Archived plan. */
     plan?: Plan;
 }
 interface StringListNonNullableFields {