@wix/pricing-plans 1.0.6 → 1.0.8

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

@@ -1,105 +1,196 @@
 import { RequestOptionsFactory } from '@wix/sdk-types';
 import { CancelOrderRequest, CancelOrderResponse, CreateOfflineOrderRequest, CreateOfflineOrderResponse, GetOfflineOrderPreviewRequest, GetOfflineOrderPreviewResponse, GetOrderRequest, GetOrderResponse, GetPricePreviewRequest, GetPricePreviewResponse, ListOrdersRequest, ListOrdersResponse, MarkAsPaidRequest, MarkAsPaidResponse, MemberGetOrderRequest, MemberGetOrderResponse, MemberListOrdersRequest, MemberListOrdersResponse, RequestCancellationRequest, RequestCancellationResponse, PauseOrderRequest, PauseOrderResponse, PostponeEndDateRequest, PostponeEndDateResponse, ResumeOrderRequest, ResumeOrderResponse } from './pricing-plans-v2-order.types';
-/** 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.
+ */
 export declare function memberGetOrder(payload: MemberGetOrderRequest): RequestOptionsFactory<MemberGetOrderResponse>;
-/** 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.
+ */
 export declare function memberListOrders(payload: MemberListOrdersRequest): RequestOptionsFactory<MemberListOrdersResponse>;
 /**
- * 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.
  */
 export declare function requestCancellation(payload: RequestCancellationRequest): RequestOptionsFactory<RequestCancellationResponse>;
 /**
  * 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.
  */
 export declare function createOfflineOrder(payload: CreateOfflineOrderRequest): RequestOptionsFactory<CreateOfflineOrderResponse>;
 /**
- * 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 `getOfflineOrderPreview()` function returns a Promise that resolves to a temporary preview of the offline order.
+ *
+ * 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`.
  *
- * 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`.
+ * 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.
  *
- * 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).
+ * >**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.
  */
 export declare function getOfflineOrderPreview(payload: GetOfflineOrderPreviewRequest): RequestOptionsFactory<GetOfflineOrderPreviewResponse>;
 /**
- * Retrieves a plan's pricing.
+ * Retrieves a preview of an order's pricing as if it was purchased.
  *
- * 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 `getPricePreview()` function returns a Promise that resolves to a temporary preview of the order's price.
  *
- * 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).
+ * 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).
  */
 export declare function getPricePreview(payload: GetPricePreviewRequest): RequestOptionsFactory<GetPricePreviewResponse>;
-/** Retrieves an order by ID. */
+/**
+ * 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.
+ */
 export declare function managementGetOrder(payload: GetOrderRequest): RequestOptionsFactory<GetOrderResponse>;
 /**
- * Retrieves a list of orders and details, given the provided sorting and filtering.
+ * Lists pricing plan orders.
+ *
+ * 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.
  *
- * 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.
+ * 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.
  */
 export declare function managementListOrders(payload: ListOrdersRequest): RequestOptionsFactory<ListOrdersResponse>;
 /**
  * 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.
+ *
  */
 export declare function postponeEndDate(payload: PostponeEndDateRequest): RequestOptionsFactory<PostponeEndDateResponse>;
 /**
  * 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.
  */
 export declare function cancelOrder(payload: CancelOrderRequest): RequestOptionsFactory<CancelOrderResponse>;
 /**
  * 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.
  */
 export declare function markAsPaid(payload: MarkAsPaidRequest): RequestOptionsFactory<MarkAsPaidResponse>;
 /**
- * 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, `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.
+ *
+ * Pausing an order causes the following changes:
+ * - The order status changes to `"PAUSED"`.
+ * - The `pausePeriods` array is updated.
  *
- * 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.
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
  *
- * Use [Resume Order to resume a paused order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order/).
+ * 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.
  */
 export declare function pauseOrder(payload: PauseOrderRequest): RequestOptionsFactory<PauseOrderResponse>;
 /**
- * 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.
  */
 export declare function resumeOrder(payload: ResumeOrderRequest): RequestOptionsFactory<ResumeOrderResponse>;

