@wix/pricing-plans 1.0.70 → 1.0.72

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,2350 @@
+/**
+ * An order object includes all of the details related to the purchase of a Pricing Plan.
+ * You can manage existing orders, create offline orders, and preview orders not yet purchased.
+ *
+ * Orders are based on pricing models based on the payment and duration cycles for each plan. See here to
+ * [learn more about pricing models](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models).
+ */
+interface Order {
+    /**
+     * Order ID.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * ID of the plan purchased with the order.
+     * @readonly
+     */
+    planId?: string;
+    /**
+     * ID of the related Wix subscription.
+     *
+     * Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. See a [Pricing Plans overview](https://support.wix.com/en/article/pricing-plans-an-overview#create-plans-to-suit-your-business).
+     * @readonly
+     */
+    subscriptionId?: string;
+    /**
+     * Wix Pay order ID.
+     *
+     * Provided by Wix whether the order is created online or offline. The field is omitted when the order is free.
+     * @readonly
+     */
+    wixPayOrderId?: string | null;
+    /**
+     * The buyer's IDs. Includes `memberId` and `contactId`.
+     *
+     * Currently, Pricing Plan purchases are limited to members only. `contactId` is returned,
+     * but a buyer will not be able to purchase a plan without a `memberId`.
+     * @readonly
+     */
+    buyer?: Buyer;
+    /**
+     * @internal
+     * @internal
+     * @readonly
+     * @deprecated __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
+     * @replacedBy pricing
+     * @removalDate 2022-10-01
+     */
+    priceDetails?: PriceDetails;
+    /**
+     * Pricing model, price, and payment schedule for the order.
+     * @readonly
+     */
+    pricing?: PricingDetails;
+    /**
+     * How the order was processed. Supported values:
+     * + `"ONLINE"`: The buyer purchased the plan using the site.
+     * + `"OFFLINE"`: The buyer made a manual, offline purchase without using the site.
+     * @readonly
+     */
+    type?: OrderType;
+    /**
+     * Status of the order. Supported values:
+     * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.
+     * + `PENDING`: Order has been purchased and its start date is set in the future.
+     * + `ACTIVE`: Order has been processed. The plan is available for use.
+     * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).
+     * + `ENDED`: Order has completed its duration and is no longer available for use.
+     * + `CANCELED`: Order has been [canceled](#cancelorder).
+     * @readonly
+     */
+    status?: OrderStatus;
+    /**
+     * Whether the order will be canceled at the next payment date.
+     *
+     * If `true`, the order status will be `CANCELED` and the next payment won't be charged. Omitted for single payment orders.
+     * @readonly
+     */
+    autoRenewCanceled?: boolean | null;
+    /**
+     * Details about the cancellation of an order.
+     *
+     *
+     * @readonly
+     */
+    cancellation?: Cancellation;
+    /**
+     * Status of the last payment for the order.
+     * Updated automatically for online orders. Updated manually by the site owner for offline orders.
+     *
+     * Supported values:
+     * + `PAID`: The last payment was paid.
+     * + `REFUNDED`: The last payment was refunded.
+     * + `FAILED`: The last payment transaction didn't complete.
+     * + `UNPAID`: The last payment wasn't paid.
+     * + `PENDING`: Awaiting payment.
+     * + `NOT_APPLICABLE`: No payment was necessary. For example, for free plans or free trials.
+     * @readonly
+     */
+    lastPaymentStatus?: PaymentStatus;
+    /**
+     * Start date and time for the ordered plan.
+     * @readonly
+     */
+    startDate?: Date;
+    /**
+     * Current end date and time for the ordered plan.
+     *
+     * `endDate` may be updated over the course of an order. If the order is [paused](#pauseorder),
+     * it will have a later `endDate` once it [resumes](#resumeorder). `endDate` may also be [postponed](#postponeenddate).
+     *
+     * Omitted if the order is valid until canceled and still `ACTIVE`.
+     * @readonly
+     */
+    endDate?: Date;
+    /**
+     * List of periods during which the order is paused.
+     * @readonly
+     */
+    pausePeriods?: PausePeriod[];
+    /**
+     * Free trial period for the order, in days.
+     *
+     * Only available for recurring plans.
+     * @readonly
+     */
+    freeTrialDays?: number | null;
+    /**
+     * Earliest end date and time that the plan for the order can expire.
+     *
+     * Calculated by using the original end date plus any pause periods. Omitted if the order is active until canceled. Reserved for future use.
+     * @readonly
+     */
+    earliestEndDate?: Date;
+    /**
+     * Current payment cycle for the order.
+     *
+     * `currentCycle` will be omitted if the order's status is `CANCELED` or `ENDED`, or if the `startDate` hasn't passed yet.
+     * @readonly
+     */
+    currentCycle?: CurrentCycle;
+    /**
+     * Plan name at the time of purchase.
+     * @readonly
+     */
+    planName?: string;
+    /**
+     * Plan description at the time of purchase
+     * @readonly
+     */
+    planDescription?: string;
+    /**
+     * Plan price as it was at the moment of order creation.
+     * @readonly
+     */
+    planPrice?: string;
+    /**
+     * Date and time the order was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the order was updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Information about the form submitted during the plan's checkout.
+     * @readonly
+     */
+    formData?: FormData;
+}
+interface Buyer {
+    /**
+     * Member ID for a buyer.
+     * @readonly
+     */
+    memberId?: string;
+    /**
+     * Contact ID for a buyer.
+     * @readonly
+     */
+    contactId?: string;
+}
+interface PriceDetails extends PriceDetailsPricingModelOneOf {
+    /** Order has recurring payments. */
+    subscription?: Recurrence$1;
+    /** One-time payment. Order is valid for a specified duration. */
+    singlePaymentForDuration?: Duration$1;
+    /** 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"`. */
+    subtotal?: string;
+    /** Total discount applied. */
+    discount?: string;
+    /** Tax applied. */
+    tax?: Tax;
+    /**
+     * 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`.
+     */
+    total?: string;
+    /** Plan price as it was at the moment of order creation. */
+    planPrice?: string;
+    /** Currency code. Must be valid ISO 4217 currency code (e.g., USD). */
+    currency?: string;
+    /** Free trial period for the order in days. Only available for recurring plans. */
+    freeTrialDays?: number | null;
+    /** Coupon applied to the order. Empty means no coupon was applied. */
+    coupon?: Coupon;
+}
+/** @oneof */
+interface PriceDetailsPricingModelOneOf {
+    /** Order has recurring payments. */
+    subscription?: Recurrence$1;
+    /** One-time payment. Order is valid for a specified duration. */
+    singlePaymentForDuration?: Duration$1;
+    /** One-time payment. Order is valid until it is canceled. */
+    singlePaymentUnlimited?: boolean | null;
+}
+interface Tax {
+    /** Name of the tax. For example, VAT. */
+    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"`. */
+    rate?: string;
+    /** Total tax, specified as a monetary amount. For example, `"3.99"`. */
+    amount?: string;
+}
+/** An object specifying how often and for how long payments recur (may be forever). */
+interface Recurrence$1 {
+    /** Length of one payment cycle. */
+    cycleDuration?: Duration$1;
+    /**
+     * Amount of payment cycles this subscription is valid for.
+     *
+     * `0` for unlimited or until-canceled.
+     */
+    cycleCount?: number | null;
+}
+/** A duration expressed in number of time units. */
+interface Duration$1 {
+    /**
+     * The amount of a duration `unit` in a single payment cycle.
+     *
+     * Currently limited to support only `1`.
+     */
+    count?: number | null;
+    /** Unit of time for the cycle duration. */
+    unit?: PeriodUnit$1;
+}
+declare enum PeriodUnit$1 {
+    UNDEFINED = "UNDEFINED",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+interface Coupon {
+    /** Code of the applied coupon. */
+    code?: string;
+    /** Total discount of the coupon, as a monetary amount. */
+    amount?: string;
+    /**
+     * Coupon ID.
+     * @readonly
+     */
+    _id?: string;
+}
+interface PricingDetails extends PricingDetailsPricingModelOneOf {
+    /** Pricing model for an order with recurring payment cycles. */
+    subscription?: Recurrence$1;
+    /** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */
+    singlePaymentForDuration?: Duration$1;
+    /** Pricing model for an order with a one-time payment and the order is valid until canceled. */
+    singlePaymentUnlimited?: boolean | null;
+    /**
+     * Pricing details for all pricing models.
+     * @readonly
+     */
+    prices?: SpannedPrice[];
+}
+/** @oneof */
+interface PricingDetailsPricingModelOneOf {
+    /** Pricing model for an order with recurring payment cycles. */
+    subscription?: Recurrence$1;
+    /** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */
+    singlePaymentForDuration?: Duration$1;
+    /** Pricing model for an order with a one-time payment and the order is valid until canceled. */
+    singlePaymentUnlimited?: boolean | null;
+}
+interface SpannedPrice {
+    /**
+     * Cycle duration to apply `price` for.
+     *
+     * Use with all pricing models.
+     * Can apply the same price to multiple payment cycles.
+     */
+    duration?: PriceDuration;
+    /** Order price. */
+    price?: Price;
+}
+interface PriceDuration {
+    /**
+     * Price starts to apply with this cycle.
+     *
+     * `1` is the first payment cycle for all pricing models.
+     */
+    cycleFrom?: number;
+    /**
+     * Amount of cycles to apply price for.
+     *
+     * For `subscription` pricing models with a finite number of cycles, the `numberOfCycles` is the same as `pricing.subscription.cycleCount`.
+     *
+     * For `subscription` pricing models that are unlimited or until-canceled, the `numberOfCycles` is not returned.
+     *
+     * For `singlePaymentForDuration` and `singlePaymentUnlimited` pricing models, the `numberOfCycles` is `1`.
+     */
+    numberOfCycles?: number | null;
+}
+interface Price {
+    /** Price of the order excluding tax, specified as a monetary amount. For example, `"9.99"`. */
+    subtotal?: string;
+    /** Coupon applied to the order. */
+    coupon?: Coupon;
+    /** Total discount applied to the order. */
+    discount?: string;
+    /**
+     * Tax applied to the order.
+     *
+     * Tax is only applied if the site [has it configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection).
+     */
+    tax?: Tax;
+    /**
+     * 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`.
+     */
+    total?: string;
+    /**
+     * Three-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     */
+    currency?: string;
+    /** Price change after billing date was change and price was adjusted. Could be positive and negative values. */
+    proration?: string;
+}
+declare enum OrderType {
+    UNDEFINED = "UNDEFINED",
+    /** Payments made by the buyer */
+    ONLINE = "ONLINE",
+    /** Payments managed manually by the site owner */
+    OFFLINE = "OFFLINE",
+    /** Payments managed externally */
+    EXTERNAL = "EXTERNAL"
+}
+declare enum OrderStatus {
+    /** Order status undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Order created, but hasn't been paid for yet. Filtered out in ListOrders response by default. */
+    DRAFT = "DRAFT",
+    /** Order has been paid for, but the start date is in the future */
+    PENDING = "PENDING",
+    /** Order is active */
+    ACTIVE = "ACTIVE",
+    /** Order is paused until site owner resumes it */
+    PAUSED = "PAUSED",
+    /** Order has ended */
+    ENDED = "ENDED",
+    /** Order has been canceled */
+    CANCELED = "CANCELED"
+}
+interface Cancellation {
+    /** Date and time the cancellation was requested. */
+    requestedDate?: Date;
+    /**
+     * Reason for the cancellation. One of:
+     * + `OWNER_ACTION`: Site owner canceled the order.
+     * + `MEMBER_ACTION`: Buyer initiated the cancellation.
+     * + `PAYMENT_FAILURE`: Payment transaction failed.
+     * + `PAYMENT_SETUP_FAILURE`: Buyer's payment details weren't set up correctly.
+     * + `UNKNOWN`: Reason for the cancellation is unknown.
+     */
+    cause?: CancellationCause;
+    /**
+     * When the cancellation takes effect. Set when cancelling the order. One of:
+     * + `IMMEDIATELY`: Cancellation occurs immediately and the buyer can no longer use the plan.
+     * + `NEXT_PAYMENT_DATE`: Cancellation occurs at the next payment date and time. Buyer can continue to use the plan until that date and time.
+     */
+    effectiveAt?: CancellationEffectiveAt;
+}
+declare enum CancellationCause {
+    /** Cancellation initiator undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Order was canceled by site owner (default if canceled by user or service identity) */
+    OWNER_ACTION = "OWNER_ACTION",
+    /** Order was canceled by member (default if canceled by member identity) */
+    MEMBER_ACTION = "MEMBER_ACTION",
+    /** Order was canceled because of payment failure */
+    PAYMENT_FAILURE = "PAYMENT_FAILURE",
+    /** Order was canceled because of payment setup failure */
+    PAYMENT_SETUP_FAILURE = "PAYMENT_SETUP_FAILURE",
+    /** Order was cancelled because of an unknown reason. It's not possible to know with certain payment providers (e.g. paypal) */
+    UNKNOWN = "UNKNOWN"
+}
+declare enum CancellationEffectiveAt {
+    /** Cancellation time undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Will cancel the order now, i.e. update validUntil to the current date */
+    IMMEDIATELY = "IMMEDIATELY",
+    /** Will cancel the order at the date when next payment should have been made */
+    NEXT_PAYMENT_DATE = "NEXT_PAYMENT_DATE"
+}
+declare enum PaymentStatus {
+    /** Payment status undefined */
+    UNDEFINED = "UNDEFINED",
+    /** Payment has been paid */
+    PAID = "PAID",
+    /** Payment has been refunded */
+    REFUNDED = "REFUNDED",
+    /** Recurring payment has failed */
+    FAILED = "FAILED",
+    /** Payment has not been paid */
+    UNPAID = "UNPAID",
+    /** Billing has been initialized, but actual charge is yet to be made. Can happen for free trial and PayPal */
+    PENDING = "PENDING",
+    /** Used in cases where the plan is free */
+    NOT_APPLICABLE = "NOT_APPLICABLE"
+}
+interface PausePeriod {
+    /**
+     * Status of the pause period. Supported values:
+     * + `ACTIVE`: Status while the order is [paused](#pauseorder).
+     * + `ENDED`: Status when the order is [resumed](#resumeorder).
+     */
+    status?: Status;
+    /** Start date and time of the pause period. */
+    pauseDate?: Date;
+    /**
+     * End date and time of the pause period.
+     *
+     * Omitted while the pause period remains `ACTIVE`.
+     */
+    resumeDate?: Date;
+}
+declare enum Status {
+    UNDEFINED = "UNDEFINED",
+    /** Order suspension is active */
+    ACTIVE = "ACTIVE",
+    /** Order suspension has ended */
+    ENDED = "ENDED"
+}
+/**
+ * Current cycle will be empty when order is cancelled, expired or order start date is in the future
+ * Current cycle start and end dates take into account free trial days and suspensions
+ */
+interface CurrentCycle {
+    /**
+     * Index of the current payment cycle in the order.
+     *
+     * `0` when order is in a free trial period. In all other cases, the index starts with `1`.
+     */
+    index?: number;
+    /** Start date and time for the current payment cycle. */
+    startedDate?: Date;
+    /** End date and time for the current payment cycle. */
+    endedDate?: Date;
+}
+interface FormData {
+    /** ID of the form associated with the plan at checkout. */
+    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. */
+    submissionId?: string | null;
+    /**
+     * Data submitted to the plan's order form at checkout.
+     *
+     * This field is returned when a method's `fieldset` is set to `"FULL"`.
+     *
+     * @readonly
+     */
+    submissionData?: Record<string, any>;
+}
+declare enum Set {
+    /** Same behavior as BASIC */
+    UNKNOWN_SET = "UNKNOWN_SET",
+    /**
+     * Returns fields of the entity that are available in the database.
+     * By default a field is available in the database unless explicitly specified in the documentation
+     */
+    BASIC = "BASIC",
+    /**
+     * Returns all fields in the entity.
+     * This might make additional calls to gather the full entity
+     */
+    FULL = "FULL"
+}
+interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+interface MemberListOrdersResponse {
+    /** List of orders. */
+    orders?: Order[];
+    /** Object containing paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2$1;
+}
+interface PagingMetadataV2$1 {
+    /** 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$1;
+}
+interface Cursors$1 {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: 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. */
+    order?: Order;
+}
+interface IdentificationData$1 extends IdentificationDataIdOneOf$1 {
+    /** 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$1;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf$1 {
+    /** 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;
+}
+declare enum WebhookIdentityType$1 {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface CreateOfflineOrderResponse {
+    /** Order. */
+    order?: 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 GetPricePreviewResponse {
+    /**
+     * @internal
+     * @internal
+     * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
+     * @replacedBy prices
+     * @removalDate 2022-10-01
+     */
+    price?: PriceDetails;
+    /** Pricing details. */
+    prices?: SpannedPrice[];
+}
+interface OrderStartDateChanged {
+    /** Order whose `startDate` changed. */
+    order?: Order;
+}
+interface OrderPurchased {
+    /** Order that was paid for. If a free or an offline order, the order that was created. */
+    order?: Order;
+}
+interface OrderStarted {
+    /** Order that reached its `startDate`. */
+    order?: Order;
+}
+/**
+ * Triggered at the start of a new payment cycle for an existing order.
+ *
+ * This webhook does not trigger at the initial start of an offline order.
+ */
+interface OrderCycleStarted {
+    /** Order whose new cycle started. */
+    order?: Order;
+    /** Number of the payment cycle will be 0 when the order is in the free trial period. In other cases, the cycle number starts from 1. */
+    cycleNumber?: number;
+}
+/** Emitted when a recurring order is canceled for the next payment cycle */
+interface OrderAutoRenewCanceled {
+    /** Order that is canceled, effective at the end of the current payment cycle. */
+    order?: Order;
+}
+interface OrderEnded {
+    /** Order that ended. */
+    order?: Order;
+}
+interface GetOrderResponse {
+    /** Order. */
+    order?: Order;
+}
+interface ListOrdersResponse {
+    /** List of orders. */
+    orders?: Order[];
+    /** Object containing paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2$1;
+}
+interface OrderEndDatePostponed {
+    /** Order whose `endDate` was postponed. */
+    order?: Order;
+}
+interface OrderMarkedAsPaid {
+    /** Order that was marked as paid. */
+    order?: Order;
+}
+interface OrderPaused {
+    /** Paused order. */
+    order?: Order;
+}
+interface OrderResumed {
+    /** Resumed order. */
+    order?: Order;
+}
+interface MemberListOrdersResponseNonNullableFields {
+    orders: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    }[];
+}
+interface CreateOfflineOrderResponseNonNullableFields {
+    order?: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    };
+}
+interface GetOfflineOrderPreviewResponseNonNullableFields {
+    order?: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    };
+    purchaseLimitExceeded: boolean;
+}
+interface GetPricePreviewResponseNonNullableFields {
+    price?: {
+        subscription?: {
+            cycleDuration?: {
+                unit: PeriodUnit$1;
+            };
+        };
+        singlePaymentForDuration?: {
+            unit: PeriodUnit$1;
+        };
+        subtotal: string;
+        discount: string;
+        tax?: {
+            name: string;
+            includedInPrice: boolean;
+            rate: string;
+            amount: string;
+        };
+        total: string;
+        planPrice: string;
+        currency: string;
+        coupon?: {
+            code: string;
+            amount: string;
+            _id: string;
+        };
+    };
+    prices: {
+        duration?: {
+            cycleFrom: number;
+        };
+        price?: {
+            subtotal: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            currency: string;
+            proration: string;
+        };
+    }[];
+}
+interface GetOrderResponseNonNullableFields {
+    order?: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    };
+}
+interface ListOrdersResponseNonNullableFields {
+    orders: {
+        _id: string;
+        planId: string;
+        subscriptionId: string;
+        buyer?: {
+            memberId: string;
+            contactId: string;
+        };
+        priceDetails?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            subtotal: string;
+            discount: string;
+            tax?: {
+                name: string;
+                includedInPrice: boolean;
+                rate: string;
+                amount: string;
+            };
+            total: string;
+            planPrice: string;
+            currency: string;
+            coupon?: {
+                code: string;
+                amount: string;
+                _id: string;
+            };
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit$1;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit$1;
+            };
+            prices: {
+                duration?: {
+                    cycleFrom: number;
+                };
+                price?: {
+                    subtotal: string;
+                    coupon?: {
+                        code: string;
+                        amount: string;
+                        _id: string;
+                    };
+                    discount: string;
+                    tax?: {
+                        name: string;
+                        includedInPrice: boolean;
+                        rate: string;
+                        amount: string;
+                    };
+                    total: string;
+                    currency: string;
+                    proration: string;
+                };
+            }[];
+        };
+        type: OrderType;
+        status: OrderStatus;
+        cancellation?: {
+            cause: CancellationCause;
+            effectiveAt: CancellationEffectiveAt;
+        };
+        lastPaymentStatus: PaymentStatus;
+        pausePeriods: {
+            status: Status;
+        }[];
+        currentCycle?: {
+            index: number;
+        };
+        planName: string;
+        planDescription: string;
+        planPrice: string;
+    }[];
+}
+interface BaseEventMetadata$1 {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData$1;
+}
+interface EventMetadata$1 extends BaseEventMetadata$1 {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface OrderCanceledEnvelope {
+    data: OrderCanceled;
+    metadata: EventMetadata$1;
+}
+interface OrderCreatedEnvelope {
+    entity: Order;
+    metadata: EventMetadata$1;
+}
+interface OrderUpdatedEnvelope {
+    entity: Order;
+    metadata: EventMetadata$1;
+}
+interface OrderStartDateChangedEnvelope {
+    data: OrderStartDateChanged;
+    metadata: EventMetadata$1;
+}
+interface OrderPurchasedEnvelope {
+    data: OrderPurchased;
+    metadata: EventMetadata$1;
+}
+interface OrderStartedEnvelope {
+    data: OrderStarted;
+    metadata: EventMetadata$1;
+}
+interface OrderCycleStartedEnvelope {
+    data: OrderCycleStarted;
+    metadata: EventMetadata$1;
+}
+interface OrderAutoRenewCanceledEnvelope {
+    data: OrderAutoRenewCanceled;
+    metadata: EventMetadata$1;
+}
+interface OrderEndedEnvelope {
+    data: OrderEnded;
+    metadata: EventMetadata$1;
+}
+interface OrderEndDatePostponedEnvelope {
+    data: OrderEndDatePostponed;
+    metadata: EventMetadata$1;
+}
+interface OrderMarkedAsPaidEnvelope {
+    data: OrderMarkedAsPaid;
+    metadata: EventMetadata$1;
+}
+interface OrderPausedEnvelope {
+    data: OrderPaused;
+    metadata: EventMetadata$1;
+}
+interface OrderResumedEnvelope {
+    data: OrderResumed;
+    metadata: EventMetadata$1;
+}
+interface MemberGetOrderOptions {
+    fieldSet?: Set;
+}
+interface MemberListOrdersOptions {
+    /** Filter by plan IDs. */
+    planIds?: string[];
+    /** Filter for orders where auto renewal was canceled. */
+    autoRenewCanceled?: boolean | null;
+    /**
+     * Filter by the order status. Supported values:
+     * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.
+     * + `PENDING`: Order has been purchased and its start date is set in the future.
+     * + `ACTIVE`: Order has been processed. The plan is available for use.
+     * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).
+     * + `ENDED`: Order has completed its duration and is no longer available for use.
+     * + `CANCELED`: Order has been [canceled](#cancelorder).
+     */
+    orderStatuses?: OrderStatus[];
+    /**
+     * Key Path to edit
+     * ManagementListOrdersOptions.paymentStatuses
+     * Production value
+     * Filter by payment status.
+     * Override
+     * Filter by payment status.
+     *
+     * Supported values:
+     * + `PAID`: The last payment was paid.
+     * + `REFUNDED`: The last payment was refunded.
+     * + `FAILED`: The last payment transaction didn't complete.
+     * + `UNPAID`: The last payment wasn't paid.
+     * + `PENDING`: Awaiting payment.
+     * + `NOT_APPLICABLE`: No payment was necessary. For example, for free plans or free trials.
+     * Mark down view
+     * Filter by payment status.
+     *
+     * Supported values:
+     *
+     * PAID: The last payment was paid.
+     * REFUNDED: The last payment was refunded.
+     * FAILED: The last payment transaction didn't complete.
+     * UNPAID: The last payment wasn't paid.
+     * PENDING: Awaiting payment.
+     * NOT_APPLICABLE: No payment was necessary. For example, for free plans or free trials.
+     */
+    paymentStatuses?: PaymentStatus[];
+    /**
+     * Number of pricing plan orders to return.
+     *
+     * Default: `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: `ASC`
+     */
+    sorting?: Sorting;
+    fieldSet?: Set;
+}
+interface CreateOfflineOrderOptions {
+    /**
+     * Start date and time for the ordered plan.
+     *
+     * Default: Current date and time
+     */
+    startDate?: Date;
+    /**
+     * Whether the order is paid.
+     *
+     * Default: `false`
+     */
+    paid?: boolean | null;
+    /** Coupon code to apply. */
+    couponCode?: string | null;
+    /** Form submission ID that was submitted together with the order. */
+    submissionId?: string | null;
+}
+interface GetOfflineOrderPreviewOptions {
+    /**
+     * Start date and time for plan of the previewed order.
+     *
+     * Default: Current date and time
+     */
+    startDate?: Date;
+    /** Coupon code to apply. */
+    couponCode?: string | null;
+}
+interface GetPricePreviewOptions {
+    /** Coupon code to apply.  */
+    couponCode?: string | null;
+}
+interface ManagementGetOrderOptions {
+    fieldSet?: Set;
+}
+interface ManagementListOrdersOptions {
+    /** Filter by specific member IDs of buyers who ordered a pricing plan. */
+    buyerIds?: string[];
+    /** Filter by specific IDs of plans that were ordered.  */
+    planIds?: string[];
+    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
+    autoRenewCanceled?: boolean | null;
+    /**
+     * Filter by the order status. Supported values:
+     * + `DRAFT`: Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer.
+     * + `PENDING`: Order has been purchased and its start date is set in the future.
+     * + `ACTIVE`: Order has been processed. The plan is available for use.
+     * + `PAUSED`: Order, and use of the plan, is [paused](#pauseorder). The order, and use of the plan, can be [resumed](#resumeorder).
+     * + `ENDED`: Order has completed its duration and is no longer available for use.
+     * + `CANCELED`: Order has been [canceled](#cancelorder).
+     */
+    orderStatuses?: OrderStatus[];
+    /**
+     * Filter by payment status.
+     *
+     * Supported values:
+     * + `PAID`: The last payment was paid.
+     * + `REFUNDED`: The last payment was refunded.
+     * + `FAILED`: The last payment transaction didn't complete.
+     * + `UNPAID`: The last payment wasn't paid.
+     * + `PENDING`: Awaiting payment.
+     * + `NOT_APPLICABLE`: No payment was necessary. For example, for free plans or free trials.
+     */
+    paymentStatuses?: PaymentStatus[];
+    /**
+     * Number of pricing plan orders to return.
+     *
+     * Default: `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;
+    /** Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL */
+    fieldSet?: Set;
+}
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+declare function memberGetOrder$1(httpClient: HttpClient): (_id: string, options?: MemberGetOrderOptions) => Promise<Order & {
+    _id: string;
+    planId: string;
+    subscriptionId: string;
+    buyer?: {
+        memberId: string;
+        contactId: string;
+    } | undefined;
+    priceDetails?: {
+        subscription?: {
+            cycleDuration?: {
+                unit: PeriodUnit$1;
+            } | undefined;
+        } | undefined;
+        singlePaymentForDuration?: {
+            unit: PeriodUnit$1;
+        } | undefined;
+        subtotal: string;
+        discount: string;
+        tax?: {
+            name: string;
+            includedInPrice: boolean;
+            rate: string;
+            amount: string;
+        } | undefined;
+        total: string;
+        planPrice: string;
+        currency: string;
+        coupon?: {
+            code: string;
+            amount: string;
+            _id: string;
+        } | undefined;
+    } | undefined;
+    pricing?: {
+        subscription?: {
+            cycleDuration?: {
+                unit: PeriodUnit$1;
+            } | undefined;
+        } | undefined;
+        singlePaymentForDuration?: {
+            unit: PeriodUnit$1;
+        } | undefined;
+        prices: {
+            duration?: {
+                cycleFrom: number;
+            } | undefined;
+            price?: {
+                subtotal: string;
+                coupon?: {
+                    code: string;
+                    amount: string;
+                    _id: string;
+                } | undefined;
+                discount: string;
+                tax?: {
+                    name: string;
+                    includedInPrice: boolean;
+                    rate: string;
+                    amount: string;
+                } | undefined;
+                total: string;
+                currency: string;
+                proration: string;
+            } | undefined;
+        }[];
+    } | undefined;
+    type: OrderType;
+    status: OrderStatus;
+    cancellation?: {
+        cause: CancellationCause;
+        effectiveAt: CancellationEffectiveAt;
+    } | undefined;
+    lastPaymentStatus: PaymentStatus;
+    pausePeriods: {
+        status: Status;
+    }[];
+    currentCycle?: {
+        index: number;
+    } | undefined;
+    planName: string;
+    planDescription: string;
+    planPrice: string;
+}>;
+declare function memberListOrders$1(httpClient: HttpClient): (options?: MemberListOrdersOptions) => Promise<MemberListOrdersResponse & MemberListOrdersResponseNonNullableFields>;
+declare function requestCancellation$1(httpClient: HttpClient): (_id: string, effectiveAt: CancellationEffectiveAt) => Promise<void>;
+declare function createOfflineOrder$1(httpClient: HttpClient): (planId: string, memberId: string, options?: CreateOfflineOrderOptions) => Promise<CreateOfflineOrderResponse & CreateOfflineOrderResponseNonNullableFields>;
+declare function getOfflineOrderPreview$1(httpClient: HttpClient): (planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions) => Promise<GetOfflineOrderPreviewResponse & GetOfflineOrderPreviewResponseNonNullableFields>;
+declare function getPricePreview$1(httpClient: HttpClient): (planId: string, options?: GetPricePreviewOptions) => Promise<GetPricePreviewResponse & GetPricePreviewResponseNonNullableFields>;
+declare function managementGetOrder$1(httpClient: HttpClient): (_id: string, options?: ManagementGetOrderOptions) => Promise<GetOrderResponse & GetOrderResponseNonNullableFields>;
+declare function managementListOrders$1(httpClient: HttpClient): (options?: ManagementListOrdersOptions) => Promise<ListOrdersResponse & ListOrdersResponseNonNullableFields>;
+declare function postponeEndDate$1(httpClient: HttpClient): (_id: string, endDate: Date) => Promise<void>;
+declare function cancelOrder$1(httpClient: HttpClient): (_id: string, effectiveAt: CancellationEffectiveAt) => Promise<void>;
+declare function markAsPaid$1(httpClient: HttpClient): (_id: string) => Promise<void>;
+declare function pauseOrder$1(httpClient: HttpClient): (_id: string) => Promise<void>;
+declare function resumeOrder$1(httpClient: HttpClient): (_id: string) => Promise<void>;
+declare const onOrderCanceled$1: EventDefinition<OrderCanceledEnvelope, "wix.pricing_plans.v2.order_canceled">;
+declare const onOrderCreated$1: EventDefinition<OrderCreatedEnvelope, "wix.pricing_plans.v2.order_created">;
+declare const onOrderUpdated$1: EventDefinition<OrderUpdatedEnvelope, "wix.pricing_plans.v2.order_updated">;
+declare const onOrderStartDateChanged$1: EventDefinition<OrderStartDateChangedEnvelope, "wix.pricing_plans.v2.order_start_date_changed">;
+declare const onOrderPurchased$1: EventDefinition<OrderPurchasedEnvelope, "wix.pricing_plans.v2.order_purchased">;
+declare const onOrderStarted$1: EventDefinition<OrderStartedEnvelope, "wix.pricing_plans.v2.order_started">;
+declare const onOrderCycleStarted$1: EventDefinition<OrderCycleStartedEnvelope, "wix.pricing_plans.v2.order_cycle_started">;
+declare const onOrderAutoRenewCanceled$1: EventDefinition<OrderAutoRenewCanceledEnvelope, "wix.pricing_plans.v2.order_auto_renew_canceled">;
+declare const onOrderEnded$1: EventDefinition<OrderEndedEnvelope, "wix.pricing_plans.v2.order_ended">;
+declare const onOrderEndDatePostponed$1: EventDefinition<OrderEndDatePostponedEnvelope, "wix.pricing_plans.v2.order_end_date_postponed">;
+declare const onOrderMarkedAsPaid$1: EventDefinition<OrderMarkedAsPaidEnvelope, "wix.pricing_plans.v2.order_marked_as_paid">;
+declare const onOrderPaused$1: EventDefinition<OrderPausedEnvelope, "wix.pricing_plans.v2.order_paused">;
+declare const onOrderResumed$1: EventDefinition<OrderResumedEnvelope, "wix.pricing_plans.v2.order_resumed">;
+
+declare const memberGetOrder: BuildRESTFunction<typeof memberGetOrder$1>;
+declare const memberListOrders: BuildRESTFunction<typeof memberListOrders$1>;
+declare const requestCancellation: BuildRESTFunction<typeof requestCancellation$1>;
+declare const createOfflineOrder: BuildRESTFunction<typeof createOfflineOrder$1>;
+declare const getOfflineOrderPreview: BuildRESTFunction<typeof getOfflineOrderPreview$1>;
+declare const getPricePreview: BuildRESTFunction<typeof getPricePreview$1>;
+declare const managementGetOrder: BuildRESTFunction<typeof managementGetOrder$1>;
+declare const managementListOrders: BuildRESTFunction<typeof managementListOrders$1>;
+declare const postponeEndDate: BuildRESTFunction<typeof postponeEndDate$1>;
+declare const cancelOrder: BuildRESTFunction<typeof cancelOrder$1>;
+declare const markAsPaid: BuildRESTFunction<typeof markAsPaid$1>;
+declare const pauseOrder: BuildRESTFunction<typeof pauseOrder$1>;
+declare const resumeOrder: BuildRESTFunction<typeof resumeOrder$1>;
+declare const onOrderCanceled: BuildEventDefinition<typeof onOrderCanceled$1>;
+declare const onOrderCreated: BuildEventDefinition<typeof onOrderCreated$1>;
+declare const onOrderUpdated: BuildEventDefinition<typeof onOrderUpdated$1>;
+declare const onOrderStartDateChanged: BuildEventDefinition<typeof onOrderStartDateChanged$1>;
+declare const onOrderPurchased: BuildEventDefinition<typeof onOrderPurchased$1>;
+declare const onOrderStarted: BuildEventDefinition<typeof onOrderStarted$1>;
+declare const onOrderCycleStarted: BuildEventDefinition<typeof onOrderCycleStarted$1>;
+declare const onOrderAutoRenewCanceled: BuildEventDefinition<typeof onOrderAutoRenewCanceled$1>;
+declare const onOrderEnded: BuildEventDefinition<typeof onOrderEnded$1>;
+declare const onOrderEndDatePostponed: BuildEventDefinition<typeof onOrderEndDatePostponed$1>;
+declare const onOrderMarkedAsPaid: BuildEventDefinition<typeof onOrderMarkedAsPaid$1>;
+declare const onOrderPaused: BuildEventDefinition<typeof onOrderPaused$1>;
+declare const onOrderResumed: BuildEventDefinition<typeof onOrderResumed$1>;
+
+declare const context$1_cancelOrder: typeof cancelOrder;
+declare const context$1_createOfflineOrder: typeof createOfflineOrder;
+declare const context$1_getOfflineOrderPreview: typeof getOfflineOrderPreview;
+declare const context$1_getPricePreview: typeof getPricePreview;
+declare const context$1_managementGetOrder: typeof managementGetOrder;
+declare const context$1_managementListOrders: typeof managementListOrders;
+declare const context$1_markAsPaid: typeof markAsPaid;
+declare const context$1_memberGetOrder: typeof memberGetOrder;
+declare const context$1_memberListOrders: typeof memberListOrders;
+declare const context$1_onOrderAutoRenewCanceled: typeof onOrderAutoRenewCanceled;
+declare const context$1_onOrderCanceled: typeof onOrderCanceled;
+declare const context$1_onOrderCreated: typeof onOrderCreated;
+declare const context$1_onOrderCycleStarted: typeof onOrderCycleStarted;
+declare const context$1_onOrderEndDatePostponed: typeof onOrderEndDatePostponed;
+declare const context$1_onOrderEnded: typeof onOrderEnded;
+declare const context$1_onOrderMarkedAsPaid: typeof onOrderMarkedAsPaid;
+declare const context$1_onOrderPaused: typeof onOrderPaused;
+declare const context$1_onOrderPurchased: typeof onOrderPurchased;
+declare const context$1_onOrderResumed: typeof onOrderResumed;
+declare const context$1_onOrderStartDateChanged: typeof onOrderStartDateChanged;
+declare const context$1_onOrderStarted: typeof onOrderStarted;
+declare const context$1_onOrderUpdated: typeof onOrderUpdated;
+declare const context$1_pauseOrder: typeof pauseOrder;
+declare const context$1_postponeEndDate: typeof postponeEndDate;
+declare const context$1_requestCancellation: typeof requestCancellation;
+declare const context$1_resumeOrder: typeof resumeOrder;
+declare namespace context$1 {
+  export { context$1_cancelOrder as cancelOrder, context$1_createOfflineOrder as createOfflineOrder, context$1_getOfflineOrderPreview as getOfflineOrderPreview, context$1_getPricePreview as getPricePreview, context$1_managementGetOrder as managementGetOrder, context$1_managementListOrders as managementListOrders, context$1_markAsPaid as markAsPaid, context$1_memberGetOrder as memberGetOrder, context$1_memberListOrders as memberListOrders, context$1_onOrderAutoRenewCanceled as onOrderAutoRenewCanceled, context$1_onOrderCanceled as onOrderCanceled, context$1_onOrderCreated as onOrderCreated, context$1_onOrderCycleStarted as onOrderCycleStarted, context$1_onOrderEndDatePostponed as onOrderEndDatePostponed, context$1_onOrderEnded as onOrderEnded, context$1_onOrderMarkedAsPaid as onOrderMarkedAsPaid, context$1_onOrderPaused as onOrderPaused, context$1_onOrderPurchased as onOrderPurchased, context$1_onOrderResumed as onOrderResumed, context$1_onOrderStartDateChanged as onOrderStartDateChanged, context$1_onOrderStarted as onOrderStarted, context$1_onOrderUpdated as onOrderUpdated, context$1_pauseOrder as pauseOrder, context$1_postponeEndDate as postponeEndDate, context$1_requestCancellation as requestCancellation, context$1_resumeOrder as resumeOrder };
+}
+
+/** Information about the pricing plan. */
+interface Plan {
+    /**
+     * Plan ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Plan name. */
+    name?: string | null;
+    /** Plan description. */
+    description?: string | null;
+    /**
+     * List of text strings that promote what is included with this plan.
+     *
+     * For example, "Plenty of parking" or "Free gift on your birthday".
+     */
+    perks?: StringList;
+    /** Plan price, payment schedule, and expiration. */
+    pricing?: Pricing;
+    /** Whether the plan is public (visible to site visitors and members). */
+    public?: boolean | null;
+    /**
+     * Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.
+     * @readonly
+     */
+    archived?: boolean;
+    /**
+     * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
+     *
+     * Default: `false`.
+     * @readonly
+     */
+    primary?: boolean;
+    /**
+     * Whether the plan has any orders (including pending and unpaid orders).
+     * @readonly
+     */
+    hasOrders?: boolean;
+    /**
+     * Date plan was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date plan was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * URL-friendly version of plan name. Unique across all plans in the same site.
+     * @readonly
+     */
+    slug?: string | null;
+    /**
+     * Number of times the same buyer can purchase the plan. Currently limited to support:
+     * - Empty value or a value of `0`, meaning no limitation.
+     * - Value of `1`, meaning limited to one purchase per buyer.
+     */
+    maxPurchasesPerBuyer?: number | null;
+    /**
+     * Whether the buyer can start the plan at a later date.
+     *
+     * Default: `false`.
+     *
+     */
+    allowFutureStartDate?: boolean | null;
+    /**
+     * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.
+     *
+     * Default: `true`.
+     *
+     */
+    buyerCanCancel?: boolean | null;
+    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
+    termsAndConditions?: string | null;
+    /** ID of the form associated with the plan at checkout. */
+    formId?: string | null;
+}
+/** This wrapper type exist in order to distinguish an empty string list from no list at all in update requests. */
+interface StringList {
+    /** List of strings */
+    values?: string[];
+}
+/** Plan pricing information. Includes the price of the plan and payment details. */
+interface Pricing extends PricingPricingModelOneOf {
+    /**
+     * Pricing model indicating that the plan has recurring payments.
+     *
+     * Note: This type of subscription is not a "Wix subscription," which encompasses various types of subscriptions, such as Wix Stores subscriptions, Wix invoice subscriptions, and *all* pricing plan models.
+     */
+    subscription?: Recurrence;
+    /** Pricing model indicating a single payment per cycle and the length of the cycle. The cycle is the duration of the plan, not a payment cycle. */
+    singlePaymentForDuration?: Duration;
+    /** Pricing model indicating the plan is paid in one single payment. The plan is valid until canceled.   */
+    singlePaymentUnlimited?: boolean | null;
+    /** Amount for a single payment. For subscriptions, this is the amount to pay each payment cycle and it is required. For plans that are not recurring plans, it is the single payment amount for the whole subscription.  */
+    price?: Money;
+    /** Free trial period for the plan in days. Available only for recurring plans, meaning plans whose pricing model is `subscription`. Set to `0` to remove the free trial.  */
+    freeTrialDays?: number | null;
+}
+/** @oneof */
+interface PricingPricingModelOneOf {
+    /** Plan has recurring payments. */
+    subscription?: Recurrence;
+    /** One time payment, plan is valid for the specified duration. */
+    singlePaymentForDuration?: Duration;
+    /** One time payment, plan is valid until it is canceled. */
+    singlePaymentUnlimited?: boolean | null;
+}
+/** An object specifying how often and for how long payments recur (may be forever). */
+interface Recurrence {
+    /** Length of one 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.  */
+    cycleDuration?: Duration;
+    /**
+     * Amount of payment cycles the subscription is valid for.
+     *
+     * `0` for unlimited plans or for plans that are valid until canceled.
+     */
+    cycleCount?: number | null;
+}
+/** A duration expressed in number of time units. */
+interface Duration {
+    /** Number of days days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.  */
+    count?: number | null;
+    /** Unit of time for the cycle duration. */
+    unit?: PeriodUnit;
+}
+declare enum PeriodUnit {
+    UNDEFINED = "UNDEFINED",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+interface Money {
+    /** Monetary amount. Decimal string with a period as a decimal separator. For example, `'3.99'`. Cannot be a negative value.   */
+    value?: string;
+    /**
+     * Currency code. Three-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format. For example, `'USD'`.
+     */
+    currency?: string;
+}
+interface ListPublicPlansResponse {
+    /** List of public pricing plans. */
+    plans?: PublicPlan[];
+    /** Details on the paged set of public pricing plans returned.  */
+    pagingMetadata?: PagingMetadataV2;
+}
+/** Public plan entity containing information about the pricing plan. Can be read by any site member or visitor. */
+interface PublicPlan {
+    /** Plan ID. */
+    _id?: string;
+    /** Plan name. */
+    name?: string | null;
+    /** Plan description. */
+    description?: string | null;
+    /** What is included with this plan (e.g., 1 weekly entrance to a specific class). */
+    perks?: StringList;
+    /** Plan price, payment schedule, and expiration. */
+    pricing?: Pricing;
+    /** Whether the plan is marked as primary. */
+    primary?: boolean;
+    /** Date plan was created. */
+    _createdDate?: Date;
+    /** Date plan was last updated. */
+    _updatedDate?: Date;
+    /** URL-friendly version of plan name. Unique across all plans in the same site. */
+    slug?: string | null;
+    /** Number of times the same buyer can purchase the plan. An empty value or a value of zero means no limitation. */
+    maxPurchasesPerBuyer?: number | null;
+    /** Whether the buyer can start the plan at a later date. Defaults to false. */
+    allowFutureStartDate?: boolean | null;
+    /** Whether the buyer is allowed to cancel their plan. Defaults to false. */
+    buyerCanCancel?: boolean | null;
+    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
+    termsAndConditions?: string | null;
+    /** ID of the form associated with the plan at checkout. */
+    formId?: string | null;
+}
+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 Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+declare enum ArchivedFilter {
+    /** Returns all plans that are active. */
+    ACTIVE = "ACTIVE",
+    /** Returns all plans that are archived. */
+    ARCHIVED = "ARCHIVED",
+    /** Returns all plans that are active and archived. */
+    ARCHIVED_AND_ACTIVE = "ARCHIVED_AND_ACTIVE"
+}
+declare enum PublicFilter {
+    /** Returns all public and hidden plans. */
+    PUBLIC_AND_HIDDEN = "PUBLIC_AND_HIDDEN",
+    /** Returns only public plans. */
+    PUBLIC = "PUBLIC",
+    /** Returns only hidden plans. */
+    HIDDEN = "HIDDEN"
+}
+interface ListPlansResponse {
+    /** List of all public and hidden pricing plans. */
+    plans?: Plan[];
+    /** Details on the paged set of pricing plans returned.  */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface GetPlanStatsResponse {
+    /** Total number of plans created, including active plans (both public and hidden) and archived plans. */
+    totalPlans?: number;
+}
+interface BuyerCanCancelUpdated {
+    plan?: Plan;
+}
+interface SetPlanVisibilityResponse {
+    /** Plan info.  */
+    plan?: Plan;
+}
+interface MakePlanPrimaryResponse {
+    /** Primary plan info. */
+    plan?: Plan;
+}
+interface ArchivePlanResponse {
+    /** Archived plan info.  */
+    plan?: Plan;
+}
+interface PlanArchived {
+    plan?: Plan;
+}
+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;
+}
+/** @oneof */
+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;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface ListPublicPlansResponseNonNullableFields {
+    plans: {
+        _id: string;
+        perks?: {
+            values: string[];
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            price?: {
+                value: string;
+                currency: string;
+            };
+        };
+        primary: boolean;
+    }[];
+}
+interface ListPlansResponseNonNullableFields {
+    plans: {
+        _id: string;
+        perks?: {
+            values: string[];
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            price?: {
+                value: string;
+                currency: string;
+            };
+        };
+        archived: boolean;
+        primary: boolean;
+        hasOrders: boolean;
+    }[];
+}
+interface GetPlanStatsResponseNonNullableFields {
+    totalPlans: number;
+}
+interface SetPlanVisibilityResponseNonNullableFields {
+    plan?: {
+        _id: string;
+        perks?: {
+            values: string[];
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            price?: {
+                value: string;
+                currency: string;
+            };
+        };
+        archived: boolean;
+        primary: boolean;
+        hasOrders: boolean;
+    };
+}
+interface MakePlanPrimaryResponseNonNullableFields {
+    plan?: {
+        _id: string;
+        perks?: {
+            values: string[];
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            price?: {
+                value: string;
+                currency: string;
+            };
+        };
+        archived: boolean;
+        primary: boolean;
+        hasOrders: boolean;
+    };
+}
+interface ArchivePlanResponseNonNullableFields {
+    plan?: {
+        _id: string;
+        perks?: {
+            values: string[];
+        };
+        pricing?: {
+            subscription?: {
+                cycleDuration?: {
+                    unit: PeriodUnit;
+                };
+            };
+            singlePaymentForDuration?: {
+                unit: PeriodUnit;
+            };
+            price?: {
+                value: string;
+                currency: string;
+            };
+        };
+        archived: boolean;
+        primary: boolean;
+        hasOrders: boolean;
+    };
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * Example: created/updated/deleted/started/completed/email_opened
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp. */
+    eventTime?: Date;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface PlanUpdatedEnvelope {
+    entity: Plan;
+    metadata: EventMetadata;
+}
+interface PlanCreatedEnvelope {
+    entity: Plan;
+    metadata: EventMetadata;
+}
+interface PlanBuyerCanCancelUpdatedEnvelope {
+    data: BuyerCanCancelUpdated;
+    metadata: EventMetadata;
+}
+interface PlanArchivedEnvelope {
+    data: PlanArchived;
+    metadata: EventMetadata;
+}
+interface ListPublicPlansOptions {
+    /**
+     * Number of pricing plans to list.
+     *
+     * Default: `75`.
+     */
+    limit?: number | null;
+    /**
+     * Number of pricing plans to skip.
+     *
+     * Default: `0`.
+     */
+    offset?: number | null;
+    /** IDs of public plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    planIds?: string[];
+}
+interface QueryOffsetResult {
+    currentPage: number | undefined;
+    totalPages: number | undefined;
+    totalCount: number | undefined;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface PlansQueryResult extends QueryOffsetResult {
+    items: PublicPlan[];
+    query: PlansQueryBuilder;
+    next: () => Promise<PlansQueryResult>;
+    prev: () => Promise<PlansQueryResult>;
+}
+interface PlansQueryBuilder {
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    eq: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ne: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    ge: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    gt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    le: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `value`.
+     * @param value - Value to compare against.
+     */
+    lt: (propertyName: '_createdDate' | '_updatedDate', value: any) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `string`.
+     * @param string - String to compare against. Case-insensitive.
+     */
+    startsWith: (propertyName: '_id' | 'slug', value: string) => PlansQueryBuilder;
+    /** @param propertyName - Property whose value is compared with `values`.
+     * @param values - List of values to compare against.
+     */
+    hasSome: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any[]) => PlansQueryBuilder;
+    in: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: any) => PlansQueryBuilder;
+    exists: (propertyName: '_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug', value: boolean) => PlansQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    ascending: (...propertyNames: Array<'_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug'>) => PlansQueryBuilder;
+    /** @param propertyNames - Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. */
+    descending: (...propertyNames: Array<'_id' | 'primary' | '_createdDate' | '_updatedDate' | 'slug'>) => PlansQueryBuilder;
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object. */
+    limit: (limit: number) => PlansQueryBuilder;
+    /** @param skip - Number of items to skip in the query results before returning the results. */
+    skip: (skip: number) => PlansQueryBuilder;
+    find: () => Promise<PlansQueryResult>;
+}
+interface ListPlansOptions {
+    /**
+     * Archived filter.
+     *
+     * Default: `ACTIVE` (not archived).
+     */
+    archived?: ArchivedFilter;
+    /**
+     * Visibility filter.
+     *
+     * Default: `PUBLIC_AND_HIDDEN` (meaning, both public and hidden plans are listed).
+     *
+     */
+    public?: PublicFilter;
+    /**
+     * Number of pricing plans to list.
+     *
+     * Default: `75`.
+     */
+    limit?: number | null;
+    /**
+     * Number of pricing plans to skip.
+     *
+     * Default: `0`.
+     */
+    offset?: number | null;
+    /** IDs of plans to list. If non-existent IDs are specified, they are ignored and don't cause errors. If no IDs are specified, all public and hidden plans (based on `options`) are listed according to the [order](#arrangeplans) displayed in the Dashboard. You can pass a maximum of 100 IDs.  */
+    planIds?: string[];
+}
+interface UpdatePlan {
+    /**
+     * Plan ID.
+     * @readonly
+     */
+    _id?: string;
+    /** Plan name. */
+    name?: string | null;
+    /** Plan description. */
+    description?: string | null;
+    /**
+     * List of text strings that promote what is included with this plan.
+     *
+     * For example, "Plenty of parking" or "Free gift on your birthday".
+     */
+    perks?: StringList;
+    /** Plan price, payment schedule, and expiration. */
+    pricing?: Pricing;
+    /** Whether the plan is public (visible to site visitors and members). */
+    public?: boolean | null;
+    /**
+     * Whether the plan is archived. Archived plans are not visible and can't be purchased anymore, but existing purchases remain in effect.
+     * @readonly
+     */
+    archived?: boolean;
+    /**
+     * Whether the plan is marked as primary. If `true`, the plan is highlighted on the site with a custom ribbon.
+     *
+     * Default: `false`.
+     * @readonly
+     */
+    primary?: boolean;
+    /**
+     * Whether the plan has any orders (including pending and unpaid orders).
+     * @readonly
+     */
+    hasOrders?: boolean;
+    /**
+     * Date plan was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date plan was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * URL-friendly version of plan name. Unique across all plans in the same site.
+     * @readonly
+     */
+    slug?: string | null;
+    /**
+     * Number of times the same buyer can purchase the plan. Currently limited to support:
+     * - Empty value or a value of `0`, meaning no limitation.
+     * - Value of `1`, meaning limited to one purchase per buyer.
+     */
+    maxPurchasesPerBuyer?: number | null;
+    /**
+     * Whether the buyer can start the plan at a later date.
+     *
+     * Default: `false`.
+     *
+     */
+    allowFutureStartDate?: boolean | null;
+    /**
+     * Whether the buyer is allowed to cancel their plan. If `false`, calling the [`requestCancellation()`](https://www.wix.com/velo/reference/wix-pricing-plans-v2/orders/requestcancellation) function returns an error.
+     *
+     * Default: `true`.
+     *
+     */
+    buyerCanCancel?: boolean | null;
+    /** Any terms and conditions that apply to the plan. This information will be displayed during checkout. */
+    termsAndConditions?: string | null;
+    /** ID of the form associated with the plan at checkout. */
+    formId?: string | null;
+}
+
+declare function listPublicPlans$1(httpClient: HttpClient): (options?: ListPublicPlansOptions) => Promise<ListPublicPlansResponse & ListPublicPlansResponseNonNullableFields>;
+declare function queryPublicPlans$1(httpClient: HttpClient): () => PlansQueryBuilder;
+declare function getPlan$1(httpClient: HttpClient): (_id: string) => Promise<Plan & {
+    _id: string;
+    perks?: {
+        values: string[];
+    } | undefined;
+    pricing?: {
+        subscription?: {
+            cycleDuration?: {
+                unit: PeriodUnit;
+            } | undefined;
+        } | undefined;
+        singlePaymentForDuration?: {
+            unit: PeriodUnit;
+        } | undefined;
+        price?: {
+            value: string;
+            currency: string;
+        } | undefined;
+    } | undefined;
+    archived: boolean;
+    primary: boolean;
+    hasOrders: boolean;
+}>;
+declare function listPlans$1(httpClient: HttpClient): (options?: ListPlansOptions) => Promise<ListPlansResponse & ListPlansResponseNonNullableFields>;
+declare function getPlanStats$1(httpClient: HttpClient): () => Promise<GetPlanStatsResponse & GetPlanStatsResponseNonNullableFields>;
+declare function createPlan$1(httpClient: HttpClient): (plan: Plan) => Promise<Plan & {
+    _id: string;
+    perks?: {
+        values: string[];
+    } | undefined;
+    pricing?: {
+        subscription?: {
+            cycleDuration?: {
+                unit: PeriodUnit;
+            } | undefined;
+        } | undefined;
+        singlePaymentForDuration?: {
+            unit: PeriodUnit;
+        } | undefined;
+        price?: {
+            value: string;
+            currency: string;
+        } | undefined;
+    } | undefined;
+    archived: boolean;
+    primary: boolean;
+    hasOrders: boolean;
+}>;
+declare function updatePlan$1(httpClient: HttpClient): (_id: string, plan: UpdatePlan) => Promise<Plan & {
+    _id: string;
+    perks?: {
+        values: string[];
+    } | undefined;
+    pricing?: {
+        subscription?: {
+            cycleDuration?: {
+                unit: PeriodUnit;
+            } | undefined;
+        } | undefined;
+        singlePaymentForDuration?: {
+            unit: PeriodUnit;
+        } | undefined;
+        price?: {
+            value: string;
+            currency: string;
+        } | undefined;
+    } | undefined;
+    archived: boolean;
+    primary: boolean;
+    hasOrders: boolean;
+}>;
+declare function setPlanVisibility$1(httpClient: HttpClient): (_id: string, visible: boolean) => Promise<SetPlanVisibilityResponse & SetPlanVisibilityResponseNonNullableFields>;
+declare function makePlanPrimary$1(httpClient: HttpClient): (_id: string) => Promise<MakePlanPrimaryResponse & MakePlanPrimaryResponseNonNullableFields>;
+declare function clearPrimary$1(httpClient: HttpClient): () => Promise<void>;
+declare function archivePlan$1(httpClient: HttpClient): (_id: string) => Promise<ArchivePlanResponse & ArchivePlanResponseNonNullableFields>;
+declare function arrangePlans$1(httpClient: HttpClient): (ids: string[]) => Promise<void>;
+declare const onPlanUpdated$1: EventDefinition<PlanUpdatedEnvelope, "wix.pricing_plans.plan_updated">;
+declare const onPlanCreated$1: EventDefinition<PlanCreatedEnvelope, "wix.pricing_plans.plan_created">;
+declare const onPlanBuyerCanCancelUpdated$1: EventDefinition<PlanBuyerCanCancelUpdatedEnvelope, "wix.pricing_plans.plan_buyer_can_cancel_updated">;
+declare const onPlanArchived$1: EventDefinition<PlanArchivedEnvelope, "wix.pricing_plans.plan_plan_archived">;
+
+declare const listPublicPlans: BuildRESTFunction<typeof listPublicPlans$1>;
+declare const queryPublicPlans: BuildRESTFunction<typeof queryPublicPlans$1>;
+declare const getPlan: BuildRESTFunction<typeof getPlan$1>;
+declare const listPlans: BuildRESTFunction<typeof listPlans$1>;
+declare const getPlanStats: BuildRESTFunction<typeof getPlanStats$1>;
+declare const createPlan: BuildRESTFunction<typeof createPlan$1>;
+declare const updatePlan: BuildRESTFunction<typeof updatePlan$1>;
+declare const setPlanVisibility: BuildRESTFunction<typeof setPlanVisibility$1>;
+declare const makePlanPrimary: BuildRESTFunction<typeof makePlanPrimary$1>;
+declare const clearPrimary: BuildRESTFunction<typeof clearPrimary$1>;
+declare const archivePlan: BuildRESTFunction<typeof archivePlan$1>;
+declare const arrangePlans: BuildRESTFunction<typeof arrangePlans$1>;
+declare const onPlanUpdated: BuildEventDefinition<typeof onPlanUpdated$1>;
+declare const onPlanCreated: BuildEventDefinition<typeof onPlanCreated$1>;
+declare const onPlanBuyerCanCancelUpdated: BuildEventDefinition<typeof onPlanBuyerCanCancelUpdated$1>;
+declare const onPlanArchived: BuildEventDefinition<typeof onPlanArchived$1>;
+
+declare const context_archivePlan: typeof archivePlan;
+declare const context_arrangePlans: typeof arrangePlans;
+declare const context_clearPrimary: typeof clearPrimary;
+declare const context_createPlan: typeof createPlan;
+declare const context_getPlan: typeof getPlan;
+declare const context_getPlanStats: typeof getPlanStats;
+declare const context_listPlans: typeof listPlans;
+declare const context_listPublicPlans: typeof listPublicPlans;
+declare const context_makePlanPrimary: typeof makePlanPrimary;
+declare const context_onPlanArchived: typeof onPlanArchived;
+declare const context_onPlanBuyerCanCancelUpdated: typeof onPlanBuyerCanCancelUpdated;
+declare const context_onPlanCreated: typeof onPlanCreated;
+declare const context_onPlanUpdated: typeof onPlanUpdated;
+declare const context_queryPublicPlans: typeof queryPublicPlans;
+declare const context_setPlanVisibility: typeof setPlanVisibility;
+declare const context_updatePlan: typeof updatePlan;
+declare namespace context {
+  export { context_archivePlan as archivePlan, context_arrangePlans as arrangePlans, context_clearPrimary as clearPrimary, context_createPlan as createPlan, context_getPlan as getPlan, context_getPlanStats as getPlanStats, context_listPlans as listPlans, context_listPublicPlans as listPublicPlans, context_makePlanPrimary as makePlanPrimary, context_onPlanArchived as onPlanArchived, context_onPlanBuyerCanCancelUpdated as onPlanBuyerCanCancelUpdated, context_onPlanCreated as onPlanCreated, context_onPlanUpdated as onPlanUpdated, context_queryPublicPlans as queryPublicPlans, context_setPlanVisibility as setPlanVisibility, context_updatePlan as updatePlan };
+}
+
+export { context$1 as orders, context as plans };