@wix/pricing-plans 1.0.54 → 1.0.56

package/build/es/src/pricing-plans-v2-order.universal.d.ts

@@ -1,2225 +0,0 @@
-import { EventDefinition } from '@wix/sdk-types';
-/**
- * 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).
- */
-export 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
-     */
-    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;
-}
-export interface Buyer {
-    /**
-     * Member ID for a buyer.
-     * @readonly
-     */
-    memberId?: string;
-    /**
-     * Contact ID for a buyer.
-     * @readonly
-     */
-    contactId?: string;
-}
-export interface PriceDetails extends PriceDetailsPricingModelOneOf {
-    /** Order has recurring payments. */
-    subscription?: Recurrence;
-    /** One-time payment. Order is valid for a specified duration. */
-    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"`. */
-    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 */
-export interface PriceDetailsPricingModelOneOf {
-    /** Order has recurring payments. */
-    subscription?: Recurrence;
-    /** One-time payment. Order is valid for a specified duration. */
-    singlePaymentForDuration?: Duration;
-    /** One-time payment. Order is valid until it is canceled. */
-    singlePaymentUnlimited?: boolean | null;
-}
-export 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). */
-export interface Recurrence {
-    /** Length of one payment cycle. */
-    cycleDuration?: Duration;
-    /**
-     * 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. */
-export interface Duration {
-    /**
-     * 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;
-}
-export declare enum PeriodUnit {
-    UNDEFINED = "UNDEFINED",
-    DAY = "DAY",
-    WEEK = "WEEK",
-    MONTH = "MONTH",
-    YEAR = "YEAR"
-}
-export 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;
-}
-export interface PricingDetails extends PricingDetailsPricingModelOneOf {
-    /** Pricing model for an order with recurring payment cycles. */
-    subscription?: Recurrence;
-    /** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */
-    singlePaymentForDuration?: Duration;
-    /** 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 */
-export interface PricingDetailsPricingModelOneOf {
-    /** Pricing model for an order with recurring payment cycles. */
-    subscription?: Recurrence;
-    /** Pricing model for an order with a one-time payment and the order is valid for a specific amount of time. */
-    singlePaymentForDuration?: Duration;
-    /** Pricing model for an order with a one-time payment and the order is valid until canceled. */
-    singlePaymentUnlimited?: boolean | null;
-}
-export 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;
-}
-export 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;
-}
-export 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;
-}
-export interface Fee {
-    /** Fee name */
-    name?: string;
-    /** Amount of fee to be charged */
-    amount?: string;
-}
-export 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"
-}
-export declare enum OrderMethod {
-    UNKNOWN = "UNKNOWN",
-    /** Mail Order / Telephone Order transaction */
-    MOTO = "MOTO",
-    /** Point of Sale transaction */
-    POS = "POS"
-}
-export 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"
-}
-export 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;
-}
-export 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"
-}
-export 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"
-}
-export 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"
-}
-export 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;
-}
-export 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
- */
-export 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;
-}
-/** Order cycle start and end dates take into account free trial days and suspensions */
-export interface OrderCycle {
-    /**
-     * Index of this 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 this order cycle. */
-    startedDate?: Date;
-    /** End date and time for this order cycle. */
-    endedDate?: Date;
-}
-export 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>;
-}
-export interface DomainEvent<T = string> extends DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-    /**
-     * 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;
-}
-export interface DomainCreatedEvent<T> extends Omit<DomainEvent<T>, 'deletedEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainDeletedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'updatedEvent' | 'actionEvent'> {
-}
-export interface DomainUpdatedEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'actionEvent'> {
-}
-export interface DomainActionEvent<T> extends Omit<DomainEvent<T>, 'createdEvent' | 'deletedEvent' | 'updatedEvent'> {
-}
-/** @oneof */
-export interface DomainEventBodyOneOf<T> {
-    createdEvent?: EntityCreatedEvent<T>;
-    updatedEvent?: EntityUpdatedEvent<T>;
-    deletedEvent?: EntityDeletedEvent<T>;
-    actionEvent?: ActionEvent<T>;
-}
-export interface EntityCreatedEvent<T> {
-    entity?: T;
-}
-export interface EntityUpdatedEvent<T> {
-    /**
-     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
-     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
-     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
-     */
-    currentEntity?: T;
-}
-export interface EntityDeletedEvent<T> {
-    /** Entity that was deleted */
-    deletedEntity?: T | null;
-}
-export interface ActionEvent<T> {
-    body?: T;
-}
-export interface Empty {
-}
-export interface MemberGetOrderRequest {
-    /** Order ID. */
-    _id: string;
-    fieldSet?: Set;
-}
-export 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"
-}
-export interface MemberGetOrderResponse {
-    /** Requested order. */
-    order?: Order;
-}
-export interface MemberListOrdersRequest {
-    /** Filter by plan IDs. */
-    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. */
-    limit?: number | null;
-    /** Number of entries to offset. */
-    offset?: number | null;
-    /** Sorting direction (defaults to ASC) and field to sort by. [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */
-    sorting?: Sorting;
-    fieldSet?: Set;
-}
-export interface Sorting {
-    /** Name of the field to sort by. */
-    fieldName?: string;
-    /** Sort order. */
-    order?: SortOrder;
-}
-export declare enum SortOrder {
-    ASC = "ASC",
-    DESC = "DESC"
-}
-export interface MemberListOrdersResponse {
-    /** List of orders. */
-    orders?: Order[];
-    /** Object containing paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-export 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;
-}
-export 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;
-}
-/**
- * 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](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort).
- */
-export interface QueryOrdersRequest {
-    query?: QueryV2;
-}
-export interface QueryV2 extends QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object in the following format:
-     * `"filter" : {
-     * "fieldName1": "value1",
-     * "fieldName2":{"$operator":"value2"}
-     * }`
-     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Sort object in the following format:
-     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     */
-    sort?: Sorting[];
-    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fields?: string[];
-    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
-    fieldsets?: string[];
-}
-/** @oneof */
-export interface QueryV2PagingMethodOneOf {
-    /** Paging options to limit and skip the number of items. */
-    paging?: Paging;
-    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
-    cursorPaging?: CursorPaging;
-}
-export interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-export interface CursorPaging {
-    /** Maximum number of items to return in the results. */
-    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.
-     */
-    cursor?: string | null;
-}
-export interface QueryOrdersResponse {
-    /** Order data. */
-    plans?: Order[];
-    /** Paging-related data (number of orders returned, offset). */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface RequestCancellationRequest {
-    /** Order ID. */
-    _id: string;
-    /**
-     * Whether to cancel the order immediately or at the next payment date.
-     * One-time payment orders can only be canceled immediately.
-     *
-     * Supported values:
-     * - `"IMMEDIATELY"`: Indicates that the order should be canceled immediately.
-     * - `"NEXT_PAYMENT_DATE"`: Indicates that the order be canceled at the next payment date.
-     */
-    effectiveAt: CancellationEffectiveAt;
-}
-export interface RequestCancellationResponse {
-}
-/**
- * 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.
- */
-export interface OrderCanceled {
-    /** Canceled order. */
-    order?: Order;
-}
-export interface CreateOnlineOrderRequest {
-    /** Plan ID. */
-    planId?: string;
-    /**
-     * Start date for the ordered plan.
-     *
-     * Default: Current date
-     */
-    startDate?: Date;
-    /** Coupon code to apply. */
-    couponCode?: string | null;
-    /** Provided if checkout is initiated on buyer's behalf. */
-    onBehalf?: OnBehalf;
-    /** Form submission id that was submitted together with the order */
-    submissionId?: string | null;
-}
-export interface OnBehalf {
-    /** Member ID. */
-    memberId?: string;
-    /** Method by which checkout is initiated on buyer's behalf */
-    orderMethod?: OrderMethod;
-}
-export interface CreateOnlineOrderResponse {
-    /** Order. */
-    order?: Order;
-}
-export interface CouponsError {
-    couponCode?: string;
-    planId?: string;
-}
-export interface CreateGuestOnlineOrderRequest {
-    /** Plan ID. */
-    planId?: string;
-    /**
-     * Start date for the ordered plan.
-     *
-     * Default: Current date
-     */
-    startDate?: Date;
-    /** Coupon code to apply. */
-    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 */
-    submissionId?: string | null;
-}
-export interface Captcha {
-    /** Token from captcha */
-    token?: string;
-}
-export interface Guest {
-    /** Email for checkout */
-    email?: string;
-}
-export interface CreateGuestOnlineOrderResponse {
-    /** Order. */
-    order?: Order;
-}
-export interface CreateOfflineOrderRequest {
-    /** ID of the plan being ordered. */
-    planId: string;
-    /** ID of the member ordering the plan. */
-    memberId: string;
-    /**
-     * 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.
-     *
-     * See [Coupons to learn more](https://dev.wix.com/api/rest/coupons).
-     */
-    couponCode?: string | null;
-    /** Form submission id that was submitted together with the order */
-    submissionId?: string | null;
-}
-export interface CreateOfflineOrderResponse {
-    /** Order. */
-    order?: Order;
-}
-export interface CreateExternalOrderRequest {
-    /** Plan ID. */
-    planId?: string;
-    /** Form submission id that was submitted together with the order */
-    submissionId?: string | null;
-}
-export interface CreateExternalOrderResponse {
-    /** Created order */
-    order?: Order;
-}
-export interface GetOnlineOrderPreviewRequest {
-    /** Plan ID. */
-    planId?: string;
-    /**
-     * Start date for the ordered plan.
-     *
-     * Default: Current date
-     */
-    startDate?: Date;
-    /** Coupon code to apply. */
-    couponCode?: string | null;
-}
-export interface GetOnlineOrderPreviewResponse {
-    /** Will be missing if limit is exceeded */
-    order?: Order;
-    /**
-     * Whether the purchase limit has already been reached for this plan by this member.
-     * Always false for plans without purchase limits.
-     */
-    purchaseLimitExceeded?: boolean;
-}
-export interface GetGuestOnlineOrderPreviewRequest {
-    /** Plan ID. */
-    planId?: string;
-    /**
-     * Start date for the ordered plan.
-     *
-     * Default: Current date
-     */
-    startDate?: Date;
-    /** Coupon code to apply. */
-    couponCode?: string | null;
-    email?: string;
-}
-export interface GetGuestOnlineOrderPreviewResponse {
-    /** Will be missing if limit is exceeded */
-    order?: Order;
-    /**
-     * Whether the purchase limit has already been reached for this plan by this email.
-     * Always false for plans without purchase limits.
-     */
-    purchaseLimitExceeded?: boolean;
-}
-export interface GetOfflineOrderPreviewRequest {
-    /** ID of the plan of the previewed order. See [Plans for more information about plan IDs](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */
-    planId: string;
-    /** Member ID of the buyer the previewed order is for. */
-    memberId: string;
-    /**
-     * Start date and time for plan of the previewed order.
-     *
-     * Default: Current date and time
-     */
-    startDate?: Date;
-    /** Coupon code to apply. See [Coupons to learn more](https://dev.wix.com/api/rest/coupons). */
-    couponCode?: string | null;
-}
-export 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;
-}
-export interface GetPricePreviewRequest {
-    /** ID of plan to preview. */
-    planId: string;
-    /**
-     * Coupon code to apply.
-     *
-     * See Coupons [to learn more](https://dev.wix.com/api/rest/coupons).
-     */
-    couponCode?: string | null;
-}
-export interface GetPricePreviewResponse {
-    /**
-     * @internal
-     * @internal */
-    price?: PriceDetails;
-    /** Pricing details. */
-    prices?: SpannedPrice[];
-}
-export interface ChangeStartDateRequest {
-    /** Draft order ID. */
-    orderId?: string;
-    /** New valid from date (timestamp). */
-    startDate?: Date;
-}
-export interface ChangeStartDateResponse {
-    /** Updated draft order. */
-    order?: Order;
-}
-export interface OrderStartDateChanged {
-    /** Order whose `startDate` changed. */
-    order?: Order;
-}
-export interface ApplyCouponRequest {
-    /** Draft order ID. */
-    orderId?: string;
-    /** Coupon code to apply. */
-    couponCode?: string;
-}
-export interface ApplyCouponResponse {
-    /** Order with applied coupon and recalculated tax. */
-    order?: Order;
-}
-export interface SetSubmissionRequest {
-    orderId?: string;
-    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;
-    fieldSet?: Set;
-}
-export interface GetOrderResponse {
-    /** Order. */
-    order?: Order;
-}
-export interface ListOrdersRequest {
-    /** Filter by a buyer's member ID. See [Members to learn more about a site's members](https://dev.wix.com/api/rest/members/members). */
-    buyerIds?: string[];
-    /** Filter by plan IDs. See [Plans to learn more about pricing plans](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/plans). */
-    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 [Pagination](https://dev.wix.com/api/rest/getting-started/sorting-and-paging#getting-started_sorting-and-paging_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;
-    /** Parameter to define amount of fields to return. FULL returns each order's submission data. Supported values: UNKNOWN_SET, BASIC, FULL */
-    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 {
-    /** [See available fields here](https://dev.wix.com/api/rest/pricing-plans/pricing-plans/order-v2/filter-and-sort). */
-    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 {
-    /** Reason unknown */
-    UNDEFINED = "UNDEFINED",
-    /** Saved in the database but is awaiting payment. Non-active orders cannot be suspended */
-    PENDING = "PENDING",
-    /** Trial orders cannot be suspended */
-    TRIAL = "TRIAL",
-    /** Canceled orders cannot be suspended */
-    CANCELED = "CANCELED",
-    /** Ended orders cannot be suspended */
-    ENDED = "ENDED",
-    /** Paid for orders with future start dates cannot be suspended */
-    NOT_STARTED = "NOT_STARTED",
-    /** Order is already suspended */
-    ALREADY_SUSPENDED = "ALREADY_SUSPENDED",
-    /** Orders based on recurring payments using older Stripe versions cannot be suspended */
-    OLD_STRIPE = "OLD_STRIPE"
-}
-export interface PostponeEndDateRequest {
-    /** Order ID. */
-    _id: string;
-    /**
-     * New end date and time.
-     *
-     * Must be later than the current end date and time.
-     */
-    endDate: Date;
-}
-export interface PostponeEndDateResponse {
-}
-export interface OrderEndDatePostponed {
-    /** Order whose `endDate` was postponed. */
-    order?: Order;
-}
-export interface CancelOrderRequest {
-    /** Order ID. */
-    _id: string;
-    /**
-     * When the order is canceled.
-     *
-     * One time orders can only be canceled immediately. Supported values:
-     * - `"IMMEDIATELY"`: The order is canceled immediately.
-     * - `"NEXT_PAYMENT_DATE"`: The order is canceled at the next payment date.
-     */
-    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 {
-    results?: BulkOrderResult[];
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkOrderResult {
-    itemMetadata?: ItemMetadata;
-    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 {
-}
-export interface OrderResumed {
-    /** Resumed order. */
-    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 {
-    results?: BulkOrderResult[];
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface MemberGetOrderResponseNonNullableFields {
-    order?: {
-        _id: string;
-        planId: string;
-        subscriptionId: string;
-        buyer?: {
-            memberId: string;
-            contactId: string;
-        };
-        priceDetails?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-    };
-}
-export interface MemberListOrdersResponseNonNullableFields {
-    orders: {
-        _id: string;
-        planId: string;
-        subscriptionId: string;
-        buyer?: {
-            memberId: string;
-            contactId: string;
-        };
-        priceDetails?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-    }[];
-}
-export interface CreateOfflineOrderResponseNonNullableFields {
-    order?: {
-        _id: string;
-        planId: string;
-        subscriptionId: string;
-        buyer?: {
-            memberId: string;
-            contactId: string;
-        };
-        priceDetails?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-    };
-}
-export interface GetOfflineOrderPreviewResponseNonNullableFields {
-    order?: {
-        _id: string;
-        planId: string;
-        subscriptionId: string;
-        buyer?: {
-            memberId: string;
-            contactId: string;
-        };
-        priceDetails?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-}
-export interface GetPricePreviewResponseNonNullableFields {
-    price?: {
-        subscription?: {
-            cycleDuration?: {
-                unit: PeriodUnit;
-            };
-        };
-        singlePaymentForDuration?: {
-            unit: PeriodUnit;
-        };
-        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;
-        };
-    }[];
-}
-export interface GetOrderResponseNonNullableFields {
-    order?: {
-        _id: string;
-        planId: string;
-        subscriptionId: string;
-        buyer?: {
-            memberId: string;
-            contactId: string;
-        };
-        priceDetails?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-    };
-}
-export interface ListOrdersResponseNonNullableFields {
-    orders: {
-        _id: string;
-        planId: string;
-        subscriptionId: string;
-        buyer?: {
-            memberId: string;
-            contactId: string;
-        };
-        priceDetails?: {
-            subscription?: {
-                cycleDuration?: {
-                    unit: PeriodUnit;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-                };
-            };
-            singlePaymentForDuration?: {
-                unit: PeriodUnit;
-            };
-            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;
-    }[];
-}
-export declare const onOrderCanceled: EventDefinition<DomainActionEvent<OrderCanceled>, "wix.pricing_plans.v2.order_canceled">;
-export declare const onOrderCreated: EventDefinition<DomainCreatedEvent<Order>, "wix.pricing_plans.v2.order_created">;
-export declare const onOrderUpdated: EventDefinition<DomainUpdatedEvent<Order>, "wix.pricing_plans.v2.order_updated">;
-export declare const onOrderStartDateChanged: EventDefinition<DomainActionEvent<OrderStartDateChanged>, "wix.pricing_plans.v2.order_start_date_changed">;
-export declare const onOrderPurchased: EventDefinition<DomainActionEvent<OrderPurchased>, "wix.pricing_plans.v2.order_purchased">;
-export declare const onOrderStarted: EventDefinition<DomainActionEvent<OrderStarted>, "wix.pricing_plans.v2.order_started">;
-export declare const onOrderCycleStarted: EventDefinition<DomainActionEvent<OrderCycleStarted>, "wix.pricing_plans.v2.order_cycle_started">;
-export declare const onOrderAutoRenewCanceled: EventDefinition<DomainActionEvent<OrderAutoRenewCanceled>, "wix.pricing_plans.v2.order_auto_renew_canceled">;
-export declare const onOrderEnded: EventDefinition<DomainActionEvent<OrderEnded>, "wix.pricing_plans.v2.order_ended">;
-export declare const onOrderEndDatePostponed: EventDefinition<DomainActionEvent<OrderEndDatePostponed>, "wix.pricing_plans.v2.order_end_date_postponed">;
-export declare const onOrderMarkedAsPaid: EventDefinition<DomainActionEvent<OrderMarkedAsPaid>, "wix.pricing_plans.v2.order_marked_as_paid">;
-export declare const onOrderPaused: EventDefinition<DomainActionEvent<OrderPaused>, "wix.pricing_plans.v2.order_paused">;
-export declare const onOrderResumed: EventDefinition<DomainActionEvent<OrderResumed>, "wix.pricing_plans.v2.order_resumed">;
-/**
- * Gets an order by ID for the currently logged-in member.
- *
- * The `memberGetOrder()` function returns a Promise that resolves to information about a specified order for the currently logged-in member.
- * @param _id - Order ID.
- * @public
- * @requiredField _id
- * @param options - Options for getting a logged-in member's order.
- * @applicableIdentity MEMBER
- * @returns Requested order.
- */
-export declare function memberGetOrder(_id: string, options?: MemberGetOrderOptions): Promise<Order & NonNullable<MemberGetOrderResponseNonNullableFields>['order']>;
-export interface MemberGetOrderOptions {
-    fieldSet?: Set;
-}
-/**
- * Lists orders for the currently logged-in member.
- *
- * The `memberListOrders()` function returns a Promise that resolves to a list of up to 100 pricing plan orders.
- * @public
- * @documentationMaturity preview
- * @param options - Filtering, sorting, and pagination options.
- * @applicableIdentity MEMBER
- */
-export declare function memberListOrders(options?: MemberListOrdersOptions): Promise<MemberListOrdersResponse & MemberListOrdersResponseNonNullableFields>;
-export 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;
-}
-/**
- * Starts the process of canceling an order.
- *
- *
- * The `requestCancellation()` function returns a Promise that resolves when the order cancellation is successfully requested.
- *
- * For orders with recurring payments, a cancellation can be set to occur either immediately or at the next payment date. For orders with one-time payments, a cancellation occurs immediately after the request is processed.
- *
- * Requesting an order cancellation starts the cancellation process. There may be some operations that continue to be processed before the status of the order is changed to `"CANCELED"`. For example, payments might need to be refunded before the order is fully canceled.
- *
- * #### Canceling during the free trial period.
- *
- * When a buyer cancels their order during the free trial period, the buyer's subscription expires at the end of the free trial period and they won't be billed. The buyer may continue using the benefits until the end of the free trial period.
- *
- * @param _id - Order ID.
- * @param effectiveAt - Whether to cancel the order immediately or at the next payment date.
- * One-time payment orders can only be canceled immediately.
- *
- * Supported values:
- * - `"IMMEDIATELY"`: Indicates that the order should be canceled immediately.
- * - `"NEXT_PAYMENT_DATE"`: Indicates that the order be canceled at the next payment date.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField effectiveAt
- * @param options - Options for requesting a cancellation.
- * @applicableIdentity MEMBER
- * @returns Fulfilled - When the cancellation process is started.
- */
-export declare function requestCancellation(_id: string, effectiveAt: CancellationEffectiveAt): Promise<void>;
-/**
- * Creates an order for a buyer who purchased the plan with an offline transaction.
- *
- * The `createOfflineOrder()` function returns a Promise that resolves to an `order` object when the order has been created.
- *
- * Payment of an offline order is handled in 1 of 2 ways.
- * - When creating the order, select `true` in the `paid` request parameter.
- * - After creation, with the [`markAsPaid()`](#markaspaid) function.
- *
- * When creating a non-free offline order:
- * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
- * The order's last payment status is set to `"UNPAID"` or `"PAID"`.
- *
- * When creating a free offline order:
- * - The order's status is set to `"PENDING"` if the start date is in the future. Otherwise, the status is set to `"ACTIVE"`.
- * - The order's last payment status is set to `"NOT_APPLICABLE"`.
- * @param memberId - ID of the member ordering the plan.
- * @public
- * @documentationMaturity preview
- * @requiredField memberId
- * @requiredField planId
- * @param options - Options for creating an offline order.
- * @param planId - ID of the plan being ordered. See [Plans for more information about plan IDs](plans)
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @applicableIdentity APP
- * @returns Fulfilled - The order of the plan.
- */
-export declare function createOfflineOrder(planId: string, memberId: string, options?: CreateOfflineOrderOptions): Promise<CreateOfflineOrderResponse & CreateOfflineOrderResponseNonNullableFields>;
-export 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;
-}
-/**
- * Provides a preview of an offline order as if it was purchased.
- *
- * The `getOfflineOrderPreview()` function returns a Promise that resolves to a temporary preview of the offline order.
- *
- * The preview uses the same logic as purchasing a plan, but the preview is not saved. Because an order is not actually created, the preview's `_id` and `subscriptionId` properties are displayed as a string of multiple zero characters (`000000-0000`).
- *
- * If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, `tax` previews as `null`.
- *
- * You can preview the order to check purchase limitations, but the limitations are not enforced for the preview. If a pricing plan has a limit on the amount of purchases per buyer, that limit is not considered for generating the preview. But, if that limit has been reached and this order would then exceed the amount of purchases permitted for this buyer, then `purchaseLimitExceeded` will return as `true`. Thus function is not available to the buyer. You specify the member ID for the buyer whose order should be previewed. To get a general price preview for a plan that's not buyer-specific, use the [`getPricePreview()`](#getpricepreview) function.
- * @param memberId - Member ID of the buyer the previewed order is for.
- * @public
- * @documentationMaturity preview
- * @requiredField memberId
- * @requiredField planId
- * @param options - Options for previewing the offline order.
- * @param planId - ID of the plan of the previewed order.
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @applicableIdentity APP
- * @returns Fulfilled - A preview of the order.
- */
-export declare function getOfflineOrderPreview(planId: string, memberId: string, options?: GetOfflineOrderPreviewOptions): Promise<GetOfflineOrderPreviewResponse & GetOfflineOrderPreviewResponseNonNullableFields>;
-export 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;
-}
-/**
- * Retrieves a preview of an order's pricing as if it was purchased.
- *
- * The `getPricePreview()` function returns a Promise that resolves to a temporary preview of the order's price.
- *
- * The price preview uses the same logic for calculating prices as used when purchasing a plan, but the preview is not saved. If [taxes are configured](https://support.wix.com/en/article/pricing-plans-setting-up-tax-collection) for the site, taxes are applied to the preview. If not, the `tax` previews as `null`.
- *
- * Buyers do not have to be logged in to preview the price, as such, the details returned by this function are not buyer-specific. To generate a preview of a purchase for a specific-buyer, use the [`getOfflineOrderPreview()`](#getofflineorderpreview).
- * @param planId - ID of plan to preview.
- * @public
- * @documentationMaturity preview
- * @requiredField planId
- * @param options - Options for getting a price preview.
- * @permissionScope Read Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-PLANS
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
- * @permissionScope Manage Pricing Plans
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-PLANS
- * @applicableIdentity APP
- * @applicableIdentity MEMBER
- * @applicableIdentity VISITOR
- * @returns Fulfilled - A preview of the pricing for the order.
- */
-export declare function getPricePreview(planId: string, options?: GetPricePreviewOptions): Promise<GetPricePreviewResponse & GetPricePreviewResponseNonNullableFields>;
-export interface GetPricePreviewOptions {
-    /** Coupon code to apply.  */
-    couponCode?: string | null;
-}
-/**
- * Retrieves an order by ID.
- *
- * The `managementGetOrder()` function returns a Promise that resolves to information about the specified order.
- * @param _id - Order ID.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @param options - Options to use when getting an order.
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
- * @applicableIdentity APP
- */
-export declare function managementGetOrder(_id: string, options?: ManagementGetOrderOptions): Promise<GetOrderResponse & GetOrderResponseNonNullableFields>;
-export interface ManagementGetOrderOptions {
-    fieldSet?: Set;
-}
-/**
- * Lists pricing plan orders.
- *
- * The `managementListOrders()` function returns a Promise that resolves to a list of up to 50 pricing plan orders. You can specify options for filtering, sorting, and paginating the results.
- *
- * This function returns the orders on the site. To list orders for the currently logged-in member, use [`memberListOrders()`](#memberlistorders).
- * @public
- * @documentationMaturity preview
- * @param options - Filtering, sorting, and pagination options.
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @permissionScope Manage Bookings Services and Settings
- * @permissionScopeId SCOPE.BOOKINGS.CONFIGURATION
- * @permissionScope Read Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.READ-ORDERS
- * @applicableIdentity APP
- */
-export declare function managementListOrders(options?: ManagementListOrdersOptions): Promise<ListOrdersResponse & ListOrdersResponseNonNullableFields>;
-export 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;
-}
-/**
- * Extends the duration of a pricing plan order by postponing the order's `endDate`.
- *
- * The `postponeEndDate()` function returns a Promise that resolves when the order's end date is successfully changed.
- *
- * The new end date and time must be later than the order's current `endDate`.
- *
- * Postponing the end date of an order does not impact payments. For example, if the pricing plan is for a membership to an online lecture series, and you want to extend the duration of the series because the lecturer could not attend some sessions, you can postpone the end date of the orders for all relevant participants. The participants will not be billed additionally.
- *
- * Postponing an order causes the following changes:
- * - The `endDate` for the order is adjusted to the new end date.
- * @param _id - Order ID.
- * @param endDate - New end date and time.
- *
- * Must be later than the current end date and time.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField endDate
- * @param options - Options for postponing the end date of an order.
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @applicableIdentity APP
- * @returns Fulfilled - When the order's end date has been postponed or made earlier.
- *
- *
- */
-export declare function postponeEndDate(_id: string, endDate: Date): Promise<void>;
-/**
- * Cancels an existing order.
- *
- * The `cancelOrder()` function returns a Promise that resolves when the order is successfully canceled.
- *
- * For orders with recurring payments, a cancellation can be set to occur either `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
- * For orders with one-time payments, a cancellation occurs `IMMEDIATELY`.
- *
- * Canceling an order changes the order status to `CANCELED`.
- *
- * #### Canceling during the free trial period.
- *
- * When a site owner cancels an ordered plan during the free trial period, they choose to apply the cancellation `IMMEDIATELY` or at the `NEXT_PAYMENT_DATE`.
- *
- * Canceling `IMMEDIATELY` will end the subscription for the buyer
- * immediately, even during the free trial period and the buyer won't be billed.
- *
- * Canceling at the `NEXT_PAYMENT_DATE` allows the buyer to continue using the benefits of the subscription until the end of the free trial period. Then, the subscription ends and the buyer is not billed.
- * @param _id - Order ID.
- * @param effectiveAt - When the order is canceled.
- *
- * One time orders can only be canceled immediately. Supported values:
- * - `"IMMEDIATELY"`: The order is canceled immediately.
- * - `"NEXT_PAYMENT_DATE"`: The order is canceled at the next payment date.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @requiredField effectiveAt
- * @param options - Options for canceling orders.
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @applicableIdentity APP
- * @returns Fulfilled - When the order is canceled.
- */
-export declare function cancelOrder(_id: string, effectiveAt: CancellationEffectiveAt): Promise<void>;
-/**
- * Marks an offline order as paid.
- *
- * The `markAsPaid()` function returns a Promise that resolves when the offline order is successfully marked as paid.
- *
- * The entire order is marked as paid, even if the order's payments are recurring.
- *
- * >**Note:** Marking separate payment cycles as paid is not yet supported. Subsequent offline payments do trigger events and emails, but are not registered as additional offline payments.
- *
- * Marking an offline order as paid causes the following changes:
- * - The order's `lastPaymentStatus` changes to `"PAID"`.
- * - The order's status changes to either `"PENDING"` or `"ACTIVE"`, depending on the order's `startDate`.
- *
- * An error occurs if you attempt to:
- * - Mark an already-paid, offline order as paid. You cannot make an offline order as paid twice.
- * - Mark an online order as paid. The `markAsPaid()` function is supported for offline orders only.
- * @param _id - Order ID.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @applicableIdentity APP
- * @returns Fulfilled - When the order is marked as paid.
- */
-export declare function markAsPaid(_id: string): Promise<void>;
-/**
- * Pauses a pricing plan order.
- *
- * The `pauseOrder()` function returns a Promise that resolves when the order is successfully paused.
- *
- * For orders with recurring payments, `pauseOrder()` also pauses the payment schedule. Buyers are not charged when an order is paused. Use `pauseOrder()`, for example, if the buyer is away and would like to put their pricing plan membership on hold until they return. Pausing an order affects the end date of the order by adding the time the order is paused to the `endDate`. You can only pause orders with an `"ACTIVE`" status.
- *
- * Pausing an order causes the following changes:
- * - The order status changes to `"PAUSED"`.
- * - The `pausePeriods` array is updated.
- *
- * The `endDate` and the `earliestEndDate` for the order are adjusted to include the pause period when the order is resumed.
- *
- * Paused orders can be continued with the [`resumeOrder()`](#resumeorder) function.
- * @param _id - Order ID.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @applicableIdentity APP
- * @returns Fulfilled - When the order is paused.
- */
-export declare function pauseOrder(_id: string): Promise<void>;
-/**
- * Resumes a paused pricing plan order.
- *
- * The `resumeOrder()` function returns a Promise that resolves when a paused order is successfully resumed.
- *
- * For orders with recurring payments, `resumeOrder()` also restarts the payment schedule.
- *
- * Resuming an order causes the following changes:
- * - The order status changes to `"ACTIVE"`.
- * - The `pausePeriods` array is updated.
- * - The `endDate` for the order is adjusted to include the pause period.
- * - The `earliestEndDate` is adjusted to include the pause period. (This property is reserved for future use).
- * @param _id - Order ID.
- * @public
- * @documentationMaturity preview
- * @requiredField _id
- * @permissionScope Manage Orders
- * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
- * @applicableIdentity APP
- * @returns Fulfilled - When the order is resumed.
- */
-export declare function resumeOrder(_id: string): Promise<void>;