@wix/pricing-plans 1.0.11 → 1.0.13

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

@@ -18,7 +18,7 @@ export interface Order {
      */
     _id?: string;
     /**
-     * ID of the plan purchased with the order. See [Plans for more information about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans/introduction).
+     * ID of the plan purchased with the order. See [Plans for more information about pricing plans](pricing-plans/plans)
      * @readonly
      */
     planId?: string;
@@ -51,9 +51,9 @@ export interface Order {
      */
     priceDetails?: PriceDetails;
     /**
-     * Order pricing model, price, and payment schedule.
+     * Pricing model, price, and payment schedule for the order.
      *
-     * [Learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models).
+     * [Learn more about pricing models](pricing-plans/plans)
      * @readonly
      */
     pricing?: PricingDetails;
@@ -69,9 +69,9 @@ export interface Order {
      * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.
      * + `PENDING`: Order has been purchased and its start date is set in the future.
      * + `ACTIVE`: Order has been processed. The plan is available for use.
-     * + `PAUSED`: Order, and use of the plan, is [paused](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/pauseorder). The order, and use of the plan, can be [resumed](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/resumeorder).
+     * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).
      * + `ENDED`: Order has completed its duration and is no longer available for use.
-     * + `CANCELED`: Order has been [canceled](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/cancelorder).
+     * + `CANCELED`: Order has been [canceled](#cancelorder).
      * @readonly
      */
     status?: OrderStatus;
@@ -111,8 +111,8 @@ export interface Order {
     /**
      * Current end date and time for the ordered plan.
      *
-     * `endDate` may be updated over the course of an order. If the order is [paused](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/pauseorder),
-     * it will have a later `endDate` once it [resumes](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/resumeorder). `endDate` may also be [postponed](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/postponeenddate).
+     * `endDate` may be updated over the course of an order. If the order is [paused](#pauseorder),
+     * it will have a later `endDate` once it [resumes](#resumeorder). `endDate` may also be [postponed](#postponeenddate).
      *
      * Omitted if the order is valid until canceled and still `ACTIVE`.
      * @readonly
@@ -172,12 +172,12 @@ export interface Order {
 }
 export interface Buyer {
     /**
-     * Member ID for a buyer. Learn more about [`wix-members-backend`](https://www.wix.com/velo/reference/wix-members-backend/introduction).
+     * Member ID for a buyer.
      * @readonly
      */
     memberId?: string;
     /**
-     * Contact ID for a buyer. Learn more about [Contacts in `wix-crm-backend`](https://www.wix.com/velo/reference/wix-crm-backend/contacts/introduction).
+     * Contact ID for a buyer.
      * @readonly
      */
     contactId?: string;
@@ -435,8 +435,8 @@ export declare enum PaymentStatus {
 export interface PausePeriod {
     /**
      * Status of the pause period. Supported values:
-     * + `ACTIVE`: Status while the order is [paused](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/pauseorder).
-     * + `ENDED`: Status when the order is [resumed](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/resumeorder).
+     * + `ACTIVE`: Status while the order is [paused](#pauseorder).
+     * + `ENDED`: Status when the order is [resumed](#resumeorder).
      */
     status?: Status;
     /** Start date and time of the pause period. */
@@ -534,6 +534,7 @@ export interface MemberListOrdersRequest {
     offset?: number | null;
     /** Sorting direction (defaults to ASC) and field to sort by. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */
     sorting?: Sorting;
+    fieldSet?: Set;
 }
 export interface Sorting {
     /** Name of the field to sort by. */
@@ -716,7 +717,7 @@ export interface CreateGuestOnlineOrderResponse {
     order?: Order;
 }
 export interface CreateOfflineOrderRequest {
-    /** ID of the plan being ordered. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */
+    /** ID of the plan being ordered. See [Plans for more information about plan IDs](pricing-plans/plans). */
     planId: string;
     /** ID of the member ordering the plan. */
     memberId: string;
@@ -927,6 +928,8 @@ export interface ListOrdersRequest {
      * Default: `DESC`
      */
     sorting?: Sorting;
+    /** Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL */
+    fieldSet?: Set;
 }
 export interface ListOrdersResponse {
     /** List of orders. */
@@ -1001,7 +1004,13 @@ export interface OrderEndDatePostponed {
 export interface CancelOrderRequest {
     /** Order ID. */
     _id: string;
-    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
+    /**
+     * When the order is canceled.
+     *
+     * One time orders can only be canceled immediately. Supported values:
+     * - `"IMMEDIATELY"`: The order is canceled immediately.
+     * - `"NEXT_PAYMENT_DATE"`: The order is canceled at the next payment date.
+     */
     effectiveAt: CancellationEffectiveAt;
 }
 export interface CancelOrderResponse {
@@ -1089,10 +1098,9 @@ export interface BulkResumeOrderResponse {
 /**
  * Gets an order by ID for the currently logged-in member.
  *
- * The `getCurrentMemberOrder()` function returns a Promise that resolves to information about a specified order for the currently logged-in member.
+ * The `memberGetOrder()` function returns a Promise that resolves to information about a specified order for the currently logged-in member.
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @param options - Options for getting a logged-in member's order.
  */
@@ -1105,7 +1113,6 @@ export interface MemberGetOrderOptions {
  *
  * The `memberListOrders()` function returns a Promise that resolves to a list of up to 100 pricing plan orders.
  * @public
- * @documentationMaturity preview
  * @param options - Filtering, sorting, and pagination options.
  */
 export declare function memberListOrders(options?: MemberListOrdersOptions): Promise<MemberListOrdersResponse>;
@@ -1119,9 +1126,9 @@ export interface MemberListOrdersOptions {
      * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.
      * + `PENDING`: Order has been purchased and its start date is set in the future.
      * + `ACTIVE`: Order has been processed. The plan is available for use.
-     * + `PAUSED`: Order, and use of the plan, is [paused](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/pauseorder). The order, and use of the plan, can be [resumed](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/resumeorder).
+     * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).
      * + `ENDED`: Order has completed its duration and is no longer available for use.
-     * + `CANCELED`: Order has been [canceled](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/cancelorder).
+     * + `CANCELED`: Order has been [canceled](#cancelorder).
      */
     orderStatuses?: OrderStatus[];
     /**
@@ -1168,6 +1175,7 @@ export interface MemberListOrdersOptions {
      * Default: `ASC`
      */
     sorting?: Sorting;
+    fieldSet?: Set;
 }
 /**
  * Starts the process of canceling an order.
@@ -1177,9 +1185,8 @@ export interface MemberListOrdersOptions {
  *
  * For orders with recurring payments, a cancellation can be set to occur either immediately or at the next payment date. For orders with one-time payments, a cancellation occurs immediately after the request is processed.
  *
- * Requesting an order cancellation starts the cancellation process. The event is triggered immediately and the function's promise is fulfilled. However, there may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
+ * Requesting an order cancellation starts the cancellation process. There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
  *
- * The [`onOrderUpdated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderupdated) event handler runs when a cancellation is requested. The [`onOrderCanceled()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onordercanceled) event handler runs when the cancellation is completed.
  * @param _id - Order ID.
  * @param effectiveAt - Whether to cancel the order immediately or at the next payment date.
  * One-time payment orders can only be canceled immediately.
@@ -1188,7 +1195,6 @@ export interface MemberListOrdersOptions {
  * - `"IMMEDIATELY"`: Indicates that the order should be canceled immediately.
  * - `"NEXT_PAYMENT_DATE"`: Indicates that the order be canceled at the next payment date.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField effectiveAt
  * @param options - Options for requesting a cancellation.
@@ -1202,7 +1208,7 @@ export declare function requestCancellation(_id: string, effectiveAt: Cancellati
  *
  * Payment of an offline order is handled in 1 of 2 ways.
  * - When creating the order, select `true` in the `paid` request parameter.
- * - After creation, with the [`markAsPaid()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/markaspaid) function.
+ * - After creation, with the [`markAsPaid()`](#markaspaid) function.
  *
  * When creating a non-free offline order:
  * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
@@ -1211,22 +1217,21 @@ export declare function requestCancellation(_id: string, effectiveAt: Cancellati
  * When creating a free offline order:
  * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
  * - The order's last payment status is set to `"NOT_APPLICABLE"`.
- *
- * The [`onOrderCreated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onordercreated) event handler runs when an offline order is created.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the "Manage Pricing Plans" and "Manage Subscriptions" permissions can create offline orders.
- * @param planId - ID of the plan being ordered. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).
  * @public
- * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
  * @param options - Options for creating an offline order.
+ * @param planId - ID of the plan being ordered. See [Plans for more information about plan IDs](pricing-plans/plans)
  * @returns Fulfilled - The order of the plan.
  */
 export declare function createOfflineOrder(planId: string, options: CreateOfflineOrderOptions): Promise<CreateOfflineOrderResponse>;
 export interface CreateOfflineOrderOptions {
-    /** ID of the member ordering the plan. */
+    /**
+     * ID of the member ordering the plan.
+     * This field is required when creating an offline order.
+     *
+     */
     memberId: string;
     /**
      * Start date and time for the ordered plan.
@@ -1254,21 +1259,21 @@ export interface CreateOfflineOrderOptions {
  *
  * If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, `tax` previews as `null`.
  *
- * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/getpricepreview) function.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the "Manage Pricing Plans" and "Manage Subscriptions" permissions can get offline order previews.
- * @param planId - ID of the plan of the previewed order. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).
+ * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](#getpricepreview) function.
  * @public
- * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
  * @param options - Options for previewing the offline order.
+ * @param planId - ID of the plan of the previewed order. See [Plans for more information about plan IDs](pricing-plans/plans)
  * @returns Fulfilled - A preview of the order.
  */
 export declare function getOfflineOrderPreview(planId: string, options: GetOfflineOrderPreviewOptions): Promise<GetOfflineOrderPreviewResponse>;
 export interface GetOfflineOrderPreviewOptions {
-    /** Member ID for the buyer who might order the plan offline. */
+    /**
+     * Member ID for the buyer who might order the plan offline.
+     * This field is required to get an offline order preview.
+     */
     memberId: string;
     /**
      * Start date and time for plan of the previewed order.
@@ -1284,12 +1289,11 @@ export interface GetOfflineOrderPreviewOptions {
  *
  * The `getPricePreview()` function returns a Promise that resolves to a temporary preview of the order's price.
  *
- * The price preview uses the same logic for calculating prices as used when purchasing a plan, but the preview is not saved. If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection for the site, taxes are applied to the preview. If not, the `tax` previews as `null`.
+ * The price preview uses the same logic for calculating prices as used when purchasing a plan, but the preview is not saved. If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, the `tax` previews as `null`.
  *
- * Buyers do not have to be logged in to preview the price, as such, the details returned by this function are not buyer-specific. To generate a preview of a purchase for a specific-buyer, use the [`getOfflineOrderPreview()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/getofflineorderpreview).
+ * Buyers do not have to be logged in to preview the price, as such, the details returned by this function are not buyer-specific. To generate a preview of a purchase for a specific-buyer, use the [`getOfflineOrderPreview()`](#getofflineorderpreview).
  * @param planId - ID of plan to preview.
  * @public
- * @documentationMaturity preview
  * @requiredField planId
  * @param options - Options for getting a price preview.
  * @returns Fulfilled - A preview of the pricing for the order.
@@ -1303,11 +1307,8 @@ export interface GetPricePreviewOptions {
  * Retrieves an order by ID.
  *
  * The `managementGetOrder()` function returns a Promise that resolves to information about the specified order.
- *
- * >**Note:** Only users with the "Manage Pricing Plans" and "Manage Subscriptions" permissions can get orders.
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @param options - Options to use when getting an order.
  * @returns Order.
@@ -1321,11 +1322,8 @@ export interface ManagementGetOrderOptions {
  *
  * The `managementListOrders()` function returns a Promise that resolves to a list of up to 50 pricing plan orders. You can specify options for filtering, sorting, and paginating the results.
  *
- * This function returns the orders on the site. To list orders for the currently logged-in member, use [`listMemberOrders()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/memberlistorders).
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can list orders.
+ * This function returns the orders on the site. To list orders for the currently logged-in member, use [`memberListOrders()`](#memberlistorders).
  * @public
- * @documentationMaturity preview
  * @param options - Filtering, sorting, and pagination options.
  */
 export declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<ListOrdersResponse>;
@@ -1341,9 +1339,9 @@ export interface ManagementListOrdersOptions {
      * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.
      * + `PENDING`: Order has been purchased and its start date is set in the future.
      * + `ACTIVE`: Order has been processed. The plan is available for use.
-     * + `PAUSED`: Order, and use of the plan, is [paused](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/pauseorder). The order, and use of the plan, can be [resumed](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/resumeorder).
+     * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).
      * + `ENDED`: Order has completed its duration and is no longer available for use.
-     * + `CANCELED`: Order has been [canceled](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/cancelorder).
+     * + `CANCELED`: Order has been [canceled](#cancelorder).
      */
     orderStatuses?: OrderStatus[];
     /**
@@ -1374,6 +1372,8 @@ export interface ManagementListOrdersOptions {
      * Default: `DESC`
      */
     sorting?: Sorting;
+    /** Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL */
+    fieldSet?: Set;
 }
 /**
  * Extends the duration of a pricing plan order by postponing the order's `endDate`.
@@ -1386,16 +1386,11 @@ export interface ManagementListOrdersOptions {
  *
  * Postponing an order causes the following changes:
  * - The `endDate` for the order is adjusted to the new end date.
- * The `onOrderEndDatePostponed()` and `onOrderUpdated()` event handlers run when an order's end date is postponed or made earlier.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can postpone the end date of an order.
- *
  * @param _id - Order ID.
  * @param endDate - New end date and time.
  *
  * Must be later than the current end date and time.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField endDate
  * @param options - Options for postponing the end date of an order.
@@ -1413,7 +1408,6 @@ export declare function postponeEndDate(_id: string, endDate: Date): Promise<voi
  * For orders with one-time payments, a cancellation occurs `IMMEDIATELY`.
  *
  * Canceling an order changes the order status to `"CANCELED"`.
- * The [`onOrderCanceled()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onordercanceled) event handler runs when an order is canceled.
  *
  * #### Canceling during the free trial period.
  *
@@ -1424,16 +1418,13 @@ export declare function postponeEndDate(_id: string, endDate: Date): Promise<voi
  * Canceling `IMMEDIATELY` will end the subscription for the buyer
  * immediately, even during the free trial period and the buyer won't be billed.
  * Canceling at the `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period. Then, the subscription ends and the buyer is not billed.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only users with the "Manage Pricing Plans" and "Manage Subscription" permissions can cancel orders.
- *
- *
- *
- *
  * @param _id - Order ID.
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
+ * @param effectiveAt - When the order is canceled.
+ *
+ * One time orders can only be canceled immediately. Supported values:
+ * - `"IMMEDIATELY"`: The order is canceled immediately.
+ * - `"NEXT_PAYMENT_DATE"`: The order is canceled at the next payment date.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField effectiveAt
  * @param options - Options for canceling orders.
@@ -1456,13 +1447,8 @@ export declare function cancelOrder(_id: string, effectiveAt: CancellationEffect
  * An error occurs if you attempt to:
  * - Mark an already-paid, offline order as paid. You cannot make an offline order as paid twice.
  * - Mark an online order as paid. The `markAsPaid()` function is supported for offline orders only.
- *
- * The [`onOrderMarkedAsPaid()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onordermarkedaspaid) and [`onOrderUpdated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderupdated) event handlers run when an offline order is marked as paid.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can mark offline orders as paid.
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @returns Fulfilled - When the order is marked as paid.
  */
@@ -1480,14 +1466,9 @@ export declare function markAsPaid(_id: string): Promise<void>;
  *
  * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
  *
- * The [`onOrderPaused()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderpaused) and [`onOrderUpdated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderupdated) event handlers run when an order is paused.
- *
- * Paused orders can be continued with the [`resumeOrder()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/resumeorder) function.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can pause orders.
+ * Paused orders can be continued with the [`resumeOrder()`](#resumeorder) function.
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @returns Fulfilled - When the order is paused.
  */
@@ -1503,14 +1484,9 @@ export declare function pauseOrder(_id: string): Promise<void>;
  * - The order status changes to `"ACTIVE"`.
  * - The `pausePeriods` array is updated.
  * - The `endDate` for the order is adjusted to include the pause period.
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use.)
- *
- * The [`onOrderResumed()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderresumed) and [`onOrderUpdated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderupdated) event handlers run when an order is resumed.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can resume orders.
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @returns Fulfilled - When the order is resumed.
  */

package/build/es/src/pricing-plans-v2-order.universal.js

@@ -182,10 +182,9 @@ const _resumeOrderResponse = {};
 /**
  * Gets an order by ID for the currently logged-in member.
  *
- * The `getCurrentMemberOrder()` function returns a Promise that resolves to information about a specified order for the currently logged-in member.
+ * The `memberGetOrder()` function returns a Promise that resolves to information about a specified order for the currently logged-in member.
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @param options - Options for getting a logged-in member's order.
  */
@@ -238,7 +237,6 @@ export function memberGetOrder(_id, options) {
  *
  * The `memberListOrders()` function returns a Promise that resolves to a list of up to 100 pricing plan orders.
  * @public
- * @documentationMaturity preview
  * @param options - Filtering, sorting, and pagination options.
  */
 export function memberListOrders(options) {
@@ -252,6 +250,7 @@ export function memberListOrders(options) {
             limit: '$[0].limit',
             offset: '$[0].offset',
             sorting: '$[0].sorting',
+            fieldSet: '$[0].fieldSet',
         };
         const responseTransformation = '$';
         // @ts-ignore
@@ -300,9 +299,8 @@ export function memberListOrders(options) {
  *
  * For orders with recurring payments, a cancellation can be set to occur either immediately or at the next payment date. For orders with one-time payments, a cancellation occurs immediately after the request is processed.
  *
- * Requesting an order cancellation starts the cancellation process. The event is triggered immediately and the function's promise is fulfilled. However, there may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
+ * Requesting an order cancellation starts the cancellation process. There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
  *
- * The [`onOrderUpdated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderupdated) event handler runs when a cancellation is requested. The [`onOrderCanceled()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onordercanceled) event handler runs when the cancellation is completed.
  * @param _id - Order ID.
  * @param effectiveAt - Whether to cancel the order immediately or at the next payment date.
  * One-time payment orders can only be canceled immediately.
@@ -311,7 +309,6 @@ export function memberListOrders(options) {
  * - `"IMMEDIATELY"`: Indicates that the order should be canceled immediately.
  * - `"NEXT_PAYMENT_DATE"`: Indicates that the order be canceled at the next payment date.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField effectiveAt
  * @param options - Options for requesting a cancellation.
@@ -368,7 +365,7 @@ export function requestCancellation(_id, effectiveAt) {
  *
  * Payment of an offline order is handled in 1 of 2 ways.
  * - When creating the order, select `true` in the `paid` request parameter.
- * - After creation, with the [`markAsPaid()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/markaspaid) function.
+ * - After creation, with the [`markAsPaid()`](#markaspaid) function.
  *
  * When creating a non-free offline order:
  * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
@@ -377,17 +374,12 @@ export function requestCancellation(_id, effectiveAt) {
  * When creating a free offline order:
  * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
  * - The order's last payment status is set to `"NOT_APPLICABLE"`.
- *
- * The [`onOrderCreated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onordercreated) event handler runs when an offline order is created.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the "Manage Pricing Plans" and "Manage Subscriptions" permissions can create offline orders.
- * @param planId - ID of the plan being ordered. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).
  * @public
- * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
  * @param options - Options for creating an offline order.
+ * @param planId - ID of the plan being ordered. See [Plans for more information about plan IDs](pricing-plans/plans)
  * @returns Fulfilled - The order of the plan.
  */
 export function createOfflineOrder(planId, options) {
@@ -450,16 +442,13 @@ export function createOfflineOrder(planId, options) {
  *
  * If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, `tax` previews as `null`.
  *
- * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/getpricepreview) function.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the "Manage Pricing Plans" and "Manage Subscriptions" permissions can get offline order previews.
- * @param planId - ID of the plan of the previewed order. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans).
+ * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](#getpricepreview) function.
  * @public
- * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
  * @param options - Options for previewing the offline order.
+ * @param planId - ID of the plan of the previewed order. See [Plans for more information about plan IDs](pricing-plans/plans)
  * @returns Fulfilled - A preview of the order.
  */
 export function getOfflineOrderPreview(planId, options) {
@@ -516,12 +505,11 @@ export function getOfflineOrderPreview(planId, options) {
  *
  * The `getPricePreview()` function returns a Promise that resolves to a temporary preview of the order's price.
  *
- * The price preview uses the same logic for calculating prices as used when purchasing a plan, but the preview is not saved. If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection for the site, taxes are applied to the preview. If not, the `tax` previews as `null`.
+ * The price preview uses the same logic for calculating prices as used when purchasing a plan, but the preview is not saved. If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, the `tax` previews as `null`.
  *
- * Buyers do not have to be logged in to preview the price, as such, the details returned by this function are not buyer-specific. To generate a preview of a purchase for a specific-buyer, use the [`getOfflineOrderPreview()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/getofflineorderpreview).
+ * Buyers do not have to be logged in to preview the price, as such, the details returned by this function are not buyer-specific. To generate a preview of a purchase for a specific-buyer, use the [`getOfflineOrderPreview()`](#getofflineorderpreview).
  * @param planId - ID of plan to preview.
  * @public
- * @documentationMaturity preview
  * @requiredField planId
  * @param options - Options for getting a price preview.
  * @returns Fulfilled - A preview of the pricing for the order.
@@ -577,11 +565,8 @@ export function getPricePreview(planId, options) {
  * Retrieves an order by ID.
  *
  * The `managementGetOrder()` function returns a Promise that resolves to information about the specified order.
- *
- * >**Note:** Only users with the "Manage Pricing Plans" and "Manage Subscriptions" permissions can get orders.
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @param options - Options to use when getting an order.
  * @returns Order.
@@ -635,11 +620,8 @@ export function managementGetOrder(_id, options) {
  *
  * The `managementListOrders()` function returns a Promise that resolves to a list of up to 50 pricing plan orders. You can specify options for filtering, sorting, and paginating the results.
  *
- * This function returns the orders on the site. To list orders for the currently logged-in member, use [`listMemberOrders()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/memberlistorders).
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can list orders.
+ * This function returns the orders on the site. To list orders for the currently logged-in member, use [`memberListOrders()`](#memberlistorders).
  * @public
- * @documentationMaturity preview
  * @param options - Filtering, sorting, and pagination options.
  */
 export function managementListOrders(options) {
@@ -654,6 +636,7 @@ export function managementListOrders(options) {
             limit: '$[0].limit',
             offset: '$[0].offset',
             sorting: '$[0].sorting',
+            fieldSet: '$[0].fieldSet',
         };
         const responseTransformation = '$';
         // @ts-ignore
@@ -705,16 +688,11 @@ export function managementListOrders(options) {
  *
  * Postponing an order causes the following changes:
  * - The `endDate` for the order is adjusted to the new end date.
- * The `onOrderEndDatePostponed()` and `onOrderUpdated()` event handlers run when an order's end date is postponed or made earlier.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can postpone the end date of an order.
- *
  * @param _id - Order ID.
  * @param endDate - New end date and time.
  *
  * Must be later than the current end date and time.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField endDate
  * @param options - Options for postponing the end date of an order.
@@ -775,7 +753,6 @@ export function postponeEndDate(_id, endDate) {
  * For orders with one-time payments, a cancellation occurs `IMMEDIATELY`.
  *
  * Canceling an order changes the order status to `"CANCELED"`.
- * The [`onOrderCanceled()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onordercanceled) event handler runs when an order is canceled.
  *
  * #### Canceling during the free trial period.
  *
@@ -786,16 +763,13 @@ export function postponeEndDate(_id, endDate) {
  * Canceling `IMMEDIATELY` will end the subscription for the buyer
  * immediately, even during the free trial period and the buyer won't be billed.
  * Canceling at the `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period. Then, the subscription ends and the buyer is not billed.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only users with the "Manage Pricing Plans" and "Manage Subscription" permissions can cancel orders.
- *
- *
- *
- *
  * @param _id - Order ID.
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
+ * @param effectiveAt - When the order is canceled.
+ *
+ * One time orders can only be canceled immediately. Supported values:
+ * - `"IMMEDIATELY"`: The order is canceled immediately.
+ * - `"NEXT_PAYMENT_DATE"`: The order is canceled at the next payment date.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @requiredField effectiveAt
  * @param options - Options for canceling orders.
@@ -861,13 +835,8 @@ export function cancelOrder(_id, effectiveAt) {
  * An error occurs if you attempt to:
  * - Mark an already-paid, offline order as paid. You cannot make an offline order as paid twice.
  * - Mark an online order as paid. The `markAsPaid()` function is supported for offline orders only.
- *
- * The [`onOrderMarkedAsPaid()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onordermarkedaspaid) and [`onOrderUpdated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderupdated) event handlers run when an offline order is marked as paid.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can mark offline orders as paid.
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @returns Fulfilled - When the order is marked as paid.
  */
@@ -927,14 +896,9 @@ export function markAsPaid(_id) {
  *
  * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
  *
- * The [`onOrderPaused()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderpaused) and [`onOrderUpdated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderupdated) event handlers run when an order is paused.
- *
- * Paused orders can be continued with the [`resumeOrder()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/resumeorder) function.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can pause orders.
+ * Paused orders can be continued with the [`resumeOrder()`](#resumeorder) function.
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @returns Fulfilled - When the order is paused.
  */
@@ -992,14 +956,9 @@ export function pauseOrder(_id) {
  * - The order status changes to `"ACTIVE"`.
  * - The `pausePeriods` array is updated.
  * - The `endDate` for the order is adjusted to include the pause period.
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use.)
- *
- * The [`onOrderResumed()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderresumed) and [`onOrderUpdated()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/events/onorderupdated) event handlers run when an order is resumed.
- *
- * >**Note:** This function is restricted and only runs if you elevate permissions using the [`wix-auth.elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function. If `wix-auth.elevate()` is not used, only those with the “Manage Pricing Plans” and “Manage Subscriptions” permissions can resume orders.
+ * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
  * @param _id - Order ID.
  * @public
- * @documentationMaturity preview
  * @requiredField _id
  * @returns Fulfilled - When the order is resumed.
  */