@wix/pricing-plans 1.0.7 → 1.0.9

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

@@ -25,8 +25,7 @@ export interface Order {
     /**
      * ID of the related Wix subscription.
      *
-     * Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. See here
-     * for a [Pricing Plans overview](https://support.wix.com/en/article/pricing-plans-an-overview#create-plans-to-suit-your-business).
+     * Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. See a [Pricing Plans overview](https://support.wix.com/en/article/pricing-plans-an-overview#create-plans-to-suit-your-business).
      * @readonly
      */
     subscriptionId?: string;
@@ -46,7 +45,8 @@ export interface Order {
      */
     buyer?: Buyer;
     /**
-     * __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
+     * @internal
+     * @internal
      * @readonly
      */
     priceDetails?: PriceDetails;
@@ -58,20 +58,20 @@ export interface Order {
      */
     pricing?: PricingDetails;
     /**
-     * How the order was processed. One of:
-     * + `ONLINE`: The buyer purchased the plan using the site.
-     * + `OFFLINE`: The buyer made a manual, offline purchase without using the site.
+     * How the order was processed. Supported values:
+     * + `"ONLINE"`: The buyer purchased the plan using the site.
+     * + `"OFFLINE"`: The buyer made a manual, offline purchase without using the site.
      * @readonly
      */
     type?: OrderType;
     /**
-     * Status of the order. One of:
+     * Status of the order. Supported values:
      * + `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://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order). The order, and use of the plan, can be [resumed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order).
+     * + `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).
      * + `ENDED`: Order has completed its duration and is no longer available for use.
-     * + `CANCELED`: Order has been [canceled](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/cancel-order).
+     * + `CANCELED`: Order has been [canceled](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/cancelorder).
      * @readonly
      */
     status?: OrderStatus;
@@ -91,7 +91,9 @@ export interface Order {
     cancellation?: Cancellation;
     /**
      * Status of the last payment for the order.
-     * Updated automatically for online orders. Updated manually by the site owner for offline orders. One of:
+     * Updated automatically for online orders. Updated manually by the site owner for offline orders.
+     *
+     * Supported values:
      * + `PAID`: The last payment was paid.
      * + `REFUNDED`: The last payment was refunded.
      * + `FAILED`: The last payment transaction didn't complete.
@@ -109,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://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order),
-     * it will have a later `endDate` once it [resumes](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order). `endDate` may also be [postponed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/postpone-end-date).
+     * `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).
      *
      * Omitted if the order is valid until canceled and still `ACTIVE`.
      * @readonly
@@ -170,12 +172,12 @@ export interface Order {
 }
 export interface Buyer {
     /**
-     * Member ID for a Wix site member. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members).
+     * Member ID for a buyer. Learn more about [`wix-members-backend`](https://www.wix.com/velo/reference/wix-members-backend/introduction).
      * @readonly
      */
     memberId?: string;
     /**
-     * Contact ID for a Wix site contact. See [Contacts to learn more about a site's contacts](https://dev.wix.com/api/rest/contacts/contacts/contacts-v4/contact-object).
+     * Contact ID for a buyer. Learn more about [Contacts in `wix-crm-backend`](https://www.wix.com/velo/reference/wix-crm-backend/contacts/introduction).
      * @readonly
      */
     contactId?: string;
@@ -321,11 +323,7 @@ export interface PriceDuration {
 export interface Price {
     /** Price of the order excluding tax, specified as a monetary amount. For example, `"9.99"`. */
     subtotal?: string;
-    /**
-     * Coupon applied to the order.
-     *
-     * See Coupons [to learn more about coupons](https://dev.wix.com/api/rest/coupons).
-     */
+    /** Coupon applied to the order. */
     coupon?: Coupon;
     /** Total discount applied to the order. */
     discount?: string;
@@ -436,10 +434,9 @@ export declare enum PaymentStatus {
 }
 export interface PausePeriod {
     /**
-     * Status of the pause period. One of:
-     *
-     * + `ACTIVE`: Status while the order is [paused](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order).
-     * + `ENDED`: Status when the order is [resumed](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order).
+     * 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).
      */
     status?: Status;
     /** Start date and time of the pause period. */
@@ -549,6 +546,7 @@ export declare enum SortOrder {
     DESC = "DESC"
 }
 export interface MemberListOrdersResponse {
+    /** List of orders. */
     orders?: Order[];
     /** Object containing paging-related data (number of orders returned, offset). */
     pagingMetadata?: PagingMetadataV2;
@@ -636,7 +634,14 @@ export interface QueryOrdersResponse {
 export interface RequestCancellationRequest {
     /** Order ID. */
     _id: string;
-    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
+    /**
+     * Whether to cancel the order immediately or at the next payment date.
+     * One-time payment orders can only be canceled immediately.
+     *
+     * Supported values:
+     * - `"IMMEDIATELY"`: Indicates that the order should be canceled immediately.
+     * - `"NEXT_PAYMENT_DATE"`: Indicates that the order be canceled at the next payment date.
+     */
     effectiveAt?: CancellationEffectiveAt;
 }
 export interface RequestCancellationResponse {
@@ -713,7 +718,7 @@ export interface CreateGuestOnlineOrderResponse {
 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). */
     planId: string;
-    /** ID of the member ordering the plan. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members). */
+    /** ID of the member ordering the plan. */
     memberId: string;
     /**
      * Start date and time for the ordered plan.
@@ -786,7 +791,7 @@ export interface GetGuestOnlineOrderPreviewResponse {
 export interface GetOfflineOrderPreviewRequest {
     /** 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). */
     planId: string;
-    /** Member ID of the buyer the previewed order is for. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members). */
+    /** Member ID of the buyer the previewed order is for. */
     memberId: string;
     /**
      * Start date and time for plan of the previewed order.
@@ -819,7 +824,9 @@ export interface GetPricePreviewRequest {
     couponCode?: string | null;
 }
 export interface GetPricePreviewResponse {
-    /** __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022. */
+    /**
+     * @internal
+     * @internal */
     price?: PriceDetails;
     /** Pricing details. */
     prices?: SpannedPrice[];
@@ -1080,20 +1087,26 @@ export interface BulkResumeOrderResponse {
     bulkActionMetadata?: BulkActionMetadata;
 }
 /**
- * Retrieves an order by ID.
+ * 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.
  * @param _id - Order ID.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param options - Options for getting a logged-in member's order.
  */
 export declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<MemberGetOrderResponse>;
 export interface MemberGetOrderOptions {
     fieldSet?: Set;
 }
 /**
- * Returns orders for currently logged in member.
+ * Lists orders for the currently logged-in member.
+ *
+ * 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>;
 export interface MemberListOrdersOptions {
@@ -1101,50 +1114,123 @@ export interface MemberListOrdersOptions {
     planIds?: string[];
     /** Filter for orders where auto renewal was canceled. */
     autoRenewCanceled?: boolean | null;
-    /** Filter by order status. */
+    /**
+     * Filter by the order status. Supported values:
+     * + `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).
+     * + `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).
+     */
     orderStatuses?: OrderStatus[];
-    /** Filter by payment status. */
+    /**
+     * Key Path to edit
+     * ManagementListOrdersOptions.paymentStatuses
+     * Production value
+     * Filter by payment status.
+     * Override
+     * Filter by payment status.
+     *
+     * Supported values:
+     * + `PAID`: The last payment was paid.
+     * + `REFUNDED`: The last payment was refunded.
+     * + `FAILED`: The last payment transaction didn't complete.
+     * + `UNPAID`: The last payment wasn't paid.
+     * + `PENDING`: Awaiting payment.
+     * + `NOT_APPLICABLE`: No payment was necessary. For example, for free plans or free trials.
+     * Mark down view
+     * Filter by payment status.
+     *
+     * Supported values:
+     *
+     * PAID: The last payment was paid.
+     * REFUNDED: The last payment was refunded.
+     * FAILED: The last payment transaction didn't complete.
+     * UNPAID: The last payment wasn't paid.
+     * PENDING: Awaiting payment.
+     * NOT_APPLICABLE: No payment was necessary. For example, for free plans or free trials.
+     */
     paymentStatuses?: PaymentStatus[];
-    /** Limit the number of pricing plans returned. Default limit is 50. */
+    /**
+     * Number of pricing plan orders to return.
+     *
+     * Default: `50`
+     */
     limit?: number | null;
-    /** Number of entries to offset. */
+    /** Number of orders to skip in the current sort order. */
     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). */
+    /**
+     * Sort order.
+     *
+     * Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     sorting?: Sorting;
 }
 /**
- * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date.
- * One time orders can only be canceled immediately.
+ * Starts the process of canceling an order.
+ *
+ *
+ * The `requestCancellation()` function returns a Promise that resolves when the order cancellation is successfully requested.
+ *
+ * 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.
+ *
+ * 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.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param options - Options for requesting a cancellation.
+ * @returns Fulfilled - When the cancellation process is started.
  */
 export declare function requestCancellation(_id: string, options?: RequestCancellationOptions): Promise<void>;
 export interface RequestCancellationOptions {
-    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
+    /**
+     * Whether to cancel the order immediately or at the next payment date.
+     * One-time payment orders can only be canceled immediately.
+     *
+     * Supported values:
+     * - `"IMMEDIATELY"`: Indicates that the order should be canceled immediately.
+     * - `"NEXT_PAYMENT_DATE"`: Indicates that the order be canceled at the next payment date.
+     */
     effectiveAt?: CancellationEffectiveAt;
 }
 /**
  * Creates an order for a buyer who purchased the plan with an offline transaction.
  *
- * An offline order is handled off of the Wix site and is marked as `offline` in `type`. If a pricing plan
- * has a limit on the amount of purchases per buyer, that limit is ignored for offline orders.
- * Tax is only applied if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).
+ * The `createOfflineOrder()` function returns a Promise that resolves to an `order` object when the order has been created.
+ *
+ * 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.
+ *
+ * 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"`.
+ * The order's last payment status is set to `"UNPAID"` or `"PAID"`.
+ *
+ * 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"`.
  *
- * Handle payment for an offline order in 1 of 2 ways:
- * + When creating the order, select `true` in the `paid` request parameter.
- * + After creation, use [Mark As Paid to mark the order as paid](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/mark-as-paid).
+ * 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.
+ * @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. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members). */
+    /** ID of the member ordering the plan. */
     memberId: string;
     /**
      * Start date and time for the ordered plan.
@@ -1158,37 +1244,35 @@ export interface CreateOfflineOrderOptions {
      * Default: `false`
      */
     paid?: boolean | null;
-    /**
-     * Coupon code to apply.
-     *
-     * See [Coupons to learn more](https://dev.wix.com/api/rest/coupons).
-     */
+    /** Coupon code to apply. */
     couponCode?: string | null;
-    /** Form submission id that was submitted together with the order */
+    /** Form submission ID that was submitted together with the order. */
     submissionId?: string | null;
 }
 /**
- * Performs a dry run of a purchase and provides an order preview.
+ * Provides a preview of an offline order as if it was purchased.
  *
- * The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually
- * created, the preview order's `orderId` and `subscriptionId` are displayed as a string of multiple zero characters
- * (`000000-0000`). Tax is only calculated if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).
- * <br>
- * 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`.
+ * The `getOfflineOrderPreview()` function returns a Promise that resolves to a temporary preview of the offline order.
  *
- * To get a general price preview for a plan that's not buyer-specific, use [Get Price Preview](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-price-preview).
+ * The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually created, the preview's `_id` and `subscriptionId` properties are displayed as a string of multiple zero characters (`000000-0000`).
+ *
+ * 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).
  * @public
  * @documentationMaturity preview
  * @requiredField options
  * @requiredField options.memberId
  * @requiredField planId
+ * @param options - Options for previewing the offline order.
+ * @returns Fulfilled - A preview of the order.
  */
 export declare function getOfflineOrderPreview(planId: string, options: GetOfflineOrderPreviewOptions): Promise<GetOfflineOrderPreviewResponse>;
 export interface GetOfflineOrderPreviewOptions {
-    /** Member ID of the buyer the previewed order is for. See [Members for more information about member IDs](https://dev.wix.com/api/rest/members/members). */
+    /** Member ID for the buyer who might order the plan offline. */
     memberId: string;
     /**
      * Start date and time for plan of the previewed order.
@@ -1196,67 +1280,91 @@ export interface GetOfflineOrderPreviewOptions {
      * Default: Current date and time
      */
     startDate?: Date;
-    /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */
+    /** Coupon code to apply. */
     couponCode?: string | null;
 }
 /**
- * Retrieves a plan's pricing.
+ * Retrieves a preview of an order's pricing as if it was purchased.
+ *
+ * The `getPricePreview()` function returns a Promise that resolves to a temporary preview of the order's price.
  *
- * The price preview uses the same logic as purchasing a plan, but the preview is not saved. Tax is only applied if
- * the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection). The price is returned
- * in the [pricing model](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models) format used for orders.
+ * 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 are not buyer-specific. To
- * generate a preview of a purchase for a specific buyer, use [Get Offline Order Preview](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/get-offline-order-preview).
+ * 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).
  * @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.
  */
 export declare function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise<GetPricePreviewResponse>;
 export interface GetPricePreviewOptions {
-    /**
-     * Coupon code to apply.
-     *
-     * See Coupons [to learn more](https://dev.wix.com/api/rest/coupons).
-     */
+    /** Coupon code to apply.  */
     couponCode?: string | null;
 }
 /**
  * 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.
  */
 export declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<GetOrderResponse>;
 export interface ManagementGetOrderOptions {
     fieldSet?: Set;
 }
 /**
- * Retrieves a list of orders and details, given the provided sorting and filtering.
+ * Lists pricing plan orders.
  *
- * By default, this endpoint will retrieve all orders and return them sorted by `createdDate` in `DESC`, descending order.
- * `sort.fieldName` supports `endDate` and `createdDate` fields and defaults to `ASC`, ascending order.
+ * 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.
  * @public
  * @documentationMaturity preview
+ * @param options - Filtering, sorting, and pagination options.
  */
 export declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<ListOrdersResponse>;
 export interface ManagementListOrdersOptions {
-    /** Filter by a buyer's member ID. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members). */
+    /** Filter by specific member IDs of buyers who ordered a pricing plan. */
     buyerIds?: string[];
-    /** Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */
+    /** Filter by specific IDs of plans that were ordered.  */
     planIds?: string[];
     /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
     autoRenewCanceled?: boolean | null;
-    /** Filter by order status. */
+    /**
+     * Filter by the order status. Supported values:
+     * + `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).
+     * + `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).
+     */
     orderStatuses?: OrderStatus[];
-    /** Filter by payment status. */
+    /**
+     * Filter by payment status.
+     *
+     * Supported values:
+     * + `PAID`: The last payment was paid.
+     * + `REFUNDED`: The last payment was refunded.
+     * + `FAILED`: The last payment transaction didn't complete.
+     * + `UNPAID`: The last payment wasn't paid.
+     * + `PENDING`: Awaiting payment.
+     * + `NOT_APPLICABLE`: No payment was necessary. For example, for free plans or free trials.
+     */
     paymentStatuses?: PaymentStatus[];
     /**
-     * Number of orders to return. See [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_paging) for more information.
+     * Number of pricing plan orders to return.
      *
-     * Max: `50`
+     * Default: `50`
      */
     limit?: number | null;
     /** Number of orders to skip in the current sort order. */
@@ -1273,12 +1381,26 @@ export interface ManagementListOrdersOptions {
 /**
  * Extends the duration of a pricing plan order by postponing the order's `endDate`.
  *
- * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
- * Can't postpone an order while it is [`PAUSED`](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order).
+ * The `postponeEndDate()` function returns a Promise that resolves when the order's end date is successfully changed.
+ *
+ * The new end date and time must be later than the order's current `endDate`.
+ *
+ * Postponing the end date of an order does not impact payments. For example, if the pricing plan is for a membership to an online lecture series, and you want to extend the duration of the series because the lecturer could not attend some sessions, you can postpone the end date of the orders for all relevant participants. The participants will not be billed additionally.
+ *
+ * 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.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param options - Options for postponing the end date of an order.
+ * @returns Fulfilled - When the order's end date has been postponed or made earlier.
+ *
+ *
  */
 export declare function postponeEndDate(_id: string, options?: PostponeEndDateOptions): Promise<void>;
 export interface PostponeEndDateOptions {
@@ -1292,61 +1414,119 @@ export interface PostponeEndDateOptions {
 /**
  * Cancels an existing order.
  *
+ * The `cancelOrder()` function returns a Promise that resolves when the order is successfully canceled.
+ *
  * 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 can only be set for `IMMEDIATELY`.
+ * 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.
  *
- * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end
- * of the free trial period and they will not be billed. The buyer may continue using the benefits until the end
- * of the free trial period.
+ * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
+ *
+ * When a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
+ *
+ * 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.
+ *
+ *
+ *
  *
- * When a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation
- * `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`. 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.
  * @param _id - Order ID.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @param options - Options for canceling orders.
+ * @returns Fulfilled - When the order is canceled.
  */
 export declare function cancelOrder(_id: string, options?: CancelOrderOptions): Promise<void>;
 export interface CancelOrderOptions {
-    /** __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;
 }
 /**
  * Marks an offline order as paid.
- * > __Note__: Marking separate payment cycles as paid is not yet supported. The entire order will be marked as paid.
+ *
+ * The `markAsPaid()` function returns a Promise that resolves when the offline order is successfully marked as paid.
+ *
+ * The entire order is marked as paid, even if the order's payments are recurring.
+ *
+ * >**Note:** Marking separate payment cycles as paid is not yet supported. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
+ *
+ * Marking an offline order as paid causes the following changes:
+ * - The order's `lastPaymentStatus` changes to `"PAID"`.
+ * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
+ *
+ * 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.
  */
 export declare function markAsPaid(_id: string): Promise<void>;
 /**
- * Pauses an order.
+ * Pauses a pricing plan order.
+ *
+ * The `pauseOrder()` function returns a Promise that resolves when the order is successfully paused.
  *
- * For orders with recurring payments, it also pauses the payment schedule. Buyers are not charged when an order is paused.
- * Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`. Can only pause orders with an `ACTIVE` status.
+ * For orders with recurring payments, `pauseOrder()` also pauses the payment schedule. Buyers are not charged when an order is paused. Use `pauseOrder()`, for example, if the buyer is away and would like to put their pricing plan membership on hold until they return. Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`. You can only pause orders with an `"ACTIVE`" status.
  *
- * Use [Resume Order to resume a paused order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order/).
+ * Pausing an order causes the following changes:
+ * - The order status changes to `"PAUSED"`.
+ * - The `pausePeriods` array is updated.
+ *
+ * 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.
  * @param _id - Order ID.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @returns Fulfilled - When the order is paused.
  */
 export declare function pauseOrder(_id: string): Promise<void>;
 /**
- * Resumes a paused order.
+ * Resumes a paused pricing plan order.
+ *
+ * The `resumeOrder()` function returns a Promise that resolves when a paused order is successfully resumed.
+ *
+ * For orders with recurring payments, `resumeOrder()` also restarts the payment schedule.
+ *
+ * Resuming an order causes the following changes:
+ * - 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.
  *
- * Updates `endDate` by adding the time the plan was paused.
- * For orders with recurring payments, it also restarts the payment schedule.
- * Use [Pause Order to pause an order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/pause-order/).
+ * >**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.
  * @param _id - Order ID.
  * @public
  * @documentationMaturity preview
  * @requiredField _id
+ * @returns Fulfilled - When the order is resumed.
  */
 export declare function resumeOrder(_id: string): Promise<void>;