@wix/auto_sdk_pricing-plans_orders 1.0.143 → 1.0.144

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

@@ -666,322 +666,373 @@ interface ActionEvent {
 }
 interface Empty {
 }
-interface CreateOnlineOrderRequest {
-    /**
-     * Plan ID.
-     * @format GUID
-     */
-    planId: string;
-    /**
-     * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
-     *
-     * Default: Current date and time.
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
-    /** Provided if checkout is initiated on buyer's behalf. */
-    onBehalf?: OnBehalf;
-    /**
-     * Submission ID of the form submitted with this order.
-     *
-     * The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
-     * An invalid submission ID is dropped and the order is created without a submission.
-     * @format GUID
-     */
-    submissionId?: string | null;
+interface OrderPurchased {
+    /** Order that was paid for. If a free or an offline order, the order that was created. */
+    order?: Order;
 }
-interface OnBehalf {
-    /**
-     * Member ID.
-     * @format GUID
-     */
-    memberId?: string;
-    /** Method by which checkout is initiated. */
-    orderMethod?: OrderMethodWithLiterals;
+interface OrderStarted {
+    /** Order that reached its `startDate`. */
+    order?: Order;
 }
-interface CreateOnlineOrderResponse {
-    /** Created online 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;
 }
-interface CouponsError {
-    /** Coupon code. */
-    couponCode?: string;
-    /** Plan ID. */
-    planId?: string;
+/** 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 CreateGuestOnlineOrderRequest {
+interface OrderEnded {
+    /** Order that ended. */
+    order?: Order;
+}
+interface GetOrderRequest {
     /**
-     * Plan ID.
+     * Order ID.
      * @format GUID
      */
-    planId?: string;
+    _id: string;
     /**
-     * Start date for the ordered plan.
+     * Predefined set of fields to return.
      *
-     * Default: Current date
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
-    /** Captcha data to prove you are not a robot */
-    captcha?: Captcha;
-    /** Visitor info */
-    guest?: Guest;
-    /**
-     * Form submission id that was submitted together with the order
-     * @format GUID
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
      */
-    submissionId?: string | null;
-}
-interface Captcha {
-    /** Token from captcha */
-    token?: string;
+    fieldSet?: SetWithLiterals;
 }
-interface Guest {
-    /**
-     * Email for checkout
-     * @format EMAIL
-     */
-    email?: string;
+declare enum Set {
+    /** Same behavior as `BASIC`.` */
+    UNKNOWN_SET = "UNKNOWN_SET",
+    /** Doesn't return any order form submission data. */
+    BASIC = "BASIC",
+    /** Returns all order form submission data. */
+    FULL = "FULL"
 }
-interface CreateGuestOnlineOrderResponse {
+/** @enumType */
+type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
+interface GetOrderResponse {
     /** Order. */
     order?: Order;
 }
-interface CreateOfflineOrderRequest {
+interface ListOrdersRequest {
     /**
-     * ID of the plan being ordered, from the Plans API.
+     * Filter by a buyer's member ID, from the Members API.
      * @format GUID
      */
-    planId: string;
+    buyerIds?: string[];
     /**
-     * ID of the member ordering the plan, from the Members API.
+     * Filter by plan IDs, from the Plans API.
      * @format GUID
      */
-    memberId: string;
+    planIds?: string[];
+    /** 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[];
     /**
-     * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     * Number of orders to return. See Sorting and Paging for more information.
      *
-     * Default: Current date and time.
+     * Max: `50`
+     * @min 1
+     * @max 50
      */
-    startDate?: Date | null;
+    limit?: number | null;
+    /** Number of orders to skip in the current sort order. */
+    offset?: number | null;
     /**
-     * Whether the order is paid.
+     * Sort order.
      *
-     * Default: `false`
-     */
-    paid?: boolean | null;
-    /**
-     * Coupon code to apply, from the Coupons API.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
-    /**
-     * Form submission ID that was submitted with the order.
+     * Use `ASC` for ascending order or `DESC` for descending order.
      *
-     * The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
-     * An invalid submission ID is dropped and the order is created without a submission.
-     * @format GUID
+     * Default: `DESC`.
      */
-    submissionId?: string | null;
-}
-interface CreateOfflineOrderResponse {
-    /** Order. */
-    order?: Order;
-}
-interface CreateExternalOrderRequest {
+    sorting?: Sorting;
     /**
-     * Plan ID.
-     * @format GUID
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
      */
-    planId?: string;
+    fieldSet?: SetWithLiterals;
     /**
-     * Form submission id that was submitted together with the order
+     * Filter by order IDs.
+     * @internal
      * @format GUID
+     * @maxSize 50
      */
-    submissionId?: string | null;
-}
-interface CreateExternalOrderResponse {
-    /** Created order */
-    order?: Order;
+    orderIds?: string[];
 }
-interface GetOnlineOrderPreviewRequest {
+interface Sorting {
     /**
-     * Plan ID.
-     * @format GUID
+     * Name of the field to sort by.
+     * @maxLength 512
      */
-    planId: string;
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
     /**
-     * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
+     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
      *
-     * Default: Current date and time.
+     * If multiple filters are provided, they are combined with AND operator.
+     *
+     * Example:
+     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
+     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
+     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
+     * @internal
+     * @maxSize 10
      */
-    startDate?: Date | null;
+    selectItemsBy?: Record<string, any>[] | null;
     /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
+     * Origin point for geo-distance sorting on a GEO field
+     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
      */
-    couponCode?: string | null;
+    origin?: AddressLocation;
 }
-interface GetOnlineOrderPreviewResponse {
-    /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
-    order?: Order;
-    /** Whether the member has already reached purchase limit for the order's plan. */
-    purchaseLimitExceeded?: boolean;
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
 }
-interface GetGuestOnlineOrderPreviewRequest {
-    /**
-     * Plan ID.
-     * @format GUID
-     */
-    planId?: string;
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+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;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
     /**
-     * Start date for the ordered plan.
-     *
-     * Default: Current date
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     * @internal
      */
-    startDate?: Date | null;
+    hasNext?: boolean | null;
+}
+interface Cursors {
     /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
      */
-    couponCode?: string | null;
+    next?: string | null;
     /**
-     * Email for checkout
-     * @format EMAIL
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
      */
-    email?: string;
+    prev?: string | null;
 }
-interface GetGuestOnlineOrderPreviewResponse {
-    /** Will be missing if limit is exceeded */
-    order?: Order;
+interface GetOrdersStatsRequest {
+}
+interface GetOrdersStatsResponse {
+    /** Total number of orders. */
+    totalOrderCount?: number;
+    /** Number of active orders. */
+    activeOrderCount?: number;
+}
+interface GetAvailableOrderActionsRequest {
     /**
-     * Whether the purchase limit has already been reached for this plan by this email.
-     * Always false for plans without purchase limits.
+     * Order ID.
+     * @format GUID
      */
-    purchaseLimitExceeded?: boolean;
+    _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"
 }
-interface GetOfflineOrderPreviewRequest {
-    /**
-     * ID of the plan of the previewed order, from the Plans API.
-     * @format GUID
-     */
-    planId: string;
+/** @enumType */
+type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
+interface PostponeEndDateRequest {
     /**
-     * Member ID of the buyer the previewed order is for, from the Members API.
+     * Order ID.
      * @format GUID
      */
-    memberId: string;
+    _id: string;
     /**
-     * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     * New end date and time.
      *
-     * Default: Current date and time.
-     */
-    startDate?: Date | null;
-    /**
-     * Coupon code to apply, from the Coupons API.
-     * @minLength 1
-     * @maxLength 20
+     * Must be later than the current end date and time.
      */
-    couponCode?: string | null;
+    endDate: Date | null;
 }
-interface GetOfflineOrderPreviewResponse {
-    /** The previewed order, as if the plan had been ordered. */
+interface PostponeEndDateResponse {
+}
+interface OrderEndDatePostponed {
+    /** Order whose `endDate` was postponed. */
     order?: Order;
-    /**
-     * Whether this previewed order would exceed the permitted amount of purchases available
-     * for this plan for this buyer.
-     *
-     * Always `false` for plans that do not have purchase limits.
-     */
-    purchaseLimitExceeded?: boolean;
 }
-interface GetPricePreviewRequest {
+interface CancelOrderRequest {
     /**
-     * ID of plan to preview.
+     * Order ID.
      * @format GUID
      */
-    planId: string;
-    /**
-     * Coupon code to apply, from the Coupons API.
-     * @minLength 1
-     * @maxLength 20
-     */
-    couponCode?: string | null;
+    _id: string;
+    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
+    effectiveAt: CancellationEffectiveAtWithLiterals;
 }
-interface GetPricePreviewResponse {
-    /**
-     * @internal
-     * @internal
-     * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
-     * @replacedBy prices
-     * @targetRemovalDate 2022-10-01
-     */
-    price?: PriceDetails;
-    /** Pricing details. */
-    prices?: SpannedPrice[];
+interface CancelOrderResponse {
 }
-interface ChangeStartDateRequest {
+/**
+ * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
+ *
+ * To determine the specific reason of the cancellation check `order.cancellation.cause` field.
+ */
+interface OrderCanceled {
+    /** Canceled order. */
+    order?: Order;
+}
+interface MarkAsPaidRequest {
     /**
-     * Draft order ID.
+     * Order ID.
      * @format GUID
      */
-    orderId?: string;
-    /** New valid from date (timestamp). */
-    startDate?: Date | null;
+    _id: string;
 }
-interface ChangeStartDateResponse {
-    /** Updated draft order. */
-    order?: Order;
+interface MarkAsPaidResponse {
 }
-interface OrderStartDateChanged {
-    /** Order whose `startDate` changed. */
+interface OrderMarkedAsPaid {
+    /** Order that was marked as paid. */
     order?: Order;
 }
-interface ApplyCouponRequest {
+interface PauseOrderRequest {
     /**
-     * Draft order ID.
+     * Order ID.
      * @format GUID
      */
-    orderId?: string;
+    _id: string;
+}
+interface PauseOrderResponse {
+}
+interface OrderPaused {
+    /** Paused order. */
+    order?: Order;
+}
+interface BulkPauseOrderRequest {
     /**
-     * Coupon code to apply.
-     * @minLength 1
-     * @maxLength 20
+     * List of Order IDs.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
      */
-    couponCode?: string;
+    ids?: string[];
+    /** Set to true to return Order entity in response. */
+    returnFullEntity?: boolean;
 }
-interface ApplyCouponResponse {
-    /** Order with applied coupon and recalculated tax. */
+interface BulkPauseOrderResponse {
+    /** Orders that were paused. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkOrderResult {
+    /** Item metadata */
+    itemMetadata?: ItemMetadata;
+    /** The order. */
     order?: Order;
 }
-interface SetSubmissionRequest {
+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
      */
-    orderId?: string;
+    _id: string;
+}
+interface ResumeOrderResponse {
+}
+interface OrderResumed {
+    /** Resumed order. */
+    order?: Order;
+}
+interface BulkResumeOrderRequest {
     /**
-     * Submission ID.
+     * List of Order IDs.
      * @format GUID
+     * @minSize 1
+     * @maxSize 100
      */
-    submissionId?: string;
+    ids?: string[];
+    /** Set to true to return Order entity in response. */
+    returnFullEntity?: boolean;
 }
-interface SetSubmissionResponse {
-    /** Order with submission id */
-    order?: Order;
+interface BulkResumeOrderResponse {
+    /** Orders that were resumed. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
 }
 interface MessageEnvelope {
     /**
@@ -1074,373 +1125,322 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
-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;
+interface CreateOnlineOrderRequest {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     *
+     * Default: Current date and time.
+     */
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /** Provided if checkout is initiated on buyer's behalf. */
+    onBehalf?: OnBehalf;
+    /**
+     * Submission ID of the form submitted with this order.
+     *
+     * The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
+     * An invalid submission ID is dropped and the order is created without a submission.
+     * @format GUID
+     */
+    submissionId?: string | null;
 }
-/**
- * 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;
+interface OnBehalf {
+    /**
+     * Member ID.
+     * @format GUID
+     */
+    memberId?: string;
+    /** Method by which checkout is initiated. */
+    orderMethod?: OrderMethodWithLiterals;
 }
-/** 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. */
+interface CreateOnlineOrderResponse {
+    /** Created online order. */
     order?: Order;
 }
-interface OrderEnded {
-    /** Order that ended. */
-    order?: Order;
+interface CouponsError {
+    /** Coupon code. */
+    couponCode?: string;
+    /** Plan ID. */
+    planId?: string;
 }
-interface GetOrderRequest {
+interface CreateGuestOnlineOrderRequest {
     /**
-     * Order ID.
+     * Plan ID.
      * @format GUID
      */
-    _id: string;
+    planId?: string;
     /**
-     * Predefined set of fields to return.
+     * Start date for the ordered plan.
      *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     * Default: Current date
      */
-    fieldSet?: SetWithLiterals;
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /** Captcha data to prove you are not a robot */
+    captcha?: Captcha;
+    /** Visitor info */
+    guest?: Guest;
+    /**
+     * Form submission id that was submitted together with the order
+     * @format GUID
+     */
+    submissionId?: string | null;
 }
-declare enum Set {
-    /** Same behavior as `BASIC`.` */
-    UNKNOWN_SET = "UNKNOWN_SET",
-    /** Doesn't return any order form submission data. */
-    BASIC = "BASIC",
-    /** Returns all order form submission data. */
-    FULL = "FULL"
+interface Captcha {
+    /** Token from captcha */
+    token?: string;
 }
-/** @enumType */
-type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
-interface GetOrderResponse {
+interface Guest {
+    /**
+     * Email for checkout
+     * @format EMAIL
+     */
+    email?: string;
+}
+interface CreateGuestOnlineOrderResponse {
     /** Order. */
     order?: Order;
 }
-interface ListOrdersRequest {
+interface CreateOfflineOrderRequest {
     /**
-     * Filter by a buyer's member ID, from the Members API.
+     * ID of the plan being ordered, from the Plans API.
      * @format GUID
      */
-    buyerIds?: string[];
+    planId: string;
     /**
-     * Filter by plan IDs, from the Plans API.
+     * ID of the member ordering the plan, from the Members API.
      * @format GUID
      */
-    planIds?: string[];
-    /** 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[];
+    memberId: string;
     /**
-     * Number of orders to return. See Sorting and Paging for more information.
+     * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
      *
-     * Max: `50`
-     * @min 1
-     * @max 50
+     * Default: Current date and time.
      */
-    limit?: number | null;
-    /** Number of orders to skip in the current sort order. */
-    offset?: number | null;
+    startDate?: Date | null;
     /**
-     * Sort order.
-     *
-     * Use `ASC` for ascending order or `DESC` for descending order.
+     * Whether the order is paid.
      *
-     * Default: `DESC`.
+     * Default: `false`
      */
-    sorting?: Sorting;
+    paid?: boolean | null;
     /**
-     * Predefined set of fields to return.
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /**
+     * Form submission ID that was submitted with the order.
      *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     * The submission must belong to the form attached to the plan, and that form must belong to the Pricing Plans namespace.
+     * An invalid submission ID is dropped and the order is created without a submission.
+     * @format GUID
      */
-    fieldSet?: SetWithLiterals;
+    submissionId?: string | null;
+}
+interface CreateOfflineOrderResponse {
+    /** Order. */
+    order?: Order;
+}
+interface CreateExternalOrderRequest {
     /**
-     * Filter by order IDs.
-     * @internal
+     * Plan ID.
      * @format GUID
-     * @maxSize 50
      */
-    orderIds?: string[];
+    planId?: string;
+    /**
+     * Form submission id that was submitted together with the order
+     * @format GUID
+     */
+    submissionId?: string | null;
 }
-interface Sorting {
+interface CreateExternalOrderResponse {
+    /** Created order */
+    order?: Order;
+}
+interface GetOnlineOrderPreviewRequest {
     /**
-     * Name of the field to sort by.
-     * @maxLength 512
+     * Plan ID.
+     * @format GUID
      */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrderWithLiterals;
+    planId: string;
     /**
-     * When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by
-     * a specific element from a collection, filter can/should be provided to ensure correct sort value is picked.
-     *
-     * If multiple filters are provided, they are combined with AND operator.
+     * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
      *
-     * Example:
-     * Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]}
-     * and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be
-     * { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
-     * @internal
-     * @maxSize 10
+     * Default: Current date and time.
      */
-    selectItemsBy?: Record<string, any>[] | null;
+    startDate?: Date | null;
     /**
-     * Origin point for geo-distance sorting on a GEO field
-     * results are ordered by distance from this point (ASC = nearest first, DESC = farthest first).
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
      */
-    origin?: AddressLocation;
-}
-declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-/** @enumType */
-type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
-interface AddressLocation {
-    /** Address latitude. */
-    latitude?: number | null;
-    /** Address longitude. */
-    longitude?: number | null;
+    couponCode?: string | null;
 }
-interface ListOrdersResponse {
-    /** List of orders. */
-    orders?: Order[];
-    /** Object containing paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
+interface GetOnlineOrderPreviewResponse {
+    /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
+    order?: Order;
+    /** Whether the member has already reached purchase limit for the order's plan. */
+    purchaseLimitExceeded?: boolean;
 }
-interface PagingMetadataV2 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
+interface GetGuestOnlineOrderPreviewRequest {
     /**
-     * Indicates if there are more results after the current page.
-     * If `true`, another page of results can be retrieved.
-     * If `false`, this is the last page.
-     * @internal
+     * Plan ID.
+     * @format GUID
      */
-    hasNext?: boolean | null;
-}
-interface Cursors {
+    planId?: string;
     /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
+     * Start date for the ordered plan.
+     *
+     * Default: Current date
      */
-    next?: string | null;
+    startDate?: Date | null;
     /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
      */
-    prev?: string | null;
-}
-interface GetOrdersStatsRequest {
-}
-interface GetOrdersStatsResponse {
-    /** Total number of orders. */
-    totalOrderCount?: number;
-    /** Number of active orders. */
-    activeOrderCount?: number;
-}
-interface GetAvailableOrderActionsRequest {
+    couponCode?: string | null;
     /**
-     * Order ID.
-     * @format GUID
+     * Email for checkout
+     * @format EMAIL
      */
-    _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"
+    email?: string;
 }
-/** @enumType */
-type ReasonNotSuspendableWithLiterals = ReasonNotSuspendable | 'UNDEFINED' | 'PENDING' | 'TRIAL' | 'CANCELED' | 'ENDED' | 'NOT_STARTED' | 'ALREADY_SUSPENDED' | 'OLD_STRIPE';
-interface PostponeEndDateRequest {
+interface GetGuestOnlineOrderPreviewResponse {
+    /** Will be missing if limit is exceeded */
+    order?: Order;
+    /**
+     * Whether the purchase limit has already been reached for this plan by this email.
+     * Always false for plans without purchase limits.
+     */
+    purchaseLimitExceeded?: boolean;
+}
+interface GetOfflineOrderPreviewRequest {
     /**
-     * Order ID.
+     * ID of the plan of the previewed order, from the Plans API.
      * @format GUID
      */
-    _id: string;
+    planId: string;
     /**
-     * New end date and time.
+     * Member ID of the buyer the previewed order is for, from the Members API.
+     * @format GUID
+     */
+    memberId: string;
+    /**
+     * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
      *
-     * Must be later than the current end date and time.
+     * Default: Current date and time.
      */
-    endDate: Date | null;
-}
-interface PostponeEndDateResponse {
-}
-interface OrderEndDatePostponed {
-    /** Order whose `endDate` was postponed. */
-    order?: Order;
-}
-interface CancelOrderRequest {
+    startDate?: Date | null;
     /**
-     * Order ID.
-     * @format GUID
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
      */
-    _id: string;
-    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
-    effectiveAt: CancellationEffectiveAtWithLiterals;
-}
-interface CancelOrderResponse {
+    couponCode?: string | null;
 }
-/**
- * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
- *
- * To determine the specific reason of the cancellation check `order.cancellation.cause` field.
- */
-interface OrderCanceled {
-    /** Canceled order. */
+interface GetOfflineOrderPreviewResponse {
+    /** The previewed order, as if the plan had been ordered. */
     order?: Order;
+    /**
+     * Whether this previewed order would exceed the permitted amount of purchases available
+     * for this plan for this buyer.
+     *
+     * Always `false` for plans that do not have purchase limits.
+     */
+    purchaseLimitExceeded?: boolean;
 }
-interface MarkAsPaidRequest {
+interface GetPricePreviewRequest {
     /**
-     * Order ID.
+     * ID of plan to preview.
      * @format GUID
      */
-    _id: string;
-}
-interface MarkAsPaidResponse {
+    planId: string;
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
 }
-interface OrderMarkedAsPaid {
-    /** Order that was marked as paid. */
-    order?: Order;
+interface GetPricePreviewResponse {
+    /**
+     * @internal
+     * @internal
+     * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
+     * @replacedBy prices
+     * @targetRemovalDate 2022-10-01
+     */
+    price?: PriceDetails;
+    /** Pricing details. */
+    prices?: SpannedPrice[];
 }
-interface PauseOrderRequest {
+interface ChangeStartDateRequest {
     /**
-     * Order ID.
+     * Draft order ID.
      * @format GUID
      */
-    _id: string;
+    orderId?: string;
+    /** New valid from date (timestamp). */
+    startDate?: Date | null;
 }
-interface PauseOrderResponse {
+interface ChangeStartDateResponse {
+    /** Updated draft order. */
+    order?: Order;
 }
-interface OrderPaused {
-    /** Paused order. */
+interface OrderStartDateChanged {
+    /** Order whose `startDate` changed. */
     order?: Order;
 }
-interface BulkPauseOrderRequest {
+interface ApplyCouponRequest {
     /**
-     * List of Order IDs.
+     * Draft order ID.
      * @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;
+    orderId?: string;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string;
 }
-interface BulkOrderResult {
-    /** Item metadata */
-    itemMetadata?: ItemMetadata;
-    /** The order. */
+interface ApplyCouponResponse {
+    /** Order with applied coupon and recalculated tax. */
     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 {
+interface SetSubmissionRequest {
     /**
      * Order ID.
      * @format GUID
      */
-    _id: string;
-}
-interface ResumeOrderResponse {
-}
-interface OrderResumed {
-    /** Resumed order. */
-    order?: Order;
-}
-interface BulkResumeOrderRequest {
+    orderId?: string;
     /**
-     * List of Order IDs.
+     * Submission ID.
      * @format GUID
-     * @minSize 1
-     * @maxSize 100
      */
-    ids?: string[];
-    /** Set to true to return Order entity in response. */
-    returnFullEntity?: boolean;
+    submissionId?: string;
 }
-interface BulkResumeOrderResponse {
-    /** Orders that were resumed. */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
+interface SetSubmissionResponse {
+    /** Order with submission id */
+    order?: Order;
 }
 interface MemberGetOrderRequest {
     /**
@@ -1855,84 +1855,7 @@ interface AccountInfoMetadata {
     siteId?: string;
     /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
     parentAccountId?: string;
-}
-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
- */
-declare function onOrderUpdated(handler: (event: OrderUpdatedEnvelope) => void | Promise<void>): void;
+}
 interface OrderAutoRenewCanceledEnvelope {
     data: OrderAutoRenewCanceled;
     metadata: EventMetadata;
@@ -2134,53 +2057,304 @@ interface OrderPurchasedEnvelope {
  * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
  * @slug purchased
  */
-declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
-interface OrderResumedEnvelope {
-    data: OrderResumed;
-    metadata: EventMetadata;
-}
+declare function onOrderPurchased(handler: (event: OrderPurchasedEnvelope) => void | Promise<void>): void;
+interface OrderResumedEnvelope {
+    data: OrderResumed;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when a paused order is resumed.
+ * @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_resumed
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
+ * @slug resumed
+ */
+declare function onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
+interface OrderStartedEnvelope {
+    data: OrderStarted;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
+ * @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_started
+ * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
+ * @slug started
+ */
+declare function onOrderStarted(handler: (event: OrderStartedEnvelope) => 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.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 to use when getting an order.
+ * @permissionId PRICING_PLANS.READ_ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
+ */
+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`, 5>>;
+interface ManagementGetOrderOptions {
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    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.
+ * @public
+ * @param options - Filtering, sorting, and pagination options.
+ * @permissionId PRICING_PLANS.READ_ORDERS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.membership.v2.orders.OrderManagementService.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`, 4>>;
+interface ManagementListOrdersOptions {
+    /**
+     * 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 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[];
+    /**
+     * Number of orders to return. See Sorting and Paging for more information.
+     *
+     * Max: `50`
+     * @min 1
+     * @max 50
+     */
+    limit?: number | null;
+    /** Number of orders to skip in the current sort order. */
+    offset?: number | null;
+    /**
+     * Sort order.
+     *
+     * Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `DESC`.
+     */
+    sorting?: Sorting;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    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`.
+ *
+ * #### 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.__ When the order will be canceled. 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>;
 /**
- * Triggered when a paused order is resumed.
- * @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_resumed
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
- * @slug resumed
+ * 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 onOrderResumed(handler: (event: OrderResumedEnvelope) => void | Promise<void>): void;
-interface OrderStartedEnvelope {
-    data: OrderStarted;
-    metadata: EventMetadata;
-}
+declare function pauseOrder(_id: string): Promise<void>;
 /**
- * Triggered when an order reaches its `startDate`. Applies to both purchased and free orders.
- * @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_started
- * @serviceIdentifier com.wixpress.membership.v2.orders.OrderManagementService
- * @slug started
+ * 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 onOrderStarted(handler: (event: OrderStartedEnvelope) => void | Promise<void>): void;
+declare function resumeOrder(_id: string): Promise<void>;
 /**
  * Creates an online order for a site member.
  *
@@ -2381,180 +2555,6 @@ interface GetPricePreviewOptions {
      */
     couponCode?: string | null;
 }
-/**
- * Retrieves an order by ID.
- * @param _id - Order ID.
- * @public
- * @requiredField _id
- * @param options - Options to use when getting an order.
- * @permissionId PRICING_PLANS.READ_ORDERS
- * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.GetOrder
- */
-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`, 5>>;
-interface ManagementGetOrderOptions {
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    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.
- * @public
- * @param options - Filtering, sorting, and pagination options.
- * @permissionId PRICING_PLANS.READ_ORDERS
- * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.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`, 4>>;
-interface ManagementListOrdersOptions {
-    /**
-     * 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 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[];
-    /**
-     * Number of orders to return. See Sorting and Paging for more information.
-     *
-     * Max: `50`
-     * @min 1
-     * @max 50
-     */
-    limit?: number | null;
-    /** Number of orders to skip in the current sort order. */
-    offset?: number | null;
-    /**
-     * Sort order.
-     *
-     * Use `ASC` for ascending order or `DESC` for descending order.
-     *
-     * Default: `DESC`.
-     */
-    sorting?: Sorting;
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    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`.
- *
- * #### 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.__ When the order will be canceled. 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
- * @applicableIdentity APP
- * @fqn com.wixpress.membership.v2.orders.OrderManagementService.ResumeOrder
- */
-declare function resumeOrder(_id: string): Promise<void>;
 /**
  * Retrieves an order for the currently logged-in member by ID.
  * @param _id - Order ID.