package/build/cjs/src/pricing-plans-v2-order.http.js

@@ -349,7 +349,11 @@ function resolveComWixpressMembershipV2OrdersMemberMemberOrdersServiceUrl(opts)
     };
     return (0, metro_runtime_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
 }
-/** 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.
+ */
 function memberGetOrder(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_memberGetOrderRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_memberGetOrderResponse, {
@@ -377,7 +381,11 @@ function memberGetOrder(payload) {
     return __memberGetOrder;
 }
 exports.memberGetOrder = memberGetOrder;
-/** 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.
+ */
 function memberListOrders(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_memberListOrdersRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_memberListOrdersResponse, {
@@ -406,8 +414,16 @@ function memberListOrders(payload) {
 }
 exports.memberListOrders = memberListOrders;
 /**
- * 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.
  */
 function requestCancellation(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_requestCancellationRequest, {});
@@ -433,13 +449,23 @@ exports.requestCancellation = requestCancellation;
 /**
  * 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.
  */
 function createOfflineOrder(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_createOfflineOrderRequest, {});
@@ -469,17 +495,17 @@ function createOfflineOrder(payload) {
 }
 exports.createOfflineOrder = createOfflineOrder;
 /**
- * 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 `getOfflineOrderPreview()` function returns a Promise that resolves to a temporary preview of the offline order.
+ *
+ * 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`.
  *
- * 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`.
+ * 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.
  *
- * 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).
+ * >**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.
  */
 function getOfflineOrderPreview(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getOfflineOrderPreviewRequest, {});
@@ -509,14 +535,13 @@ function getOfflineOrderPreview(payload) {
 }
 exports.getOfflineOrderPreview = getOfflineOrderPreview;
 /**
- * Retrieves a plan's pricing.
+ * Retrieves a preview of an order's pricing as if it was purchased.
  *
- * 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 `getPricePreview()` function returns a Promise that resolves to a temporary preview of the order's price.
  *
- * 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).
+ * 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).
  */
 function getPricePreview(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getPricePreviewRequest, {});
@@ -539,7 +564,13 @@ function getPricePreview(payload) {
     return __getPricePreview;
 }
 exports.getPricePreview = getPricePreview;
-/** Retrieves an order by ID. */
+/**
+ * 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.
+ */
 function managementGetOrder(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getOrderRequest, {});
     const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getOrderResponse, {
@@ -568,10 +599,13 @@ function managementGetOrder(payload) {
 }
 exports.managementGetOrder = managementGetOrder;
 /**
- * Retrieves a list of orders and details, given the provided sorting and filtering.
+ * Lists pricing plan orders.
+ *
+ * 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.
  *
- * 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.
+ * 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.
  */
 function managementListOrders(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listOrdersRequest, {});
@@ -603,8 +637,18 @@ exports.managementListOrders = managementListOrders;
 /**
  * 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.
+ *
  */
 function postponeEndDate(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_postponeEndDateRequest, {});
@@ -630,20 +674,29 @@ exports.postponeEndDate = postponeEndDate;
 /**
  * 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.
  */
 function cancelOrder(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_cancelOrderRequest, {});
@@ -668,7 +721,24 @@ function cancelOrder(payload) {
 exports.cancelOrder = cancelOrder;
 /**
  * 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.
  */
 function markAsPaid(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_markAsPaidRequest, {});
@@ -692,12 +762,23 @@ function markAsPaid(payload) {
 }
 exports.markAsPaid = markAsPaid;
 /**
- * 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, `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.
+ *
+ * Pausing an order causes the following changes:
+ * - The order status changes to `"PAUSED"`.
+ * - The `pausePeriods` array is updated.
  *
- * 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.
+ * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
  *
- * Use [Resume Order to resume a paused order](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/orders/resume-order/).
+ * 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.
  */
 function pauseOrder(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_pauseOrderRequest, {});
@@ -721,11 +802,21 @@ function pauseOrder(payload) {
 }
 exports.pauseOrder = pauseOrder;
 /**
- * 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.
  */
 function resumeOrder(payload) {
     const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_resumeOrderRequest, {});