@wix/auto_sdk_pricing-plans_orders 1.0.2 → 1.0.4

package/build/internal/es/src/pricing-plans-v2-order-orders.types.d.ts

@@ -8,11 +8,13 @@
 export interface Order {
     /**
      * Order ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
     /**
      * ID of the plan purchased with the order, from the Plans API.
+     * @format GUID
      * @readonly
      */
     planId?: string;
@@ -21,6 +23,7 @@ export interface Order {
      *
      * Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. Learn more in
      * a [Pricing Plans overview](https://support.wix.com/en/article/pricing-plans-an-overview#create-plans-to-suit-your-business).
+     * @format GUID
      * @readonly
      */
     subscriptionId?: string;
@@ -28,6 +31,7 @@ export interface Order {
      * Wix Pay order ID.
      *
      * Provided by Wix whether the order is created online or offline. The field is omitted when the order is free.
+     * @format GUID
      * @readonly
      */
     wixPayOrderId?: string | null;
@@ -110,6 +114,8 @@ export interface Order {
      *
      * Only available for recurring plans.
      * @readonly
+     * @min 1
+     * @max 999
      */
     freeTrialDays?: number | null;
     /**
@@ -138,6 +144,7 @@ export interface Order {
     planDescription?: string;
     /**
      * Plan price as it was at the moment of order creation.
+     * @format DECIMAL_VALUE
      * @readonly
      */
     planPrice?: string;
@@ -160,11 +167,13 @@ export interface Order {
 export interface Buyer {
     /**
      * Member ID for a Wix site member, from the Members API.
+     * @format GUID
      * @readonly
      */
     memberId?: string;
     /**
      * Contact ID for a Wix site contact, from the Contacts API.
+     * @format GUID
      * @readonly
      */
     contactId?: string;
@@ -176,9 +185,15 @@ export interface PriceDetails extends PriceDetailsPricingModelOneOf {
     singlePaymentForDuration?: Duration;
     /** One-time payment. Order is valid until it is canceled. */
     singlePaymentUnlimited?: boolean | null;
-    /** Price of the order excluding tax, specified as a monetary amount. for example, `"9.99"`. */
+    /**
+     * Price of the order excluding tax, specified as a monetary amount. for example, `"9.99"`.
+     * @format DECIMAL_VALUE
+     */
     subtotal?: string;
-    /** Total discount applied. */
+    /**
+     * Total discount applied.
+     * @format DECIMAL_VALUE
+     */
     discount?: string;
     /** Tax applied. */
     tax?: Tax;
@@ -186,13 +201,24 @@ export interface PriceDetails extends PriceDetailsPricingModelOneOf {
      * Price after tax and discount is applied, specified as a monetary amount. For example, `"13.98"`.
      *
      * If no tax is applied, the amount is the same as `subtotal`.
+     * @format DECIMAL_VALUE
      */
     total?: string;
-    /** Plan price as it was at the moment of order creation. */
+    /**
+     * Plan price as it was at the moment of order creation.
+     * @format DECIMAL_VALUE
+     */
     planPrice?: string;
-    /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
+    /**
+     * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
+     * @format CURRENCY
+     */
     currency?: string;
-    /** Free trial period for the order in days. Only available for recurring plans. */
+    /**
+     * Free trial period for the order in days. Only available for recurring plans.
+     * @min 1
+     * @max 999
+     */
     freeTrialDays?: number | null;
     /** Coupon applied to the order. Empty means no coupon was applied. */
     coupon?: Coupon;
@@ -211,9 +237,15 @@ export interface Tax {
     name?: string;
     /** Whether tax is included in the original price. When `false`, tax is added at checkout. */
     includedInPrice?: boolean;
-    /** Tax rate percentage, as a number between 0 and 100. For example, a 7% tax rate is `"7.00"`. */
+    /**
+     * Tax rate percentage, as a number between 0 and 100. For example, a 7% tax rate is `"7.00"`.
+     * @format DECIMAL_VALUE
+     */
     rate?: string;
-    /** Total tax, specified as a monetary amount. For example, `"3.99"`. */
+    /**
+     * Total tax, specified as a monetary amount. For example, `"3.99"`.
+     * @format DECIMAL_VALUE
+     */
     amount?: string;
 }
 /** An object specifying how often and for how long payments recur (may be forever). */
@@ -227,12 +259,16 @@ export interface Recurrence {
      * Length of a payment cycle. For example, 1 month to have monthly payments.
      * Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration.
      * Currently, only a value of `1` is supported.
+     * @max 2000
      */
     cycleCount?: number | null;
 }
 /** A duration expressed in number of time units. */
 export interface Duration {
-    /** Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`. */
+    /**
+     * Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.
+     * @min 1
+     */
     count?: number | null;
     /** Unit of time for the cycle duration. */
     unit?: PeriodUnit;
@@ -250,12 +286,20 @@ export declare enum PeriodUnit {
     YEAR = "YEAR"
 }
 export interface Coupon {
-    /** Code of the applied coupon. */
+    /**
+     * Code of the applied coupon.
+     * @minLength 1
+     * @maxLength 20
+     */
     code?: string;
-    /** Total discount of the coupon, as a monetary amount. */
+    /**
+     * Total discount of the coupon, as a monetary amount.
+     * @format DECIMAL_VALUE
+     */
     amount?: string;
     /**
      * Coupon ID.
+     * @format GUID
      * @readonly
      */
     id?: string;
@@ -312,11 +356,17 @@ export interface PriceDuration {
     numberOfCycles?: number | null;
 }
 export interface Price {
-    /** Price of the order excluding tax, specified as a monetary amount. For example, `"9.99"`. */
+    /**
+     * Price of the order excluding tax, specified as a monetary amount. For example, `"9.99"`.
+     * @format DECIMAL_VALUE
+     */
     subtotal?: string;
     /** Coupon applied to the order, from the Coupons API. */
     coupon?: Coupon;
-    /** Total discount applied to the order. */
+    /**
+     * Total discount applied to the order.
+     * @format DECIMAL_VALUE
+     */
     discount?: string;
     /**
      * Tax applied to the order.
@@ -328,20 +378,32 @@ export interface Price {
      * Price after tax and discount is applied. Specified as a monetary amount, for example, `"13.98"`.
      *
      * If no tax is applied, the amount is the same as `subtotal`.
+     * @format DECIMAL_VALUE
      */
     total?: string;
     /**
      * Three-letter currency code in
      * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
      */
     currency?: string;
-    /** Price change after billing date was change and price was adjusted. Could be positive and negative values. */
+    /**
+     * Price change after billing date was change and price was adjusted. Could be positive and negative values.
+     * @format DECIMAL_VALUE
+     */
     proration?: string;
 }
 export interface Fee {
-    /** Fee name */
+    /**
+     * Fee name
+     * @minLength 1
+     * @maxLength 40
+     */
     name?: string;
-    /** Amount of fee to be charged */
+    /**
+     * Amount of fee to be charged
+     * @decimalValue options { lt:1000000000000, gt:0.000, maxScale:3 }
+     */
     amount?: string;
 }
 export declare enum OrderType {
@@ -474,9 +536,15 @@ export interface OrderCycle {
     endedDate?: Date | null;
 }
 export interface FormData {
-    /** ID of the order form ([REST](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction)) associated with the plan at checkout. */
+    /**
+     * ID of the order form ([REST](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction)) associated with the plan at checkout.
+     * @format GUID
+     */
     formId?: string | null;
-    /** ID of a submission to the plan's order form at checkout. Every time a visitor completes the checkout process for a plan, a new submission is created. */
+    /**
+     * ID of a submission to the plan's order form at checkout. Every time a visitor completes the checkout process for a plan, a new submission is created.
+     * @format GUID
+     */
     submissionId?: string | null;
     /**
      * Data submitted to the plan's order form at checkout.
@@ -558,8 +626,39 @@ export interface ActionEvent {
 }
 export interface Empty {
 }
-export interface MemberGetOrderRequest {
-    /** Order ID. */
+export interface OrderPurchased {
+    /** Order that was paid for. If a free or an offline order, the order that was created. */
+    order?: Order;
+}
+export 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.
+ */
+export 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 */
+export interface OrderAutoRenewCanceled {
+    /** Order that is canceled, effective at the end of the current payment cycle. */
+    order?: Order;
+}
+export interface OrderEnded {
+    /** Order that ended. */
+    order?: Order;
+}
+export interface GetOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
     id: string;
     /**
      * Predefined set of fields to return.
@@ -576,24 +675,44 @@ export declare enum Set {
     /** Returns all order form submission data. */
     FULL = "FULL"
 }
-export interface MemberGetOrderResponse {
-    /** Requested order. */
+export interface GetOrderResponse {
+    /** Order. */
     order?: Order;
 }
-export interface MemberListOrdersRequest {
-    /** Filter by plan IDs. */
+export interface ListOrdersRequest {
+    /**
+     * 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?: OrderStatus[];
     /** Filter by payment status. */
     paymentStatuses?: PaymentStatus[];
-    /** 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.
@@ -603,7 +722,10 @@ export interface MemberListOrdersRequest {
     fieldSet?: Set;
 }
 export interface Sorting {
-    /** Name of the field to sort by. */
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
     fieldName?: string;
     /** Sort order. */
     order?: SortOrder;
@@ -612,8 +734,8 @@ export declare enum SortOrder {
     ASC = "ASC",
     DESC = "DESC"
 }
-export interface MemberListOrdersResponse {
-    /** Requested orders. */
+export interface ListOrdersResponse {
+    /** List of orders. */
     orders?: Order[];
     /** Object containing paging-related data (number of orders returned, offset). */
     pagingMetadata?: PagingMetadataV2;
@@ -631,16 +753,18 @@ export interface PagingMetadataV2 {
     cursors?: Cursors;
 }
 export interface Cursors {
-    /** Cursor string pointing to the next page in the list of results. */
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
     next?: string | null;
-    /** Cursor pointing to the previous page in the list of results. */
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
     prev?: string | null;
 }
-/**
- * TODO: Write orders filter and sort docs page
- * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
- */
-export interface QueryOrdersRequest {
+export interface OrdersQueryOrdersRequest {
     /** Query filter. */
     query?: QueryV2;
 }
@@ -680,29 +804,96 @@ export interface Paging {
     offset?: number | null;
 }
 export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
     limit?: number | null;
     /**
      * Pointer to the next or previous page in the list of results.
      *
      * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
      * Not relevant for the first request.
+     * @maxLength 16000
      */
     cursor?: string | null;
 }
-export interface QueryOrdersResponse {
-    /** Order data. */
+export interface OrdersQueryOrdersResponse {
+    /** Retrieved orders. */
     plans?: Order[];
     /** Paging-related data (number of orders returned, offset). */
     pagingMetadata?: PagingMetadataV2;
 }
-export interface RequestCancellationRequest {
-    /** Order ID. */
+export interface GetOrdersStatsRequest {
+}
+export interface GetOrdersStatsResponse {
+    /** Total number of orders. */
+    totalOrderCount?: number;
+    /** Number of active orders. */
+    activeOrderCount?: number;
+}
+export interface GetAvailableOrderActionsRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id?: string;
+}
+export interface GetAvailableOrderActionsResponse {
+    /** Whether the order can be suspended. */
+    suspendable?: boolean;
+    /** If the order cannot be suspended, a reason is returned here. */
+    notSuspendableReason?: ReasonNotSuspendable;
+    /** Whether the order can be canceled by the buyer. */
+    cancelableByBuyer?: boolean;
+}
+export 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"
+}
+export 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;
+}
+export interface PostponeEndDateResponse {
+}
+export interface OrderEndDatePostponed {
+    /** Order whose `endDate` was postponed. */
+    order?: Order;
+}
+export interface CancelOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
     effectiveAt: CancellationEffectiveAt;
 }
-export interface RequestCancellationResponse {
+export interface CancelOrderResponse {
 }
 /**
  * Emitted when an order is canceled immediately or when cycle ends for an order with canceled auto renewal
@@ -713,94 +904,329 @@ export interface OrderCanceled {
     /** Canceled order. */
     order?: Order;
 }
-export interface MessageEnvelope {
-    /** App instance ID. */
-    instanceId?: string | null;
-    /** Event type. */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-    /** Stringify payload. */
-    data?: string;
-}
-export interface IdentificationData extends IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityType;
+export interface MarkAsPaidRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
 }
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /** ID of a site visitor that has not logged in to the site. */
-    anonymousVisitorId?: string;
-    /** ID of a site visitor that has logged in to the site. */
-    memberId?: string;
-    /** ID of a Wix user (site owner, contributor, etc.). */
-    wixUserId?: string;
-    /** ID of an app. */
-    appId?: string;
+export interface MarkAsPaidResponse {
 }
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
+export interface OrderMarkedAsPaid {
+    /** Order that was marked as paid. */
+    order?: Order;
 }
-export interface CreateOnlineOrderRequest {
-    /** Plan ID. */
-    planId: string;
+export interface PauseOrderRequest {
     /**
-     * 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.
+     * Order ID.
+     * @format GUID
      */
-    startDate?: Date | null;
-    /** Coupon code to apply. */
-    couponCode?: string | null;
-    /** Provided if checkout is initiated on buyer's behalf. */
-    onBehalf?: OnBehalf;
-    /** Submission ID of the form submitted with this order. */
-    submissionId?: string | null;
+    id: string;
 }
-export interface OnBehalf {
-    /** Member ID. */
-    memberId?: string;
-    /** Method by which checkout is initiated. */
-    orderMethod?: OrderMethod;
+export interface PauseOrderResponse {
 }
-export interface CreateOnlineOrderResponse {
-    /** Created online order. */
+export interface OrderPaused {
+    /** Paused order. */
     order?: Order;
 }
-export interface CouponsError {
-    /** Coupon code. */
-    couponCode?: string;
-    /** Plan ID. */
-    planId?: string;
-}
-export interface CreateGuestOnlineOrderRequest {
-    /** Plan ID. */
-    planId?: string;
+export interface BulkPauseOrderRequest {
     /**
-     * Start date for the ordered plan.
-     *
+     * List of Order IDs.
+     * @format GUID
+     * @minSize 1
+     * @maxSize 100
+     */
+    ids?: string[];
+    /** Set to true to return Order entity in response. */
+    returnFullEntity?: boolean;
+}
+export interface BulkPauseOrderResponse {
+    /** Orders that were paused. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface BulkOrderResult {
+    /** Item metadata */
+    itemMetadata?: ItemMetadata;
+    /** The order. */
+    order?: Order;
+}
+export 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;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export 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;
+}
+export interface ResumeOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+}
+export interface ResumeOrderResponse {
+}
+export interface OrderResumed {
+    /** Resumed order. */
+    order?: Order;
+}
+export 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;
+}
+export interface BulkResumeOrderResponse {
+    /** Orders that were resumed. */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+export interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+export interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+export declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+export 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?: Set;
+}
+export interface MemberGetOrderResponse {
+    /** Requested order. */
+    order?: Order;
+}
+export interface MemberListOrdersRequest {
+    /**
+     * Filter by plan IDs.
+     * @format GUID
+     */
+    planIds?: string[];
+    /** Filter for orders where auto renewal was canceled. */
+    autoRenewCanceled?: boolean | null;
+    /** Filter by order status. */
+    orderStatuses?: OrderStatus[];
+    /** Filter by payment status. */
+    paymentStatuses?: PaymentStatus[];
+    /**
+     * Limit the number of pricing plans returned. Default limit is 50.
+     * @min 1
+     * @max 50
+     */
+    limit?: number | null;
+    /** Number of entries to offset. */
+    offset?: number | null;
+    /** Sorting direction (defaults to ASC) and field to sort by. */
+    sorting?: Sorting;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: Set;
+}
+export interface MemberListOrdersResponse {
+    /** Requested orders. */
+    orders?: Order[];
+    /** Object containing paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+/**
+ * TODO: Write orders filter and sort docs page
+ * Retrieves a list of up to 1,000 orders, based on the provided paging, sorting, and filtering.
+ */
+export interface QueryOrdersRequest {
+    /** Query filter. */
+    query?: QueryV2;
+}
+export interface QueryOrdersResponse {
+    /** Order data. */
+    plans?: Order[];
+    /** Paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+export interface RequestCancellationRequest {
+    /**
+     * 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. */
+    effectiveAt: CancellationEffectiveAt;
+}
+export interface RequestCancellationResponse {
+}
+export 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.
+     * @format GUID
+     */
+    submissionId?: string | null;
+}
+export interface OnBehalf {
+    /**
+     * Member ID.
+     * @format GUID
+     */
+    memberId?: string;
+    /** Method by which checkout is initiated. */
+    orderMethod?: OrderMethod;
+}
+export interface CreateOnlineOrderResponse {
+    /** Created online order. */
+    order?: Order;
+}
+export interface CouponsError {
+    /** Coupon code. */
+    couponCode?: string;
+    /** Plan ID. */
+    planId?: string;
+}
+export interface CreateGuestOnlineOrderRequest {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    planId?: string;
+    /**
+     * Start date for the ordered plan.
+     *
      * Default: Current date
      */
     startDate?: Date | null;
-    /** Coupon code to apply. */
+    /**
+     * 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 */
+    /**
+     * Form submission id that was submitted together with the order
+     * @format GUID
+     */
     submissionId?: string | null;
 }
 export interface Captcha {
@@ -808,7 +1234,10 @@ export interface Captcha {
     token?: string;
 }
 export interface Guest {
-    /** Email for checkout */
+    /**
+     * Email for checkout
+     * @format EMAIL
+     */
     email?: string;
 }
 export interface CreateGuestOnlineOrderResponse {
@@ -816,9 +1245,15 @@ export interface CreateGuestOnlineOrderResponse {
     order?: Order;
 }
 export interface CreateOfflineOrderRequest {
-    /** ID of the plan being ordered, from the Plans API. */
+    /**
+     * ID of the plan being ordered, from the Plans API.
+     * @format GUID
+     */
     planId: string;
-    /** ID of the member ordering the plan, from the Members API. */
+    /**
+     * ID of the member ordering the plan, from the Members API.
+     * @format GUID
+     */
     memberId: string;
     /**
      * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
@@ -832,9 +1267,16 @@ export interface CreateOfflineOrderRequest {
      * Default: `false`
      */
     paid?: boolean | null;
-    /** Coupon code to apply, from the Coupons API. */
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
     couponCode?: string | null;
-    /** Form submission ID that was submitted with the order. */
+    /**
+     * Form submission ID that was submitted with the order.
+     * @format GUID
+     */
     submissionId?: string | null;
 }
 export interface CreateOfflineOrderResponse {
@@ -842,9 +1284,15 @@ export interface CreateOfflineOrderResponse {
     order?: Order;
 }
 export interface CreateExternalOrderRequest {
-    /** Plan ID. */
+    /**
+     * Plan ID.
+     * @format GUID
+     */
     planId?: string;
-    /** Form submission id that was submitted together with the order */
+    /**
+     * Form submission id that was submitted together with the order
+     * @format GUID
+     */
     submissionId?: string | null;
 }
 export interface CreateExternalOrderResponse {
@@ -852,7 +1300,10 @@ export interface CreateExternalOrderResponse {
     order?: Order;
 }
 export interface GetOnlineOrderPreviewRequest {
-    /** Plan ID. */
+    /**
+     * Plan ID.
+     * @format GUID
+     */
     planId: string;
     /**
      * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
@@ -860,7 +1311,11 @@ export interface GetOnlineOrderPreviewRequest {
      * Default: Current date and time.
      */
     startDate?: Date | null;
-    /** Coupon code to apply. */
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
     couponCode?: string | null;
 }
 export interface GetOnlineOrderPreviewResponse {
@@ -870,7 +1325,10 @@ export interface GetOnlineOrderPreviewResponse {
     purchaseLimitExceeded?: boolean;
 }
 export interface GetGuestOnlineOrderPreviewRequest {
-    /** Plan ID. */
+    /**
+     * Plan ID.
+     * @format GUID
+     */
     planId?: string;
     /**
      * Start date for the ordered plan.
@@ -878,9 +1336,16 @@ export interface GetGuestOnlineOrderPreviewRequest {
      * Default: Current date
      */
     startDate?: Date | null;
-    /** Coupon code to apply. */
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
     couponCode?: string | null;
-    /** Email for checkout */
+    /**
+     * Email for checkout
+     * @format EMAIL
+     */
     email?: string;
 }
 export interface GetGuestOnlineOrderPreviewResponse {
@@ -893,9 +1358,15 @@ export interface GetGuestOnlineOrderPreviewResponse {
     purchaseLimitExceeded?: boolean;
 }
 export interface GetOfflineOrderPreviewRequest {
-    /** ID of the plan of the previewed order, from the Plans API. */
+    /**
+     * ID of the plan of the previewed order, from the Plans API.
+     * @format GUID
+     */
     planId: string;
-    /** Member ID of the buyer the previewed order is for, from the Members API. */
+    /**
+     * 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.
@@ -903,7 +1374,11 @@ export interface GetOfflineOrderPreviewRequest {
      * Default: Current date and time.
      */
     startDate?: Date | null;
-    /** Coupon code to apply, from the Coupons API. */
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
     couponCode?: string | null;
 }
 export interface GetOfflineOrderPreviewResponse {
@@ -918,9 +1393,16 @@ export interface GetOfflineOrderPreviewResponse {
     purchaseLimitExceeded?: boolean;
 }
 export interface GetPricePreviewRequest {
-    /** ID of plan to preview. */
+    /**
+     * ID of plan to preview.
+     * @format GUID
+     */
     planId: string;
-    /** Coupon code to apply, from the Coupons API. */
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
     couponCode?: string | null;
 }
 export interface GetPricePreviewResponse {
@@ -935,7 +1417,10 @@ export interface GetPricePreviewResponse {
     prices?: SpannedPrice[];
 }
 export interface ChangeStartDateRequest {
-    /** Draft order ID. */
+    /**
+     * Draft order ID.
+     * @format GUID
+     */
     orderId?: string;
     /** New valid from date (timestamp). */
     startDate?: Date | null;
@@ -949,9 +1434,16 @@ export interface OrderStartDateChanged {
     order?: Order;
 }
 export interface ApplyCouponRequest {
-    /** Draft order ID. */
+    /**
+     * Draft order ID.
+     * @format GUID
+     */
     orderId?: string;
-    /** Coupon code to apply. */
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
     couponCode?: string;
 }
 export interface ApplyCouponResponse {
@@ -959,255 +1451,21 @@ export interface ApplyCouponResponse {
     order?: Order;
 }
 export interface SetSubmissionRequest {
-    /** Order ID. */
-    orderId?: string;
-    /** Submission ID. */
-    submissionId?: string;
-}
-export interface SetSubmissionResponse {
-    /** Order with submission id */
-    order?: Order;
-}
-export interface OrderPurchased {
-    /** Order that was paid for. If a free or an offline order, the order that was created. */
-    order?: Order;
-}
-export 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.
- */
-export 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 */
-export interface OrderAutoRenewCanceled {
-    /** Order that is canceled, effective at the end of the current payment cycle. */
-    order?: Order;
-}
-export interface OrderEnded {
-    /** Order that ended. */
-    order?: Order;
-}
-export interface GetOrderRequest {
-    /** Order ID. */
-    id: string;
-    /**
-     * Predefined set of fields to return.
-     *
-     * Default: If `fieldSet` is omitted, no order form submission data is returned.
-     */
-    fieldSet?: Set;
-}
-export interface GetOrderResponse {
-    /** Order. */
-    order?: Order;
-}
-export interface ListOrdersRequest {
-    /** Filter by a buyer's member ID, from the Members API. */
-    buyerIds?: string[];
-    /** Filter by plan IDs, from the Plans API. */
-    planIds?: string[];
-    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
-    autoRenewCanceled?: boolean | null;
-    /** Filter by order status. */
-    orderStatuses?: OrderStatus[];
-    /** Filter by payment status. */
-    paymentStatuses?: PaymentStatus[];
-    /**
-     * Number of orders to return. See Sorting and Paging for more information.
-     *
-     * 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.
+     * Order ID.
+     * @format GUID
      */
-    fieldSet?: Set;
-}
-export interface ListOrdersResponse {
-    /** List of orders. */
-    orders?: Order[];
-    /** Object containing paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface OrdersQueryOrdersRequest {
-    /** Query filter. */
-    query?: QueryV2;
-}
-export interface OrdersQueryOrdersResponse {
-    /** Retrieved orders. */
-    plans?: Order[];
-    /** Paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface GetOrdersStatsRequest {
-}
-export interface GetOrdersStatsResponse {
-    /** Total number of orders. */
-    totalOrderCount?: number;
-    /** Number of active orders. */
-    activeOrderCount?: number;
-}
-export interface GetAvailableOrderActionsRequest {
-    /** Order ID. */
-    id?: string;
-}
-export interface GetAvailableOrderActionsResponse {
-    /** Whether the order can be suspended. */
-    suspendable?: boolean;
-    /** If the order cannot be suspended, a reason is returned here. */
-    notSuspendableReason?: ReasonNotSuspendable;
-    /** Whether the order can be canceled by the buyer. */
-    cancelableByBuyer?: boolean;
-}
-export 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"
-}
-export interface PostponeEndDateRequest {
-    /** Order ID. */
-    id: string;
+    orderId?: string;
     /**
-     * New end date and time.
-     *
-     * Must be later than the current end date and time.
+     * Submission ID.
+     * @format GUID
      */
-    endDate: Date | null;
-}
-export interface PostponeEndDateResponse {
-}
-export interface OrderEndDatePostponed {
-    /** Order whose `endDate` was postponed. */
-    order?: Order;
-}
-export interface CancelOrderRequest {
-    /** Order ID. */
-    id: string;
-    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
-    effectiveAt: CancellationEffectiveAt;
-}
-export interface CancelOrderResponse {
-}
-export interface MarkAsPaidRequest {
-    /** Order ID. */
-    id: string;
-}
-export interface MarkAsPaidResponse {
-}
-export interface OrderMarkedAsPaid {
-    /** Order that was marked as paid. */
-    order?: Order;
-}
-export interface PauseOrderRequest {
-    /** Order ID. */
-    id: string;
-}
-export interface PauseOrderResponse {
-}
-export interface OrderPaused {
-    /** Paused order. */
-    order?: Order;
-}
-export interface BulkPauseOrderRequest {
-    /** List of Order IDs. */
-    ids?: string[];
-    /** Set to true to return Order entity in response. */
-    returnFullEntity?: boolean;
-}
-export interface BulkPauseOrderResponse {
-    /** Orders that were paused. */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkOrderResult {
-    /** Item metadata */
-    itemMetadata?: ItemMetadata;
-    /** The order. */
-    order?: Order;
-}
-export 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;
-}
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-export 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;
-}
-export interface ResumeOrderRequest {
-    /** Order ID. */
-    id: string;
-}
-export interface ResumeOrderResponse {
+    submissionId?: string;
 }
-export interface OrderResumed {
-    /** Resumed order. */
+export interface SetSubmissionResponse {
+    /** Order with submission id */
     order?: Order;
 }
-export interface BulkResumeOrderRequest {
-    /** List of Order IDs. */
-    ids?: string[];
-    /** Set to true to return Order entity in response. */
-    returnFullEntity?: boolean;
-}
-export interface BulkResumeOrderResponse {
-    /** Orders that were resumed. */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
 interface BuyerNonNullableFields {
     memberId: string;
     contactId: string;
@@ -1301,6 +1559,12 @@ interface OrderNonNullableFields {
     statusNew: OrderStatus;
     onEcom: boolean;
 }
+export interface GetOrderResponseNonNullableFields {
+    order?: OrderNonNullableFields;
+}
+export interface ListOrdersResponseNonNullableFields {
+    orders: OrderNonNullableFields[];
+}
 export interface MemberGetOrderResponseNonNullableFields {
     order?: OrderNonNullableFields;
 }
@@ -1325,10 +1589,4 @@ export interface GetPricePreviewResponseNonNullableFields {
     price?: PriceDetailsNonNullableFields;
     prices: SpannedPriceNonNullableFields[];
 }
-export interface GetOrderResponseNonNullableFields {
-    order?: OrderNonNullableFields;
-}
-export interface ListOrdersResponseNonNullableFields {
-    orders: OrderNonNullableFields[];
-}
 export {};