@wix/auto_sdk_pricing-plans_orders 1.0.95 → 1.0.97

package/build/cjs/index.d.ts

@@ -1,125 +1,15 @@
 import { HttpClient, NonNullablePaths, EventDefinition, MaybeContext, BuildRESTFunction, BuildEventDefinition } from '@wix/sdk-types';
-import { ManagementGetOrderOptions, GetOrderResponse, ManagementListOrdersOptions, ListOrdersResponse, CancellationEffectiveAtWithLiterals, MemberGetOrderOptions, Order, MemberListOrdersOptions, MemberListOrdersResponse, CreateOnlineOrderOptions, CreateOnlineOrderResponse, CreateOnlineOrderApplicationErrors, CreateOnlineOrderValidationErrors, CreateOfflineOrderOptions, CreateOfflineOrderResponse, CreateOfflineOrderApplicationErrors, CreateOfflineOrderValidationErrors, GetOnlineOrderPreviewOptions, GetOnlineOrderPreviewResponse, GetOnlineOrderPreviewApplicationErrors, GetOnlineOrderPreviewValidationErrors, GetOfflineOrderPreviewOptions, GetOfflineOrderPreviewResponse, GetOfflineOrderPreviewApplicationErrors, GetOfflineOrderPreviewValidationErrors, GetPricePreviewOptions, GetPricePreviewResponse, GetPricePreviewApplicationErrors, OrderAutoRenewCanceledEnvelope, OrderCanceledEnvelope, OrderCycleStartedEnvelope, OrderEndDatePostponedEnvelope, OrderEndedEnvelope, OrderMarkedAsPaidEnvelope, OrderPausedEnvelope, OrderPurchasedEnvelope, OrderResumedEnvelope, OrderStartedEnvelope, OrderUpdatedEnvelope, OrderCreatedEnvelope, OrderStartDateChangedEnvelope } from './index.typings.js';
-export { AccountInfo, ActionEvent, ApplicationError, ApplyCouponRequest, ApplyCouponResponse, BaseEventMetadata, BulkActionMetadata, BulkOrderResult, BulkPauseOrderRequest, BulkPauseOrderResponse, BulkResumeOrderRequest, BulkResumeOrderResponse, Buyer, CancelOrderRequest, CancelOrderResponse, Cancellation, CancellationCause, CancellationCauseWithLiterals, CancellationEffectiveAt, Captcha, ChangeStartDateRequest, ChangeStartDateResponse, Coupon, CouponsError, CreateExternalOrderRequest, CreateExternalOrderResponse, CreateGuestOnlineOrderRequest, CreateGuestOnlineOrderResponse, CreateOfflineOrderRequest, CreateOnlineOrderRequest, CurrentCycle, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, Duration, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Fee, FormData, GetAvailableOrderActionsRequest, GetAvailableOrderActionsResponse, GetGuestOnlineOrderPreviewRequest, GetGuestOnlineOrderPreviewResponse, GetOfflineOrderPreviewRequest, GetOnlineOrderPreviewRequest, GetOrderRequest, GetOrdersStatsRequest, GetOrdersStatsResponse, GetPricePreviewRequest, Guest, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ListOrdersRequest, MarkAsPaidRequest, MarkAsPaidResponse, MemberGetOrderRequest, MemberGetOrderResponse, MemberListOrdersRequest, MessageEnvelope, OnBehalf, OrderAutoRenewCanceled, OrderCanceled, OrderCycle, OrderCycleStarted, OrderEndDatePostponed, OrderEnded, OrderMarkedAsPaid, OrderMethod, OrderMethodWithLiterals, OrderPaused, OrderPurchased, OrderResumed, OrderStartDateChanged, OrderStarted, OrderStatus, OrderStatusWithLiterals, OrderType, OrderTypeWithLiterals, OrdersQueryOrdersRequest, OrdersQueryOrdersResponse, Paging, PagingMetadataV2, PauseOrderRequest, PauseOrderResponse, PausePeriod, PaymentStatus, PaymentStatusWithLiterals, PeriodUnit, PeriodUnitWithLiterals, PostponeEndDateRequest, PostponeEndDateResponse, Price, PriceDetails, PriceDetailsPricingModelOneOf, PriceDuration, PricingDetails, PricingDetailsPricingModelOneOf, QueryOrdersRequest, QueryOrdersResponse, QueryV2, QueryV2PagingMethodOneOf, ReasonNotSuspendable, ReasonNotSuspendableWithLiterals, Recurrence, RequestCancellationRequest, RequestCancellationResponse, RestoreInfo, ResumeOrderRequest, ResumeOrderResponse, Set, SetSubmissionRequest, SetSubmissionResponse, SetWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, SpannedPrice, Status, StatusWithLiterals, Tax, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
+import { MemberGetOrderOptions, MemberGetOrderResponse, MemberListOrdersOptions, MemberListOrdersResponse, CancellationEffectiveAtWithLiterals, CreateOnlineOrderOptions, CreateOnlineOrderResponse, CreateOnlineOrderApplicationErrors, CreateOnlineOrderValidationErrors, CreateOfflineOrderOptions, CreateOfflineOrderResponse, CreateOfflineOrderApplicationErrors, CreateOfflineOrderValidationErrors, GetOnlineOrderPreviewOptions, GetOnlineOrderPreviewResponse, GetOnlineOrderPreviewApplicationErrors, GetOnlineOrderPreviewValidationErrors, GetOfflineOrderPreviewOptions, GetOfflineOrderPreviewResponse, GetOfflineOrderPreviewApplicationErrors, GetOfflineOrderPreviewValidationErrors, GetPricePreviewOptions, GetPricePreviewResponse, GetPricePreviewApplicationErrors, ManagementGetOrderOptions, Order, ManagementListOrdersOptions, ListOrdersResponse, OrderCanceledEnvelope, OrderCreatedEnvelope, OrderStartDateChangedEnvelope, OrderUpdatedEnvelope, OrderAutoRenewCanceledEnvelope, OrderCycleStartedEnvelope, OrderEndDatePostponedEnvelope, OrderEndedEnvelope, OrderMarkedAsPaidEnvelope, OrderPausedEnvelope, OrderPurchasedEnvelope, OrderResumedEnvelope, OrderStartedEnvelope } from './index.typings.js';
+export { AccountInfo, ActionEvent, ApplicationError, ApplyCouponRequest, ApplyCouponResponse, BaseEventMetadata, BulkActionMetadata, BulkOrderResult, BulkPauseOrderRequest, BulkPauseOrderResponse, BulkResumeOrderRequest, BulkResumeOrderResponse, Buyer, CancelOrderRequest, CancelOrderResponse, Cancellation, CancellationCause, CancellationCauseWithLiterals, CancellationEffectiveAt, Captcha, ChangeStartDateRequest, ChangeStartDateResponse, Coupon, CouponsError, CreateExternalOrderRequest, CreateExternalOrderResponse, CreateGuestOnlineOrderRequest, CreateGuestOnlineOrderResponse, CreateOfflineOrderRequest, CreateOnlineOrderRequest, CurrentCycle, CursorPaging, Cursors, DomainEvent, DomainEventBodyOneOf, Duration, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, EventMetadata, Fee, FormData, GetAvailableOrderActionsRequest, GetAvailableOrderActionsResponse, GetGuestOnlineOrderPreviewRequest, GetGuestOnlineOrderPreviewResponse, GetOfflineOrderPreviewRequest, GetOnlineOrderPreviewRequest, GetOrderRequest, GetOrderResponse, GetOrdersStatsRequest, GetOrdersStatsResponse, GetPricePreviewRequest, Guest, IdentificationData, IdentificationDataIdOneOf, ItemMetadata, ListOrdersRequest, MarkAsPaidRequest, MarkAsPaidResponse, MemberGetOrderRequest, MemberListOrdersRequest, MessageEnvelope, OnBehalf, OrderAutoRenewCanceled, OrderCanceled, OrderCycle, OrderCycleStarted, OrderEndDatePostponed, OrderEnded, OrderMarkedAsPaid, OrderMethod, OrderMethodWithLiterals, OrderPaused, OrderPurchased, OrderResumed, OrderStartDateChanged, OrderStarted, OrderStatus, OrderStatusWithLiterals, OrderType, OrderTypeWithLiterals, OrdersQueryOrdersRequest, OrdersQueryOrdersResponse, Paging, PagingMetadataV2, PauseOrderRequest, PauseOrderResponse, PausePeriod, PaymentStatus, PaymentStatusWithLiterals, PeriodUnit, PeriodUnitWithLiterals, PostponeEndDateRequest, PostponeEndDateResponse, Price, PriceDetails, PriceDetailsPricingModelOneOf, PriceDuration, PricingDetails, PricingDetailsPricingModelOneOf, QueryOrdersRequest, QueryOrdersResponse, QueryV2, QueryV2PagingMethodOneOf, ReasonNotSuspendable, ReasonNotSuspendableWithLiterals, Recurrence, RequestCancellationRequest, RequestCancellationResponse, RestoreInfo, ResumeOrderRequest, ResumeOrderResponse, Set, SetSubmissionRequest, SetSubmissionResponse, SetWithLiterals, SortOrder, SortOrderWithLiterals, Sorting, SpannedPrice, Status, StatusWithLiterals, Tax, WebhookIdentityType, WebhookIdentityTypeWithLiterals } from './index.typings.js';
 
-declare function managementGetOrder$1(httpClient: HttpClient): ManagementGetOrderSignature;
-interface ManagementGetOrderSignature {
-    /**
-     * Retrieves an order by ID.
-     * @param - Order ID.
-     * @param - Options to use when getting an order.
-     */
-    (_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<GetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
-}
-declare function managementListOrders$1(httpClient: HttpClient): ManagementListOrdersSignature;
-interface ManagementListOrdersSignature {
-    /**
-     * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
-     *
-     * 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.
-     * @param - Filtering, sorting, and pagination options.
-     */
-    (options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
-}
-declare function postponeEndDate$1(httpClient: HttpClient): PostponeEndDateSignature;
-interface PostponeEndDateSignature {
-    /**
-     * Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
-     *
-     * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
-     * Can't postpone an order with `status`: `PAUSED`.
-     * @param - Order ID.
-     * @param - New end date and time.
-     *
-     * Must be later than the current end date and time.
-     * @param - Options for postponing the end date of an order.
-     */
-    (_id: string, endDate: Date): Promise<void>;
-}
-declare function cancelOrder$1(httpClient: HttpClient): CancelOrderSignature;
-interface CancelOrderSignature {
-    /**
-     * Cancels an existing order.
-     *
-     * 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`.
-     *
-     * #### 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 Wix user cancels an ordered plan during the free trial period, they choose whether 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 - Order ID.
-     * @param - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
-     * @param - Options for canceling orders.
-     */
-    (_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
-}
-declare function markAsPaid$1(httpClient: HttpClient): MarkAsPaidSignature;
-interface MarkAsPaidSignature {
-    /**
-     * 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. 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 mark an offline order as paid twice.
-     * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
-     * @param - Order ID.
-     */
-    (_id: string): Promise<void>;
-}
-declare function pauseOrder$1(httpClient: HttpClient): PauseOrderSignature;
-interface PauseOrderSignature {
-    /**
-     * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
-     *
-     * Only orders with `status`: `ACTIVE` can be 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`.
-     * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
-     *
-     * To resume a paused order, call Resume Order.
-     * @param - Order ID.
-     */
-    (_id: string): Promise<void>;
-}
-declare function resumeOrder$1(httpClient: HttpClient): ResumeOrderSignature;
-interface ResumeOrderSignature {
-    /**
-     * Resumes a paused order. For orders with recurring payments, it 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.
-     * - For orders with recurring payments, the payment schedule is restarted.
-     * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
-     *
-     * To pause an order, call Pause Order.
-     * @param - Order ID.
-     */
-    (_id: string): Promise<void>;
-}
 declare function memberGetOrder$1(httpClient: HttpClient): MemberGetOrderSignature;
 interface MemberGetOrderSignature {
     /**
      * Retrieves an order for the currently logged-in member by ID.
      * @param - Order ID.
      * @param - Options for getting a logged-in member's order.
-     * @returns Requested order.
      */
-    (_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<Order, `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`, 6>>;
+    (_id: string, options?: MemberGetOrderOptions): Promise<NonNullablePaths<MemberGetOrderResponse, `order._id` | `order.planId` | `order.subscriptionId` | `order.buyer.memberId` | `order.buyer.contactId` | `order.priceDetails.subscription.cycleDuration.unit` | `order.priceDetails.subtotal` | `order.priceDetails.discount` | `order.priceDetails.tax.name` | `order.priceDetails.tax.includedInPrice` | `order.priceDetails.tax.rate` | `order.priceDetails.tax.amount` | `order.priceDetails.total` | `order.priceDetails.planPrice` | `order.priceDetails.currency` | `order.priceDetails.coupon.code` | `order.priceDetails.coupon.amount` | `order.priceDetails.coupon._id` | `order.pricing.prices` | `order.pricing.prices.${number}.duration.cycleFrom` | `order.pricing.prices.${number}.price.subtotal` | `order.pricing.prices.${number}.price.discount` | `order.pricing.prices.${number}.price.total` | `order.pricing.prices.${number}.price.currency` | `order.pricing.prices.${number}.price.proration` | `order.type` | `order.status` | `order.cancellation.cause` | `order.cancellation.effectiveAt` | `order.lastPaymentStatus` | `order.pausePeriods` | `order.pausePeriods.${number}.status` | `order.currentCycle.index` | `order.planName` | `order.planDescription` | `order.planPrice`, 7>>;
 }
 declare function memberListOrders$1(httpClient: HttpClient): MemberListOrdersSignature;
 interface MemberListOrdersSignature {
@@ -246,8 +136,121 @@ interface GetPricePreviewSignature {
         __applicationErrorsType?: GetPricePreviewApplicationErrors;
     }>;
 }
-declare const onOrderAutoRenewCanceled$1: EventDefinition<OrderAutoRenewCanceledEnvelope, "wix.pricing_plans.v2.order_auto_renew_canceled">;
+declare function managementGetOrder$1(httpClient: HttpClient): ManagementGetOrderSignature;
+interface ManagementGetOrderSignature {
+    /**
+     * Retrieves an order by ID.
+     * @param - Order ID.
+     * @param - Options to use when getting an order.
+     * @returns Order.
+     */
+    (_id: string, options?: ManagementGetOrderOptions): Promise<NonNullablePaths<Order, `_id` | `planId` | `subscriptionId` | `buyer.memberId` | `buyer.contactId` | `priceDetails.subscription.cycleDuration.unit` | `priceDetails.subtotal` | `priceDetails.discount` | `priceDetails.tax.name` | `priceDetails.tax.includedInPrice` | `priceDetails.tax.rate` | `priceDetails.tax.amount` | `priceDetails.total` | `priceDetails.planPrice` | `priceDetails.currency` | `priceDetails.coupon.code` | `priceDetails.coupon.amount` | `priceDetails.coupon._id` | `pricing.prices` | `pricing.prices.${number}.duration.cycleFrom` | `pricing.prices.${number}.price.subtotal` | `pricing.prices.${number}.price.discount` | `pricing.prices.${number}.price.total` | `pricing.prices.${number}.price.currency` | `pricing.prices.${number}.price.proration` | `type` | `status` | `cancellation.cause` | `cancellation.effectiveAt` | `lastPaymentStatus` | `pausePeriods` | `pausePeriods.${number}.status` | `currentCycle.index` | `planName` | `planDescription` | `planPrice`, 6>>;
+}
+declare function managementListOrders$1(httpClient: HttpClient): ManagementListOrdersSignature;
+interface ManagementListOrdersSignature {
+    /**
+     * Retrieves a list of up to 50 pricing plan orders and details, given the specified sorting and filtering.
+     *
+     * 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.
+     * @param - Filtering, sorting, and pagination options.
+     */
+    (options?: ManagementListOrdersOptions): Promise<NonNullablePaths<ListOrdersResponse, `orders` | `orders.${number}._id` | `orders.${number}.planId` | `orders.${number}.subscriptionId` | `orders.${number}.buyer.memberId` | `orders.${number}.buyer.contactId` | `orders.${number}.priceDetails.singlePaymentForDuration.unit` | `orders.${number}.priceDetails.subtotal` | `orders.${number}.priceDetails.discount` | `orders.${number}.priceDetails.tax.name` | `orders.${number}.priceDetails.tax.includedInPrice` | `orders.${number}.priceDetails.tax.rate` | `orders.${number}.priceDetails.tax.amount` | `orders.${number}.priceDetails.total` | `orders.${number}.priceDetails.planPrice` | `orders.${number}.priceDetails.currency` | `orders.${number}.priceDetails.coupon.code` | `orders.${number}.priceDetails.coupon.amount` | `orders.${number}.priceDetails.coupon._id` | `orders.${number}.type` | `orders.${number}.status` | `orders.${number}.cancellation.cause` | `orders.${number}.cancellation.effectiveAt` | `orders.${number}.lastPaymentStatus` | `orders.${number}.currentCycle.index` | `orders.${number}.planName` | `orders.${number}.planDescription` | `orders.${number}.planPrice`, 6>>;
+}
+declare function postponeEndDate$1(httpClient: HttpClient): PostponeEndDateSignature;
+interface PostponeEndDateSignature {
+    /**
+     * Extends the duration of a pricing plan order by postponing the order's `endDate`. Postponing the end date of an order does not impact payments.
+     *
+     * New `endDate` must be later than the order's current `endDate`. Can't postpone orders that are unlimited.
+     * Can't postpone an order with `status`: `PAUSED`.
+     * @param - Order ID.
+     * @param - New end date and time.
+     *
+     * Must be later than the current end date and time.
+     * @param - Options for postponing the end date of an order.
+     */
+    (_id: string, endDate: Date): Promise<void>;
+}
+declare function cancelOrder$1(httpClient: HttpClient): CancelOrderSignature;
+interface CancelOrderSignature {
+    /**
+     * Cancels an existing order.
+     *
+     * 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`.
+     *
+     * #### 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 Wix user cancels an ordered plan during the free trial period, they choose whether 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 - Order ID.
+     * @param - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
+     * @param - Options for canceling orders.
+     */
+    (_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
+}
+declare function markAsPaid$1(httpClient: HttpClient): MarkAsPaidSignature;
+interface MarkAsPaidSignature {
+    /**
+     * 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. 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 mark an offline order as paid twice.
+     * - Mark an online order as paid. The Mark as Paid method is supported for offline orders only.
+     * @param - Order ID.
+     */
+    (_id: string): Promise<void>;
+}
+declare function pauseOrder$1(httpClient: HttpClient): PauseOrderSignature;
+interface PauseOrderSignature {
+    /**
+     * Pauses an order. Calling this method changes the order status to `"PAUSED"` and updates the `pausePeriods` array.
+     *
+     * Only orders with `status`: `ACTIVE` can be 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`.
+     * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
+     *
+     * To resume a paused order, call Resume Order.
+     * @param - Order ID.
+     */
+    (_id: string): Promise<void>;
+}
+declare function resumeOrder$1(httpClient: HttpClient): ResumeOrderSignature;
+interface ResumeOrderSignature {
+    /**
+     * Resumes a paused order. For orders with recurring payments, it 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.
+     * - For orders with recurring payments, the payment schedule is restarted.
+     * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
+     *
+     * To pause an order, call Pause Order.
+     * @param - Order ID.
+     */
+    (_id: string): Promise<void>;
+}
 declare const onOrderCanceled$1: EventDefinition<OrderCanceledEnvelope, "wix.pricing_plans.v2.order_canceled">;
+declare const onOrderCreated$1: EventDefinition<OrderCreatedEnvelope, "wix.pricing_plans.v2.order_created">;
+declare const onOrderStartDateChanged$1: EventDefinition<OrderStartDateChangedEnvelope, "wix.pricing_plans.v2.order_start_date_changed">;
+declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.pricing_plans.v2.order_updated">;
+declare const onOrderAutoRenewCanceled$1: EventDefinition<OrderAutoRenewCanceledEnvelope, "wix.pricing_plans.v2.order_auto_renew_canceled">;
 declare const onOrderCycleStarted$1: EventDefinition<OrderCycleStartedEnvelope, "wix.pricing_plans.v2.order_cycle_started">;
 declare const onOrderEndDatePostponed$1: EventDefinition<OrderEndDatePostponedEnvelope, "wix.pricing_plans.v2.order_end_date_postponed">;
 declare const onOrderEnded$1: EventDefinition<OrderEndedEnvelope, "wix.pricing_plans.v2.order_ended">;
@@ -256,17 +259,7 @@ declare const onOrderPaused$1: EventDefinition<OrderPausedEnvelope, "wix.pricing
 declare const onOrderPurchased$1: EventDefinition<OrderPurchasedEnvelope, "wix.pricing_plans.v2.order_purchased">;
 declare const onOrderResumed$1: EventDefinition<OrderResumedEnvelope, "wix.pricing_plans.v2.order_resumed">;
 declare const onOrderStarted$1: EventDefinition<OrderStartedEnvelope, "wix.pricing_plans.v2.order_started">;
-declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.pricing_plans.v2.order_updated">;
-declare const onOrderCreated$1: EventDefinition<OrderCreatedEnvelope, "wix.pricing_plans.v2.order_created">;
-declare const onOrderStartDateChanged$1: EventDefinition<OrderStartDateChangedEnvelope, "wix.pricing_plans.v2.order_start_date_changed">;
 
-declare const managementGetOrder: MaybeContext<BuildRESTFunction<typeof managementGetOrder$1> & typeof managementGetOrder$1>;
-declare const managementListOrders: MaybeContext<BuildRESTFunction<typeof managementListOrders$1> & typeof managementListOrders$1>;
-declare const postponeEndDate: MaybeContext<BuildRESTFunction<typeof postponeEndDate$1> & typeof postponeEndDate$1>;
-declare const cancelOrder: MaybeContext<BuildRESTFunction<typeof cancelOrder$1> & typeof cancelOrder$1>;
-declare const markAsPaid: MaybeContext<BuildRESTFunction<typeof markAsPaid$1> & typeof markAsPaid$1>;
-declare const pauseOrder: MaybeContext<BuildRESTFunction<typeof pauseOrder$1> & typeof pauseOrder$1>;
-declare const resumeOrder: MaybeContext<BuildRESTFunction<typeof resumeOrder$1> & typeof resumeOrder$1>;
 declare const memberGetOrder: MaybeContext<BuildRESTFunction<typeof memberGetOrder$1> & typeof memberGetOrder$1>;
 declare const memberListOrders: MaybeContext<BuildRESTFunction<typeof memberListOrders$1> & typeof memberListOrders$1>;
 declare const requestCancellation: MaybeContext<BuildRESTFunction<typeof requestCancellation$1> & typeof requestCancellation$1>;
@@ -275,14 +268,13 @@ declare const createOfflineOrder: MaybeContext<BuildRESTFunction<typeof createOf
 declare const getOnlineOrderPreview: MaybeContext<BuildRESTFunction<typeof getOnlineOrderPreview$1> & typeof getOnlineOrderPreview$1>;
 declare const getOfflineOrderPreview: MaybeContext<BuildRESTFunction<typeof getOfflineOrderPreview$1> & typeof getOfflineOrderPreview$1>;
 declare const getPricePreview: MaybeContext<BuildRESTFunction<typeof getPricePreview$1> & typeof getPricePreview$1>;
-/**
- * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
- *
- * This webhook is *not* triggered in the following scenarios:
- * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
- * + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
- */
-declare const onOrderAutoRenewCanceled: BuildEventDefinition<typeof onOrderAutoRenewCanceled$1> & typeof onOrderAutoRenewCanceled$1;
+declare const managementGetOrder: MaybeContext<BuildRESTFunction<typeof managementGetOrder$1> & typeof managementGetOrder$1>;
+declare const managementListOrders: MaybeContext<BuildRESTFunction<typeof managementListOrders$1> & typeof managementListOrders$1>;
+declare const postponeEndDate: MaybeContext<BuildRESTFunction<typeof postponeEndDate$1> & typeof postponeEndDate$1>;
+declare const cancelOrder: MaybeContext<BuildRESTFunction<typeof cancelOrder$1> & typeof cancelOrder$1>;
+declare const markAsPaid: MaybeContext<BuildRESTFunction<typeof markAsPaid$1> & typeof markAsPaid$1>;
+declare const pauseOrder: MaybeContext<BuildRESTFunction<typeof pauseOrder$1> & typeof pauseOrder$1>;
+declare const resumeOrder: MaybeContext<BuildRESTFunction<typeof resumeOrder$1> & typeof resumeOrder$1>;
 /**
  * Triggered when an order is canceled.
  *
@@ -291,6 +283,34 @@ declare const onOrderAutoRenewCanceled: BuildEventDefinition<typeof onOrderAutoR
  * + If the order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`, the webhook is triggered at the end of the current payment cycle. In this case, the Order Auto Renew Canceled Webhook is triggered immediately.
  */
 declare const onOrderCanceled: BuildEventDefinition<typeof onOrderCanceled$1> & typeof onOrderCanceled$1;
+/**
+ * Triggered when an order is created.
+ */
+declare const onOrderCreated: BuildEventDefinition<typeof onOrderCreated$1> & typeof onOrderCreated$1;
+/**
+ * Triggered when an order's `startDate` is changed.
+ */
+declare const onOrderStartDateChanged: BuildEventDefinition<typeof onOrderStartDateChanged$1> & typeof onOrderStartDateChanged$1;
+/**
+ * Triggered for any of the following update events:
+ *
+ * + Order is paid for. Order Purchased is also triggered.
+ * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
+ * + New payment cycle of an order starts. Order Cycle Started is also triggered.
+ * + Offline order is marked as paid. Order Marked As Paid is also triggered.
+ * + End date of the order is postponed. Order End Date Postponed is also triggered
+ * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
+ * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
+ */
+declare const onOrderUpdated: BuildEventDefinition<typeof onOrderUpdated$1> & typeof onOrderUpdated$1;
+/**
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
+ *
+ * This webhook is *not* triggered in the following scenarios:
+ * + When an order is canceled and `effectiveAt` is set to `IMMEDIATELY`. Instead, at the time of cancellation, Order Canceled is triggered.
+ * + When an order expires at the end of the current payment cycle because it was canceled and `effectiveAt` was set to `NEXT_PAYMENT_DATE`. Instead, at the time of expiration, Order Canceled and Order Ended are triggered.
+ */
+declare const onOrderAutoRenewCanceled: BuildEventDefinition<typeof onOrderAutoRenewCanceled$1> & typeof onOrderAutoRenewCanceled$1;
 /**
  * Triggered at the start of a new payment cycle for an existing order.
  *
@@ -333,25 +353,5 @@ declare const onOrderResumed: BuildEventDefinition<typeof onOrderResumed$1> & ty
  * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
  */
 declare const onOrderStarted: BuildEventDefinition<typeof onOrderStarted$1> & typeof onOrderStarted$1;
-/**
- * Triggered for any of the following update events:
- *
- * + Order is paid for. Order Purchased is also triggered.
- * + Order reaches its start date or end date. Order Started and Order Ended, respectively, are also triggered.
- * + New payment cycle of an order starts. Order Cycle Started is also triggered.
- * + Offline order is marked as paid. Order Marked As Paid is also triggered.
- * + End date of the order is postponed. Order End Date Postponed is also triggered
- * + Order is paused, or a paused order is resumed. Order Paused and Order Resumed, respectively, are also triggered.
- * + Order is canceled, either immediately or at the end of the payment cycle. Order Canceled and Order Auto Renew Canceled, respectively, are also triggered.
- */
-declare const onOrderUpdated: BuildEventDefinition<typeof onOrderUpdated$1> & typeof onOrderUpdated$1;
-/**
- * Triggered when an order is created.
- */
-declare const onOrderCreated: BuildEventDefinition<typeof onOrderCreated$1> & typeof onOrderCreated$1;
-/**
- * Triggered when an order's `startDate` is changed.
- */
-declare const onOrderStartDateChanged: BuildEventDefinition<typeof onOrderStartDateChanged$1> & typeof onOrderStartDateChanged$1;
 
-export { CancellationEffectiveAtWithLiterals, CreateOfflineOrderApplicationErrors, CreateOfflineOrderOptions, CreateOfflineOrderResponse, CreateOfflineOrderValidationErrors, CreateOnlineOrderApplicationErrors, CreateOnlineOrderOptions, CreateOnlineOrderResponse, CreateOnlineOrderValidationErrors, GetOfflineOrderPreviewApplicationErrors, GetOfflineOrderPreviewOptions, GetOfflineOrderPreviewResponse, GetOfflineOrderPreviewValidationErrors, GetOnlineOrderPreviewApplicationErrors, GetOnlineOrderPreviewOptions, GetOnlineOrderPreviewResponse, GetOnlineOrderPreviewValidationErrors, GetOrderResponse, GetPricePreviewApplicationErrors, GetPricePreviewOptions, GetPricePreviewResponse, ListOrdersResponse, ManagementGetOrderOptions, ManagementListOrdersOptions, MemberGetOrderOptions, MemberListOrdersOptions, MemberListOrdersResponse, Order, OrderAutoRenewCanceledEnvelope, OrderCanceledEnvelope, OrderCreatedEnvelope, OrderCycleStartedEnvelope, OrderEndDatePostponedEnvelope, OrderEndedEnvelope, OrderMarkedAsPaidEnvelope, OrderPausedEnvelope, OrderPurchasedEnvelope, OrderResumedEnvelope, OrderStartDateChangedEnvelope, OrderStartedEnvelope, OrderUpdatedEnvelope, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };
+export { CancellationEffectiveAtWithLiterals, CreateOfflineOrderApplicationErrors, CreateOfflineOrderOptions, CreateOfflineOrderResponse, CreateOfflineOrderValidationErrors, CreateOnlineOrderApplicationErrors, CreateOnlineOrderOptions, CreateOnlineOrderResponse, CreateOnlineOrderValidationErrors, GetOfflineOrderPreviewApplicationErrors, GetOfflineOrderPreviewOptions, GetOfflineOrderPreviewResponse, GetOfflineOrderPreviewValidationErrors, GetOnlineOrderPreviewApplicationErrors, GetOnlineOrderPreviewOptions, GetOnlineOrderPreviewResponse, GetOnlineOrderPreviewValidationErrors, GetPricePreviewApplicationErrors, GetPricePreviewOptions, GetPricePreviewResponse, ListOrdersResponse, ManagementGetOrderOptions, ManagementListOrdersOptions, MemberGetOrderOptions, MemberGetOrderResponse, MemberListOrdersOptions, MemberListOrdersResponse, Order, OrderAutoRenewCanceledEnvelope, OrderCanceledEnvelope, OrderCreatedEnvelope, OrderCycleStartedEnvelope, OrderEndDatePostponedEnvelope, OrderEndedEnvelope, OrderMarkedAsPaidEnvelope, OrderPausedEnvelope, OrderPurchasedEnvelope, OrderResumedEnvelope, OrderStartDateChangedEnvelope, OrderStartedEnvelope, OrderUpdatedEnvelope, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, onOrderAutoRenewCanceled, onOrderCanceled, onOrderCreated, onOrderCycleStarted, onOrderEndDatePostponed, onOrderEnded, onOrderMarkedAsPaid, onOrderPaused, onOrderPurchased, onOrderResumed, onOrderStartDateChanged, onOrderStarted, onOrderUpdated, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };