@wix/auto_sdk_pricing-plans_orders 1.0.119 → 1.0.120

package/build/cjs/index.typings.d.ts

@@ -626,7 +626,35 @@ interface ActionEvent {
 }
 interface Empty {
 }
-interface MemberGetOrderRequest {
+interface OrderPurchased {
+    /** Order that was paid for. If a free or an offline order, the order that was created. */
+    order?: Order;
+}
+interface OrderStarted {
+    /** Order that reached its `startDate`. */
+    order?: Order;
+}
+/**
+ * Triggered at the start of a new payment cycle for an existing order.
+ *
+ * This webhook does not trigger at the initial start of an offline order.
+ */
+interface OrderCycleStarted {
+    /** Order whose new cycle started. */
+    order?: Order;
+    /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
+    cycleNumber?: number;
+}
+/** Emitted when a recurring order is canceled for the next payment cycle */
+interface OrderAutoRenewCanceled {
+    /** Order that is canceled, effective at the end of the current payment cycle. */
+    order?: Order;
+}
+interface OrderEnded {
+    /** Order that ended. */
+    order?: Order;
+}
+interface GetOrderRequest {
     /**
      * Order ID.
      * @format GUID
@@ -649,31 +677,44 @@ declare enum Set {
 }
 /** @enumType */
 type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
-interface MemberGetOrderResponse {
-    /** Requested order. */
+interface GetOrderResponse {
+    /** Order. */
     order?: Order;
 }
-interface MemberListOrdersRequest {
+interface ListOrdersRequest {
     /**
-     * Filter by plan IDs.
+     * Filter by a buyer's member ID, from the Members API.
+     * @format GUID
+     */
+    buyerIds?: string[];
+    /**
+     * Filter by plan IDs, from the Plans API.
      * @format GUID
      */
     planIds?: string[];
-    /** Filter for orders where auto renewal was canceled. */
+    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
     autoRenewCanceled?: boolean | null;
     /** Filter by order status. */
     orderStatuses?: OrderStatusWithLiterals[];
     /** Filter by payment status. */
     paymentStatuses?: PaymentStatusWithLiterals[];
     /**
-     * Limit the number of pricing plans returned. Default limit is 50.
+     * Number of orders to return. See Sorting and Paging for more information.
+     *
+     * Max: `50`
      * @min 1
      * @max 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. */
+    /**
+     * Sort order.
+     *
+     * Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `DESC`.
+     */
     sorting?: Sorting;
     /**
      * Predefined set of fields to return.
@@ -690,6 +731,11 @@ interface Sorting {
     fieldName?: string;
     /** Sort order. */
     order?: SortOrderWithLiterals;
+    /**
+     * Origin point for geo-distance sorting on a GEO field
+     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+     */
+    origin?: AddressLocation;
 }
 declare enum SortOrder {
     ASC = "ASC",
@@ -697,8 +743,14 @@ declare enum SortOrder {
 }
 /** @enumType */
 type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-interface MemberListOrdersResponse {
-    /** Requested orders. */
+interface AddressLocation {
+    /** Address latitude. */
+    latitude?: number | null;
+    /** Address longitude. */
+    longitude?: number | null;
+}
+interface ListOrdersResponse {
+    /** List of orders. */
     orders?: Order[];
     /** Object containing paging-related data (number of orders returned, offset). */
     pagingMetadata?: PagingMetadataV2;
@@ -727,16 +779,78 @@ interface Cursors {
      */
     prev?: string | null;
 }
-interface RequestCancellationRequest {
+interface GetOrdersStatsRequest {
+}
+interface GetOrdersStatsResponse {
+    /** Total number of orders. */
+    totalOrderCount?: number;
+    /** Number of active orders. */
+    activeOrderCount?: number;
+}
+interface GetAvailableOrderActionsRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    _id?: string;
+}
+interface GetAvailableOrderActionsResponse {
+    /** Whether the order can be suspended. */
+    suspendable?: boolean;
+    /** If the order cannot be suspended, a reason is returned here. */
+    notSuspendableReason?: ReasonNotSuspendableWithLiterals;
+    /** Whether the order can be canceled by the buyer. */
+    cancelableByBuyer?: boolean;
+}
+declare enum ReasonNotSuspendable {
+    /** Undefined reason. */
+    UNDEFINED = "UNDEFINED",
+    /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
+    PENDING = "PENDING",
+    /** Trial orders can't be suspended. */
+    TRIAL = "TRIAL",
+    /** Canceled orders can't be suspended. */
+    CANCELED = "CANCELED",
+    /** Ended orders can't be suspended. */
+    ENDED = "ENDED",
+    /** Paid for orders with future start dates can't be suspended. */
+    NOT_STARTED = "NOT_STARTED",
+    /** Order is already suspended. */
+    ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
+    /** Orders based on recurring payments using older stripe versions can't be suspended. */
+    OLD_STRIPE = "OLD_STRIPE"
+}
+/** @enumType */
+type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
+interface PostponeEndDateRequest {
     /**
      * Order ID.
      * @format GUID
      */
     _id: string;
-    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
+    /**
+     * New end date and time.
+     *
+     * Must be later than the current end date and time.
+     */
+    endDate: Date | null;
+}
+interface PostponeEndDateResponse {
+}
+interface OrderEndDatePostponed {
+    /** Order whose `endDate` was postponed. */
+    order?: Order;
+}
+interface CancelOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    _id: string;
+    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
     effectiveAt: CancellationEffectiveAtWithLiterals;
 }
-interface RequestCancellationResponse {
+interface CancelOrderResponse {
 }
 /**
  * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
@@ -747,6 +861,111 @@ interface OrderCanceled {
     /** Canceled order. */
     order?: Order;
 }
+interface MarkAsPaidRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    _id: string;
+}
+interface MarkAsPaidResponse {
+}
+interface OrderMarkedAsPaid {
+    /** Order that was marked as paid. */
+    order?: Order;
+}
+interface PauseOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    _id: string;
+}
+interface PauseOrderResponse {
+}
+interface OrderPaused {
+    /** Paused order. */
+    order?: Order;
+}
+interface BulkPauseOrderRequest {
+    /**
+     * List of Order IDs.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    ids?: string[];
+    /** Set to true to return Order entity in response. */
+    returnFullEntity?: boolean;
+}
+interface BulkPauseOrderResponse {
+    /** Orders that were paused. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkOrderResult {
+    /** Item metadata */
+    itemMetadata?: ItemMetadata;
+    /** The order. */
+    order?: Order;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    _id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface ResumeOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    _id: string;
+}
+interface ResumeOrderResponse {
+}
+interface OrderResumed {
+    /** Resumed order. */
+    order?: Order;
+}
+interface BulkResumeOrderRequest {
+    /**
+     * List of Order IDs.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    ids?: string[];
+    /** Set to true to return Order entity in response. */
+    returnFullEntity?: boolean;
+}
+interface BulkResumeOrderResponse {
+    /** Orders that were resumed. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
 interface MessageEnvelope {
     /**
      * App instance ID.
@@ -1141,85 +1360,44 @@ interface SetSubmissionResponse {
     /** Order with submission id */
     order?: Order;
 }
-interface OrderPurchased {
-    /** Order that was paid for. If a free or an offline order, the order that was created. */
+interface MemberGetOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    _id: string;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+interface MemberGetOrderResponse {
+    /** Requested order. */
     order?: Order;
 }
-interface OrderStarted {
-    /** Order that reached its `startDate`. */
-    order?: Order;
-}
-/**
- * Triggered at the start of a new payment cycle for an existing order.
- *
- * This webhook does not trigger at the initial start of an offline order.
- */
-interface OrderCycleStarted {
-    /** Order whose new cycle started. */
-    order?: Order;
-    /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
-    cycleNumber?: number;
-}
-/** Emitted when a recurring order is canceled for the next payment cycle */
-interface OrderAutoRenewCanceled {
-    /** Order that is canceled, effective at the end of the current payment cycle. */
-    order?: Order;
-}
-interface OrderEnded {
-    /** Order that ended. */
-    order?: Order;
-}
-interface GetOrderRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    _id: string;
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    fieldSet?: SetWithLiterals;
-}
-interface GetOrderResponse {
-    /** Order. */
-    order?: Order;
-}
-interface ListOrdersRequest {
-    /**
-     * Filter by a buyer's member ID, from the Members API.
-     * @format GUID
-     */
-    buyerIds?: string[];
+interface MemberListOrdersRequest {
     /**
-     * Filter by plan IDs, from the Plans API.
+     * Filter by plan IDs.
      * @format GUID
      */
     planIds?: string[];
-    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
+    /** Filter for orders where auto renewal was canceled. */
     autoRenewCanceled?: boolean | null;
     /** Filter by order status. */
     orderStatuses?: OrderStatusWithLiterals[];
     /** Filter by payment status. */
     paymentStatuses?: PaymentStatusWithLiterals[];
     /**
-     * Number of orders to return. See Sorting and Paging for more information.
-     *
-     * Max: `50`
+     * Limit the number of pricing plans returned. Default limit is 50.
      * @min 1
      * @max 50
      */
     limit?: number | null;
-    /** Number of orders to skip in the current sort order. */
+    /** Number of entries to offset. */
     offset?: number | null;
-    /**
-     * Sort order.
-     *
-     * Use `ASC` for ascending order or `DESC` for descending order.
-     *
-     * Default: `DESC`.
-     */
+    /** Sorting direction (defaults to ASC) and field to sort by. */
     sorting?: Sorting;
     /**
      * Predefined set of fields to return.
@@ -1228,189 +1406,22 @@ interface ListOrdersRequest {
      */
     fieldSet?: SetWithLiterals;
 }
-interface ListOrdersResponse {
-    /** List of orders. */
+interface MemberListOrdersResponse {
+    /** Requested orders. */
     orders?: Order[];
     /** Object containing paging-related data (number of orders returned, offset). */
     pagingMetadata?: PagingMetadataV2;
 }
-interface GetOrdersStatsRequest {
-}
-interface GetOrdersStatsResponse {
-    /** Total number of orders. */
-    totalOrderCount?: number;
-    /** Number of active orders. */
-    activeOrderCount?: number;
-}
-interface GetAvailableOrderActionsRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    _id?: string;
-}
-interface GetAvailableOrderActionsResponse {
-    /** Whether the order can be suspended. */
-    suspendable?: boolean;
-    /** If the order cannot be suspended, a reason is returned here. */
-    notSuspendableReason?: ReasonNotSuspendableWithLiterals;
-    /** Whether the order can be canceled by the buyer. */
-    cancelableByBuyer?: boolean;
-}
-declare enum ReasonNotSuspendable {
-    /** Undefined reason. */
-    UNDEFINED = "UNDEFINED",
-    /** Saved in the database but is awaiting payment. Non-active orders can't be suspended. */
-    PENDING = "PENDING",
-    /** Trial orders can't be suspended. */
-    TRIAL = "TRIAL",
-    /** Canceled orders can't be suspended. */
-    CANCELED = "CANCELED",
-    /** Ended orders can't be suspended. */
-    ENDED = "ENDED",
-    /** Paid for orders with future start dates can't be suspended. */
-    NOT_STARTED = "NOT_STARTED",
-    /** Order is already suspended. */
-    ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
-    /** Orders based on recurring payments using older stripe versions can't be suspended. */
-    OLD_STRIPE = "OLD_STRIPE"
-}
-/** @enumType */
-type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
-interface PostponeEndDateRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    _id: string;
-    /**
-     * New end date and time.
-     *
-     * Must be later than the current end date and time.
-     */
-    endDate: Date | null;
-}
-interface PostponeEndDateResponse {
-}
-interface OrderEndDatePostponed {
-    /** Order whose `endDate` was postponed. */
-    order?: Order;
-}
-interface CancelOrderRequest {
+interface RequestCancellationRequest {
     /**
      * Order ID.
      * @format GUID
      */
     _id: string;
-    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
+    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
     effectiveAt: CancellationEffectiveAtWithLiterals;
 }
-interface CancelOrderResponse {
-}
-interface MarkAsPaidRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    _id: string;
-}
-interface MarkAsPaidResponse {
-}
-interface OrderMarkedAsPaid {
-    /** Order that was marked as paid. */
-    order?: Order;
-}
-interface PauseOrderRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    _id: string;
-}
-interface PauseOrderResponse {
-}
-interface OrderPaused {
-    /** Paused order. */
-    order?: Order;
-}
-interface BulkPauseOrderRequest {
-    /**
-     * List of Order IDs.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    ids?: string[];
-    /** Set to true to return Order entity in response. */
-    returnFullEntity?: boolean;
-}
-interface BulkPauseOrderResponse {
-    /** Orders that were paused. */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkOrderResult {
-    /** Item metadata */
-    itemMetadata?: ItemMetadata;
-    /** The order. */
-    order?: Order;
-}
-interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    _id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
-interface ResumeOrderRequest {
-    /**
-     * Order ID.
-     * @format GUID
-     */
-    _id: string;
-}
-interface ResumeOrderResponse {
-}
-interface OrderResumed {
-    /** Resumed order. */
-    order?: Order;
-}
-interface BulkResumeOrderRequest {
-    /**
-     * List of Order IDs.
-     * @format GUID
-     * @minSize 1
-     * @maxSize 100
-     */
-    ids?: string[];
-    /** Set to true to return Order entity in response. */
-    returnFullEntity?: boolean;
-}
-interface BulkResumeOrderResponse {
-    /** Orders that were resumed. */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
+interface RequestCancellationResponse {
 }
 /** @docsIgnore */
 type CreateOnlineOrderApplicationErrors = {
@@ -1763,16 +1774,16 @@ interface AccountInfoMetadata {
     /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
     parentAccountId?: string;
 }
-interface OrderCanceledEnvelope {
-    data: OrderCanceled;
+interface OrderAutoRenewCanceledEnvelope {
+    data: OrderAutoRenewCanceled;
     metadata: EventMetadata;
 }
 /**
- * Triggered when an order is canceled.
+ * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
  *
- * This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
- * + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
- * + 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.
+ * 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.
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
  * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
@@ -1785,98 +1796,21 @@ interface OrderCanceledEnvelope {
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
  * @permissionId PRICING_PLANS.READ_ORDERS
  * @webhook
- * @eventType wix.pricing_plans.v2.order_canceled
- * @serviceIdentifier com.wixpress.membership.v2.orders.member.MemberOrdersService
- * @slug canceled
- */
-declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
-interface OrderCreatedEnvelope {
-    entity: Order;
-    metadata: EventMetadata;
-}
-/**
- * Triggered when an order is created.
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
- * @permissionScopeId SCOPE.RENTALS.MANAGE
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
- * @permissionScope Manage plans and orders of Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
- * @permissionScope Manage Events
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionId PRICING_PLANS.READ_ORDERS
- * @webhook
- * @eventType wix.pricing_plans.v2.order_created
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
- * @slug created
- */
-declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
-interface OrderStartDateChangedEnvelope {
-    data: OrderStartDateChanged;
-    metadata: EventMetadata;
-}
-/**
- * Triggered when an order's `startDate` is changed.
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
- * @permissionScopeId SCOPE.RENTALS.MANAGE
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
- * @permissionScope Manage plans and orders of Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
- * @permissionScope Manage Events
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionId PRICING_PLANS.READ_ORDERS
- * @webhook
- * @eventType wix.pricing_plans.v2.order_start_date_changed
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
- * @slug start_date_changed
- */
-declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
-interface OrderUpdatedEnvelope {
-    entity: Order;
-    metadata: EventMetadata;
-}
-/**
- * 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.
- * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
- * @permissionScopeId SCOPE.RENTALS.MANAGE
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
- * @permissionScope Manage plans and orders of Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
- * @permissionScope Manage Events
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @permissionId PRICING_PLANS.READ_ORDERS
- * @webhook
- * @eventType wix.pricing_plans.v2.order_updated
- * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
- * @slug updated
+ * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
+ * @slug auto_renew_canceled
  */
-declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
-interface OrderAutoRenewCanceledEnvelope {
-    data: OrderAutoRenewCanceled;
+declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
+interface OrderCanceledEnvelope {
+    data: OrderCanceled;
     metadata: EventMetadata;
 }
 /**
- * Triggered when an order is canceled and `effectiveAt` is set to `NEXT_PAYMENT_DATE`.
+ * Triggered when an order is canceled.
  *
- * 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.
+ * This webhook is triggered either immediately or at the end of the current payment cycle, as follows:
+ * + If the order is canceled and `effectiveAt` is set to `IMMEDIATELY`, the webhook is triggered immediately when canceled.
+ * + 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.
  * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
  * @permissionScopeId SCOPE.RENTALS.MANAGE
  * @permissionScope Manage Orders
@@ -1889,11 +1823,11 @@ interface OrderAutoRenewCanceledEnvelope {
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
  * @permissionId PRICING_PLANS.READ_ORDERS
  * @webhook
- * @eventType wix.pricing_plans.v2.order_auto_renew_canceled
+ * @eventType wix.pricing_plans.v2.order_canceled
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
- * @slug auto_renew_canceled
+ * @slug canceled
  */
-declare function onOrderAutoRenewCanceled(handler: (event: OrderAutoRenewCanceledEnvelope) => void | Promise<void>): void;
+declare function onOrderCanceled(handler: (event: OrderCanceledEnvelope) => void | Promise<void>): void;
 interface OrderCycleStartedEnvelope {
     data: OrderCycleStarted;
     metadata: EventMetadata;
@@ -2088,19 +2022,95 @@ interface OrderStartedEnvelope {
  * @slug started
  */
 declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
+interface OrderUpdatedEnvelope {
+    entity: Order;
+    metadata: EventMetadata;
+}
 /**
- * Retrieves an order for the currently logged-in member by ID.
+ * 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.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @permissionScope Read Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
+ * @permissionScope Manage plans and orders of Pricing Plans
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId PRICING_PLANS.READ_ORDERS
+ * @webhook
+ * @eventType wix.pricing_plans.v2.order_updated
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
+ * @slug updated
+ */
+declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
+interface OrderCreatedEnvelope {
+    entity: Order;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order is created.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @permissionScope Read Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
+ * @permissionScope Manage plans and orders of Pricing Plans
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId PRICING_PLANS.READ_ORDERS
+ * @webhook
+ * @eventType wix.pricing_plans.v2.order_created
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
+ * @slug created
+ */
+declare function onOrderCreated(handler: (event: OrderCreatedEnvelope) => void | Promise<void>): void;
+interface OrderStartDateChangedEnvelope {
+    data: OrderStartDateChanged;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order's `startDate` is changed.
+ * @permissionScope Manage_Wix_Rentals_App_Forms_submissions
+ * @permissionScopeId SCOPE.RENTALS.MANAGE
+ * @permissionScope Manage Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
+ * @permissionScope Read Orders
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
+ * @permissionScope Manage plans and orders of Pricing Plans
+ * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS-AND-ORDERS
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @permissionId PRICING_PLANS.READ_ORDERS
+ * @webhook
+ * @eventType wix.pricing_plans.v2.order_start_date_changed
+ * @serviceIdentifier com.wixpress.membership.v2.orders.CheckoutService
+ * @slug start_date_changed
+ */
+declare function onOrderStartDateChanged(handler: (event: OrderStartDateChangedEnvelope) => void | Promise<void>): void;
+/**
+ * Retrieves an order by ID.
  * @param _id - Order ID.
  * @public
  * @requiredField _id
- * @param options - Options for getting a logged-in member's order.
- * @permissionId PRICING_PLANS.READ_OWN_ORDERS
+ * @param options - Options to use when getting an order.
+ * @permissionId PRICING_PLANS.READ_ORDERS
  * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
  */
-declare function memberGetOrder(_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>>;
-interface MemberGetOrderOptions {
+declare function managementGetOrder(_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>>;
+interface ManagementGetOrderOptions {
     /**
      * Predefined set of fields to return.
      *
@@ -2109,36 +2119,51 @@ interface MemberGetOrderOptions {
     fieldSet?: SetWithLiterals;
 }
 /**
- * Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
+ * 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.
  * @public
  * @param options - Filtering, sorting, and pagination options.
- * @permissionId PRICING_PLANS.READ_OWN_ORDERS
+ * @permissionId PRICING_PLANS.READ_ORDERS
  * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
  */
-declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `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>>;
-interface MemberListOrdersOptions {
+declare function managementListOrders(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>>;
+interface ManagementListOrdersOptions {
     /**
-     * Filter by plan IDs.
+     * Filter by a buyer's member ID, from the Members API.
+     * @format GUID
+     */
+    buyerIds?: string[];
+    /**
+     * Filter by plan IDs, from the Plans API.
      * @format GUID
      */
     planIds?: string[];
-    /** Filter for orders where auto renewal was canceled. */
+    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
     autoRenewCanceled?: boolean | null;
     /** Filter by order status. */
     orderStatuses?: OrderStatusWithLiterals[];
     /** Filter by payment status. */
     paymentStatuses?: PaymentStatusWithLiterals[];
     /**
-     * Limit the number of pricing plans returned. Default limit is 50.
+     * Number of orders to return. See Sorting and Paging for more information.
+     *
+     * Max: `50`
      * @min 1
      * @max 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. */
+    /**
+     * Sort order.
+     *
+     * Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `DESC`.
+     */
     sorting?: Sorting;
     /**
      * Predefined set of fields to return.
@@ -2148,26 +2173,106 @@ interface MemberListOrdersOptions {
     fieldSet?: SetWithLiterals;
 }
 /**
- * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
+ * 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.
  *
- * 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.
+ * 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 _id - Order ID.
+ * @param endDate - New end date and time.
  *
- * 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 won't be billed. The buyer may continue using the benefits until the end of the free trial period.
+ * Must be later than the current end date and time.
+ * @public
+ * @requiredField _id
+ * @requiredField endDate
+ * @param options - Options for postponing the end date of an order.
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
+ */
+declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
+/**
+ * Cancels an existing order.
  *
- * >**Note:**
- * >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
+ * 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 _id - Order ID.
- * @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
+ * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
  * @public
  * @requiredField _id
  * @requiredField effectiveAt
- * @param options - Options for requesting a cancellation.
- * @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
+ * @param options - Options for canceling orders.
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
  * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
  */
-declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
+declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
+/**
+ * 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 _id - Order ID.
+ * @public
+ * @requiredField _id
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
+ */
+declare function markAsPaid(_id: string): Promise<void>;
+/**
+ * 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 _id - Order ID.
+ * @public
+ * @requiredField _id
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
+ */
+declare function pauseOrder(_id: string): Promise<void>;
+/**
+ * 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 _id - Order ID.
+ * @public
+ * @requiredField _id
+ * @permissionId PRICING_PLANS.MANAGE_ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
+ */
+declare function resumeOrder(_id: string): Promise<void>;
 /**
  * Creates an online order for a site member.
  *
@@ -2363,18 +2468,19 @@ interface GetPricePreviewOptions {
     couponCode?: string | null;
 }
 /**
- * Retrieves an order by ID.
+ * Retrieves an order for the currently logged-in member by ID.
  * @param _id - Order ID.
  * @public
  * @requiredField _id
- * @param options - Options to use when getting an order.
- * @permissionId PRICING_PLANS.READ_ORDERS
+ * @param options - Options for getting a logged-in member's order.
+ * @permissionId PRICING_PLANS.READ_OWN_ORDERS
  * @applicableIdentity APP
- * @returns Order.
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
+ * @applicableIdentity MEMBER
+ * @returns Requested order.
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.GetOrder
  */
-declare function managementGetOrder(_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>>;
-interface ManagementGetOrderOptions {
+declare function memberGetOrder(_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>>;
+interface MemberGetOrderOptions {
     /**
      * Predefined set of fields to return.
      *
@@ -2383,51 +2489,36 @@ interface ManagementGetOrderOptions {
     fieldSet?: SetWithLiterals;
 }
 /**
- * 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.
+ * Retrieves a list of up to 100 pricing plan orders for currently logged-in member.
  * @public
  * @param options - Filtering, sorting, and pagination options.
- * @permissionId PRICING_PLANS.READ_ORDERS
+ * @permissionId PRICING_PLANS.READ_OWN_ORDERS
  * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ListOrders
+ * @applicableIdentity MEMBER
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.ListOrders
  */
-declare function managementListOrders(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>>;
-interface ManagementListOrdersOptions {
-    /**
-     * Filter by a buyer's member ID, from the Members API.
-     * @format GUID
-     */
-    buyerIds?: string[];
+declare function memberListOrders(options?: MemberListOrdersOptions): Promise<NonNullablePaths<MemberListOrdersResponse, `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>>;
+interface MemberListOrdersOptions {
     /**
-     * Filter by plan IDs, from the Plans API.
+     * Filter by plan IDs.
      * @format GUID
      */
     planIds?: string[];
-    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
+    /** Filter for orders where auto renewal was canceled. */
     autoRenewCanceled?: boolean | null;
     /** Filter by order status. */
     orderStatuses?: OrderStatusWithLiterals[];
     /** Filter by payment status. */
     paymentStatuses?: PaymentStatusWithLiterals[];
     /**
-     * Number of orders to return. See Sorting and Paging for more information.
-     *
-     * Max: `50`
+     * Limit the number of pricing plans returned. Default limit is 50.
      * @min 1
      * @max 50
      */
     limit?: number | null;
-    /** Number of orders to skip in the current sort order. */
+    /** Number of entries to offset. */
     offset?: number | null;
-    /**
-     * Sort order.
-     *
-     * Use `ASC` for ascending order or `DESC` for descending order.
-     *
-     * Default: `DESC`.
-     */
+    /** Sorting direction (defaults to ASC) and field to sort by. */
     sorting?: Sorting;
     /**
      * Predefined set of fields to return.
@@ -2437,105 +2528,25 @@ interface ManagementListOrdersOptions {
     fieldSet?: SetWithLiterals;
 }
 /**
- * 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 _id - Order ID.
- * @param endDate - New end date and time.
- *
- * Must be later than the current end date and time.
- * @public
- * @requiredField _id
- * @requiredField endDate
- * @param options - Options for postponing the end date of an order.
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
- * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PostponeEndDate
- */
-declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
-/**
- * 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`.
+ * Cancels an order. Recurring orders can be canceled either immediately or at the next payment date. One time orders can only be canceled immediately.
  *
- * #### Canceling during the free trial period.
+ * 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.
  *
- * 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.
+ * 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 won't 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.
+ * >**Note:**
+ * >This method requires [visitor or member authentication](https://dev.wix.com/docs/rest/articles/getting-started/access-types-and-permissions).
  * @param _id - Order ID.
- * @param effectiveAt - __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`.
+ * @param effectiveAt - Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately.
  * @public
  * @requiredField _id
  * @requiredField effectiveAt
- * @param options - Options for canceling orders.
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
- * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.CancelOrder
- */
-declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
-/**
- * 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 _id - Order ID.
- * @public
- * @requiredField _id
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
- * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.MarkAsPaid
- */
-declare function markAsPaid(_id: string): Promise<void>;
-/**
- * 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 _id - Order ID.
- * @public
- * @requiredField _id
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
- * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.PauseOrder
- */
-declare function pauseOrder(_id: string): Promise<void>;
-/**
- * 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 _id - Order ID.
- * @public
- * @requiredField _id
- * @permissionId PRICING_PLANS.MANAGE_ORDERS
+ * @param options - Options for requesting a cancellation.
+ * @permissionId PRICING_PLANS.MANAGE_OWN_ORDERS
  * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
+ * @applicableIdentity MEMBER
+ * @fqn com.wixpress.membership.v2.orders.member.MemberOrdersService.RequestCancellation
  */
-declare function resumeOrder(_id: string): Promise<void>;
+declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAtWithLiterals): Promise<void>;
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, 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 { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type AddressLocation, type ApplicationError, type ApplyCouponRequest, type ApplyCouponResponse, type BaseEventMetadata, type BulkActionMetadata, type BulkOrderResult, type BulkPauseOrderRequest, type BulkPauseOrderResponse, type BulkResumeOrderRequest, type BulkResumeOrderResponse, type Buyer, type CancelOrderRequest, type CancelOrderResponse, type Cancellation, CancellationCause, type CancellationCauseWithLiterals, CancellationEffectiveAt, type CancellationEffectiveAtWithLiterals, type Captcha, type ChangeStartDateRequest, type ChangeStartDateResponse, type Coupon, type CouponsError, type CreateExternalOrderRequest, type CreateExternalOrderResponse, type CreateGuestOnlineOrderRequest, type CreateGuestOnlineOrderResponse, type CreateOfflineOrderApplicationErrors, type CreateOfflineOrderOptions, type CreateOfflineOrderRequest, type CreateOfflineOrderResponse, type CreateOfflineOrderValidationErrors, type CreateOnlineOrderApplicationErrors, type CreateOnlineOrderOptions, type CreateOnlineOrderRequest, type CreateOnlineOrderResponse, type CreateOnlineOrderValidationErrors, type CurrentCycle, type Cursors, type DomainEvent, type DomainEventBodyOneOf, type Duration, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type Fee, type FormData, type GetAvailableOrderActionsRequest, type GetAvailableOrderActionsResponse, type GetGuestOnlineOrderPreviewRequest, type GetGuestOnlineOrderPreviewResponse, type GetOfflineOrderPreviewApplicationErrors, type GetOfflineOrderPreviewOptions, type GetOfflineOrderPreviewRequest, type GetOfflineOrderPreviewResponse, type GetOfflineOrderPreviewValidationErrors, type GetOnlineOrderPreviewApplicationErrors, type GetOnlineOrderPreviewOptions, type GetOnlineOrderPreviewRequest, type GetOnlineOrderPreviewResponse, type GetOnlineOrderPreviewValidationErrors, type GetOrderRequest, type GetOrderResponse, type GetOrdersStatsRequest, type GetOrdersStatsResponse, type GetPricePreviewApplicationErrors, type GetPricePreviewOptions, type GetPricePreviewRequest, type GetPricePreviewResponse, type Guest, type IdentificationData, type IdentificationDataIdOneOf, type ItemMetadata, type ListOrdersRequest, type ListOrdersResponse, type ManagementGetOrderOptions, type ManagementListOrdersOptions, type MarkAsPaidRequest, type MarkAsPaidResponse, type MemberGetOrderOptions, type MemberGetOrderRequest, type MemberGetOrderResponse, type MemberListOrdersOptions, type MemberListOrdersRequest, type MemberListOrdersResponse, type MessageEnvelope, type OnBehalf, type Order, type OrderAutoRenewCanceled, type OrderAutoRenewCanceledEnvelope, type OrderCanceled, type OrderCanceledEnvelope, type OrderCreatedEnvelope, type OrderCycle, type OrderCycleStarted, type OrderCycleStartedEnvelope, type OrderEndDatePostponed, type OrderEndDatePostponedEnvelope, type OrderEnded, type OrderEndedEnvelope, type OrderMarkedAsPaid, type OrderMarkedAsPaidEnvelope, OrderMethod, type OrderMethodWithLiterals, type OrderPaused, type OrderPausedEnvelope, type OrderPurchased, type OrderPurchasedEnvelope, type OrderResumed, type OrderResumedEnvelope, type OrderStartDateChanged, type OrderStartDateChangedEnvelope, type OrderStarted, type OrderStartedEnvelope, OrderStatus, type OrderStatusWithLiterals, OrderType, type OrderTypeWithLiterals, type OrderUpdatedEnvelope, type PagingMetadataV2, type PauseOrderRequest, type PauseOrderResponse, type PausePeriod, PaymentStatus, type PaymentStatusWithLiterals, PeriodUnit, type PeriodUnitWithLiterals, type PostponeEndDateRequest, type PostponeEndDateResponse, type Price, type PriceDetails, type PriceDetailsPricingModelOneOf, type PriceDuration, type PricingDetails, type PricingDetailsPricingModelOneOf, ReasonNotSuspendable, type ReasonNotSuspendableWithLiterals, type Recurrence, type RequestCancellationRequest, type RequestCancellationResponse, type RestoreInfo, type ResumeOrderRequest, type ResumeOrderResponse, Set, type SetSubmissionRequest, type SetSubmissionResponse, type SetWithLiterals, SortOrder, type SortOrderWithLiterals, type Sorting, type SpannedPrice, Status, type StatusWithLiterals, type Tax, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, 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 };