@wix/auto_sdk_pricing-plans_orders 1.0.57 → 1.0.59

package/build/meta.d.ts

@@ -0,0 +1,982 @@
+import { al as GetOrderRequest$1, G as GetOrderResponse$1, am as ListOrdersRequest$1, L as ListOrdersResponse$1, aA as PostponeEndDateRequest$1, aB as PostponeEndDateResponse$1, aD as CancelOrderRequest$1, aE as CancelOrderResponse$1, aG as MarkAsPaidRequest$1, aH as MarkAsPaidResponse$1, aJ as PauseOrderRequest$1, aK as PauseOrderResponse$1, aS as ResumeOrderRequest$1, aT as ResumeOrderResponse$1, a_ as MemberGetOrderRequest$1, a$ as MemberGetOrderResponse$1, b0 as MemberListOrdersRequest$1, d as MemberListOrdersResponse$1, b3 as RequestCancellationRequest$1, b4 as RequestCancellationResponse$1, b5 as CreateOnlineOrderRequest$1, f as CreateOnlineOrderResponse$1, bc as CreateOfflineOrderRequest$1, h as CreateOfflineOrderResponse$1, bf as GetOnlineOrderPreviewRequest$1, j as GetOnlineOrderPreviewResponse$1, bi as GetOfflineOrderPreviewRequest$1, l as GetOfflineOrderPreviewResponse$1, bj as GetPricePreviewRequest$1, n as GetPricePreviewResponse$1 } from './pricing-plans-v2-order-orders.universal-Bwx6oqbS.js';
+
+/**
+ * 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.
+ * Learn more about pricing models ([REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/introduction#pricing-models)).
+ */
+interface Order {
+    /**
+     * Order ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string;
+    /**
+     * ID of the plan purchased with the order, from the Plans API.
+     * @format GUID
+     * @readonly
+     */
+    planId?: string;
+    /**
+     * ID of the related Wix subscription.
+     *
+     * Every pricing plan order corresponds to a Wix subscription, including orders for single payment plans. Learn more in
+     * a [Pricing Plans overview](https://support.wix.com/en/article/pricing-plans-an-overview#create-plans-to-suit-your-business).
+     * @format GUID
+     * @readonly
+     */
+    subscriptionId?: string;
+    /**
+     * Wix Pay order ID.
+     *
+     * Provided by Wix whether the order is created online or offline. The field is omitted when the order is free.
+     * @format GUID
+     * @readonly
+     */
+    wixPayOrderId?: string | null;
+    /**
+     * 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;
+    /**
+     * __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
+     * @readonly
+     * @deprecated __Deprecated.__ Use `pricing` instead. This property will be removed on September 30, 2022.
+     * @replacedBy pricing
+     * @targetRemovalDate 2022-10-01
+     */
+    priceDetails?: PriceDetails;
+    /**
+     * Order pricing model, price, and payment schedule.
+     *
+     * Learn more about pricing models ([REST](https://dev.wix.com/api/rest/wix-pricing-plans/pricing-plans/introduction#wix-pricing-plans_pricing-plans_introduction_pricing-models) | [SDK](https://dev.wix.com/docs/sdk/backend-modules/pricing-plans/introduction#pricing-models)).
+     * @readonly
+     */
+    pricing?: PricingDetails;
+    /**
+     * How the order was processed.
+     * @readonly
+     */
+    type?: OrderTypeWithLiterals;
+    /**
+     * Status of the order.
+     * @readonly
+     */
+    status?: OrderStatusWithLiterals;
+    /**
+     * 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.
+     *
+     * Only present if the status is `CANCELED`.
+     * @readonly
+     */
+    cancellation?: Cancellation;
+    /**
+     * Status of the last payment for the order.
+     * Updated automatically for online orders. Updated manually by the Wix user for offline orders.
+     * @readonly
+     */
+    lastPaymentStatus?: PaymentStatusWithLiterals;
+    /**
+     * Start date and time for the ordered plan.
+     * @readonly
+     */
+    startDate?: Date | null;
+    /**
+     * Current end date and time for the ordered plan.
+     *
+     * `endDate` may be updated over the course of an order.
+     * If the order is paused, it will have a later `endDate` once it is resumed.
+     * `endDate` may also be postponed.
+     *
+     * Omitted if the order is valid until canceled and still `ACTIVE`.
+     * @readonly
+     */
+    endDate?: Date | null;
+    /**
+     * 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
+     * @min 1
+     * @max 999
+     */
+    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 | null;
+    /**
+     * 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.
+     * @format DECIMAL_VALUE
+     * @readonly
+     */
+    planPrice?: string;
+    /**
+     * Date and time the order was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the order was updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /**
+     * Information about the form submitted during the plan's checkout.
+     * @readonly
+     */
+    formData?: FormData;
+}
+interface Buyer {
+    /**
+     * Member ID for a Wix site member, from the Members API.
+     * @format GUID
+     * @readonly
+     */
+    memberId?: string;
+    /**
+     * Contact ID for a Wix site contact, from the Contacts API.
+     * @format GUID
+     * @readonly
+     */
+    contactId?: string;
+}
+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"`.
+     * @format DECIMAL_VALUE
+     */
+    subtotal?: string;
+    /**
+     * Total discount applied.
+     * @format DECIMAL_VALUE
+     */
+    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`.
+     * @format DECIMAL_VALUE
+     */
+    total?: string;
+    /**
+     * Plan price as it was at the moment of order creation.
+     * @format DECIMAL_VALUE
+     */
+    planPrice?: string;
+    /**
+     * Currency code. Must be valid ISO 4217 currency code (e.g., USD).
+     * @format CURRENCY
+     */
+    currency?: string;
+    /**
+     * Free trial period for the order in days. Only available for recurring plans.
+     * @min 1
+     * @max 999
+     */
+    freeTrialDays?: number | null;
+    /** Coupon applied to the order. Empty means no coupon was applied. */
+    coupon?: Coupon;
+}
+/** @oneof */
+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;
+}
+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"`.
+     * @format DECIMAL_VALUE
+     */
+    rate?: string;
+    /**
+     * Total tax, specified as a monetary amount. For example, `"3.99"`.
+     * @format DECIMAL_VALUE
+     */
+    amount?: string;
+}
+/** An object specifying how often and for how long payments recur (may be forever). */
+interface Recurrence {
+    /**
+     * Number of payment cycles the subscription is valid for.
+     * `0` for unlimited plans or for plans that are valid until canceled.
+     */
+    cycleDuration?: Duration;
+    /**
+     * Length of a payment cycle. For example, 1 month to have monthly payments.
+     * Multiply `cycleDuration`'s `count` by `cycleCount` to get the subscription duration.
+     * Currently, only a value of `1` is supported.
+     * @max 2000
+     */
+    cycleCount?: number | null;
+}
+/** A duration expressed in number of time units. */
+interface Duration {
+    /**
+     * Number of days, months, weeks, or years in a single payment cycle. Currently limited to support only `1`.
+     * @min 1
+     */
+    count?: number | null;
+    /** Unit of time for the cycle duration. */
+    unit?: PeriodUnitWithLiterals;
+}
+declare enum PeriodUnit {
+    /** Not defined. */
+    UNDEFINED = "UNDEFINED",
+    /** Time unit is a day. */
+    DAY = "DAY",
+    /** Time unit is a week. */
+    WEEK = "WEEK",
+    /** Time unit is a month. */
+    MONTH = "MONTH",
+    /** Time unit is a year. */
+    YEAR = "YEAR"
+}
+/** @enumType */
+type PeriodUnitWithLiterals = PeriodUnit | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
+interface Coupon {
+    /**
+     * Code of the applied coupon.
+     * @minLength 1
+     * @maxLength 20
+     */
+    code?: string;
+    /**
+     * Total discount of the coupon, as a monetary amount.
+     * @format DECIMAL_VALUE
+     */
+    amount?: string;
+    /**
+     * Coupon ID.
+     * @format GUID
+     * @readonly
+     */
+    id?: string;
+}
+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 */
+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;
+}
+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"`.
+     * @format DECIMAL_VALUE
+     */
+    subtotal?: string;
+    /** Coupon applied to the order, from the Coupons API. */
+    coupon?: Coupon;
+    /**
+     * Total discount applied to the order.
+     * @format DECIMAL_VALUE
+     */
+    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`.
+     * @format DECIMAL_VALUE
+     */
+    total?: string;
+    /**
+     * Three-letter currency code in
+     * [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
+     * @format CURRENCY
+     */
+    currency?: string;
+    /**
+     * Price change after billing date was change and price was adjusted. Could be positive and negative values.
+     * @format DECIMAL_VALUE
+     */
+    proration?: string;
+}
+declare enum OrderType {
+    /** Undefined order type. */
+    UNDEFINED = "UNDEFINED",
+    /** The buyer purchased the plan using the site. */
+    ONLINE = "ONLINE",
+    /** The buyer made a manual, offline purchase without using the site. */
+    OFFLINE = "OFFLINE",
+    /** The buyer made a purchase through an external payment provider. */
+    EXTERNAL = "EXTERNAL"
+}
+/** @enumType */
+type OrderTypeWithLiterals = OrderType | 'UNDEFINED' | 'ONLINE' | 'OFFLINE' | 'EXTERNAL';
+declare enum OrderMethod {
+    /** Unknown order method. */
+    UNKNOWN = "UNKNOWN",
+    /** Mail Order / Telephone Order transaction. */
+    MOTO = "MOTO",
+    /** Point of Sale transaction. */
+    POS = "POS"
+}
+/** @enumType */
+type OrderMethodWithLiterals = OrderMethod | 'UNKNOWN' | 'MOTO' | 'POS';
+declare enum OrderStatus {
+    /** Undefined order status. */
+    UNDEFINED = "UNDEFINED",
+    /** Order has been initiated but payment hasn't been processed yet. The plan isn't yet available for use to the buyer. */
+    DRAFT = "DRAFT",
+    /** Order has been purchased and its start date is set in the future. */
+    PENDING = "PENDING",
+    /** Order has been processed. The plan is available for use. */
+    ACTIVE = "ACTIVE",
+    /** Order, and use of the plan, is paused. The order, and use of the plan, can be resumed. */
+    PAUSED = "PAUSED",
+    /** Order has completed its duration and is no longer available for use. */
+    ENDED = "ENDED",
+    /** Order has been canceled. */
+    CANCELED = "CANCELED"
+}
+/** @enumType */
+type OrderStatusWithLiterals = OrderStatus | 'UNDEFINED' | 'DRAFT' | 'PENDING' | 'ACTIVE' | 'PAUSED' | 'ENDED' | 'CANCELED';
+interface Cancellation {
+    /** Date and time the cancellation was requested. */
+    requestedDate?: Date | null;
+    /** Reason for the cancellation. */
+    cause?: CancellationCauseWithLiterals;
+    /** When the cancellation takes effect. Set when cancelling the order. */
+    effectiveAt?: CancellationEffectiveAtWithLiterals;
+}
+declare enum CancellationCause {
+    /** Undefined cancellation cause. */
+    UNDEFINED = "UNDEFINED",
+    /** Wix user canceled the order. */
+    OWNER_ACTION = "OWNER_ACTION",
+    /** Buyer initiated the cancellation. */
+    MEMBER_ACTION = "MEMBER_ACTION",
+    /** Payment transaction failed. */
+    PAYMENT_FAILURE = "PAYMENT_FAILURE",
+    /** Buyer's payment details weren't set up correctly. */
+    PAYMENT_SETUP_FAILURE = "PAYMENT_SETUP_FAILURE",
+    /** Reason for the cancellation is unknown. */
+    UNKNOWN = "UNKNOWN"
+}
+/** @enumType */
+type CancellationCauseWithLiterals = CancellationCause | 'UNDEFINED' | 'OWNER_ACTION' | 'MEMBER_ACTION' | 'PAYMENT_FAILURE' | 'PAYMENT_SETUP_FAILURE' | 'UNKNOWN';
+declare enum CancellationEffectiveAt {
+    /** Undefined cancellation time. */
+    UNDEFINED = "UNDEFINED",
+    /** Cancellation occurs immediately and the buyer can no longer use the plan. */
+    IMMEDIATELY = "IMMEDIATELY",
+    /** Cancellation occurs at the next payment date and time. Buyer can continue to use the plan until that date and time. */
+    NEXT_PAYMENT_DATE = "NEXT_PAYMENT_DATE"
+}
+/** @enumType */
+type CancellationEffectiveAtWithLiterals = CancellationEffectiveAt | 'UNDEFINED' | 'IMMEDIATELY' | 'NEXT_PAYMENT_DATE';
+declare enum PaymentStatus {
+    /** Undefined payment status. */
+    UNDEFINED = "UNDEFINED",
+    /** Payment has been paid. */
+    PAID = "PAID",
+    /** Payment has been refunded. */
+    REFUNDED = "REFUNDED",
+    /** Payment transaction didn't complete. */
+    FAILED = "FAILED",
+    /** Payment has not been paid. */
+    UNPAID = "UNPAID",
+    /** Billing has been initialized, but actual charge is yet to be made. This can happen for free trials and payments made with PayPal. */
+    PENDING = "PENDING",
+    /** No payment was necessary. For example, for free plans or free trials. */
+    NOT_APPLICABLE = "NOT_APPLICABLE"
+}
+/** @enumType */
+type PaymentStatusWithLiterals = PaymentStatus | 'UNDEFINED' | 'PAID' | 'REFUNDED' | 'FAILED' | 'UNPAID' | 'PENDING' | 'NOT_APPLICABLE';
+interface PausePeriod {
+    /** Status of the pause period. */
+    status?: StatusWithLiterals;
+    /** Start date and time of the pause period. */
+    pauseDate?: Date | null;
+    /**
+     * End date and time of the pause period.
+     *
+     * Omitted while the pause period remains `ACTIVE`.
+     */
+    resumeDate?: Date | null;
+}
+declare enum Status {
+    /** Undefined status. */
+    UNDEFINED = "UNDEFINED",
+    /** Status while the order is paused. */
+    ACTIVE = "ACTIVE",
+    /** Status when the order is resumed. */
+    ENDED = "ENDED"
+}
+/** @enumType */
+type StatusWithLiterals = Status | 'UNDEFINED' | 'ACTIVE' | '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 | null;
+    /** End date and time for the current payment cycle. */
+    endedDate?: Date | null;
+}
+interface FormData {
+    /**
+     * ID of the order form ([REST](https://dev.wix.com/docs/rest/api-reference/wix-forms/form-submissions/introduction)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/forms/submissions/introduction)) associated with the plan at checkout.
+     * @format GUID
+     */
+    formId?: string | null;
+    /**
+     * ID of a submission to the plan's order form at checkout. Every time a visitor completes the checkout process for a plan, a new submission is created.
+     * @format GUID
+     */
+    submissionId?: string | null;
+    /**
+     * Data submitted to the plan's order form at checkout.
+     * @readonly
+     */
+    submissionData?: Record<string, any>;
+}
+interface GetOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+declare enum Set {
+    /** Same behavior as `BASIC`.` */
+    UNKNOWN_SET = "UNKNOWN_SET",
+    /** Doesn't return any order form submission data. */
+    BASIC = "BASIC",
+    /** Returns all order form submission data. */
+    FULL = "FULL"
+}
+/** @enumType */
+type SetWithLiterals = Set | 'UNKNOWN_SET' | 'BASIC' | 'FULL';
+interface GetOrderResponse {
+    /** Order. */
+    order?: Order;
+}
+interface ListOrdersRequest {
+    /**
+     * Filter by a buyer's member ID, from the Members API.
+     * @format GUID
+     */
+    buyerIds?: string[];
+    /**
+     * Filter by plan IDs, from the Plans API.
+     * @format GUID
+     */
+    planIds?: string[];
+    /** Filter by whether or not the auto-renewal of recurring orders was canceled. */
+    autoRenewCanceled?: boolean | null;
+    /** Filter by order status. */
+    orderStatuses?: OrderStatusWithLiterals[];
+    /** Filter by payment status. */
+    paymentStatuses?: PaymentStatusWithLiterals[];
+    /**
+     * Number of orders to return. See Sorting and Paging for more information.
+     *
+     * Max: `50`
+     * @min 1
+     * @max 50
+     */
+    limit?: number | null;
+    /** Number of orders to skip in the current sort order. */
+    offset?: number | null;
+    /**
+     * Sort order.
+     *
+     * Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `DESC`.
+     */
+    sorting?: Sorting;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface ListOrdersResponse {
+    /** List of orders. */
+    orders?: Order[];
+    /** Object containing paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface PostponeEndDateRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+    /**
+     * New end date and time.
+     *
+     * Must be later than the current end date and time.
+     */
+    endDate: Date | null;
+}
+interface PostponeEndDateResponse {
+}
+interface CancelOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+    /** __Required.__ When the order will be canceled. One-time orders can only be canceled `IMMEDIATELY`. */
+    effectiveAt: CancellationEffectiveAtWithLiterals;
+}
+interface CancelOrderResponse {
+}
+interface MarkAsPaidRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+}
+interface MarkAsPaidResponse {
+}
+interface PauseOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+}
+interface PauseOrderResponse {
+}
+interface ResumeOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+}
+interface ResumeOrderResponse {
+}
+interface MemberGetOrderRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+interface MemberGetOrderResponse {
+    /** Requested order. */
+    order?: Order;
+}
+interface MemberListOrdersRequest {
+    /**
+     * Filter by plan IDs.
+     * @format GUID
+     */
+    planIds?: string[];
+    /** Filter for orders where auto renewal was canceled. */
+    autoRenewCanceled?: boolean | null;
+    /** Filter by order status. */
+    orderStatuses?: OrderStatusWithLiterals[];
+    /** Filter by payment status. */
+    paymentStatuses?: PaymentStatusWithLiterals[];
+    /**
+     * Limit the number of pricing plans returned. Default limit is 50.
+     * @min 1
+     * @max 50
+     */
+    limit?: number | null;
+    /** Number of entries to offset. */
+    offset?: number | null;
+    /** Sorting direction (defaults to ASC) and field to sort by. */
+    sorting?: Sorting;
+    /**
+     * Predefined set of fields to return.
+     *
+     * Default: If `fieldSet` is omitted, no order form submission data is returned.
+     */
+    fieldSet?: SetWithLiterals;
+}
+interface MemberListOrdersResponse {
+    /** Requested orders. */
+    orders?: Order[];
+    /** Object containing paging-related data (number of orders returned, offset). */
+    pagingMetadata?: PagingMetadataV2;
+}
+interface RequestCancellationRequest {
+    /**
+     * Order ID.
+     * @format GUID
+     */
+    id: string;
+    /** Required. Whether to cancel the order effective immediately or at the next payment date. One-time orders can only be canceled immediately. */
+    effectiveAt: CancellationEffectiveAtWithLiterals;
+}
+interface RequestCancellationResponse {
+}
+interface CreateOnlineOrderRequest {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Start date and time for the plan of the online order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     *
+     * Default: Current date and time.
+     */
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /** Provided if checkout is initiated on buyer's behalf. */
+    onBehalf?: OnBehalf;
+    /**
+     * Submission ID of the form submitted with this order.
+     * @format GUID
+     */
+    submissionId?: string | null;
+}
+interface OnBehalf {
+    /**
+     * Member ID.
+     * @format GUID
+     */
+    memberId?: string;
+    /** Method by which checkout is initiated. */
+    orderMethod?: OrderMethodWithLiterals;
+}
+interface CreateOnlineOrderResponse {
+    /** Created online order. */
+    order?: Order;
+}
+interface CreateOfflineOrderRequest {
+    /**
+     * ID of the plan being ordered, from the Plans API.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * ID of the member ordering the plan, from the Members API.
+     * @format GUID
+     */
+    memberId: string;
+    /**
+     * Start date and time for the ordered plan in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     *
+     * Default: Current date and time.
+     */
+    startDate?: Date | null;
+    /**
+     * Whether the order is paid.
+     *
+     * Default: `false`
+     */
+    paid?: boolean | null;
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+    /**
+     * Form submission ID that was submitted with the order.
+     * @format GUID
+     */
+    submissionId?: string | null;
+}
+interface CreateOfflineOrderResponse {
+    /** Order. */
+    order?: Order;
+}
+interface GetOnlineOrderPreviewRequest {
+    /**
+     * Plan ID.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Start date and time for the plan of the order preview in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     *
+     * Default: Current date and time.
+     */
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+}
+interface GetOnlineOrderPreviewResponse {
+    /** Order preview. This field is undefined if the member has already reached the purchase limit for the order's plan. */
+    order?: Order;
+    /** Whether the member has already reached purchase limit for the order's plan. */
+    purchaseLimitExceeded?: boolean;
+}
+interface GetOfflineOrderPreviewRequest {
+    /**
+     * ID of the plan of the previewed order, from the Plans API.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Member ID of the buyer the previewed order is for, from the Members API.
+     * @format GUID
+     */
+    memberId: string;
+    /**
+     * Start date and time for plan of the previewed order in a `YYYY-MM-DDThh:mm[:ss][.sss]Z` format.
+     *
+     * Default: Current date and time.
+     */
+    startDate?: Date | null;
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+}
+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 GetPricePreviewRequest {
+    /**
+     * ID of plan to preview.
+     * @format GUID
+     */
+    planId: string;
+    /**
+     * Coupon code to apply, from the Coupons API.
+     * @minLength 1
+     * @maxLength 20
+     */
+    couponCode?: string | null;
+}
+interface GetPricePreviewResponse {
+    /**
+     * __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
+     * @deprecated __Deprecated.__ Use `prices` instead. This property will be removed on September 30, 2022.
+     * @replacedBy prices
+     * @targetRemovalDate 2022-10-01
+     */
+    price?: PriceDetails;
+    /** Pricing details. */
+    prices?: SpannedPrice[];
+}
+
+type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
+    getUrl: (context: any) => string;
+    httpMethod: K;
+    path: string;
+    pathParams: M;
+    __requestType: T;
+    __originalRequestType: S;
+    __responseType: Q;
+    __originalResponseType: R;
+};
+declare function managementGetOrder(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, GetOrderRequest$1, GetOrderRequest, GetOrderResponse$1, GetOrderResponse>;
+declare function managementListOrders(): __PublicMethodMetaInfo<'GET', {}, ListOrdersRequest$1, ListOrdersRequest, ListOrdersResponse$1, ListOrdersResponse>;
+declare function postponeEndDate(): __PublicMethodMetaInfo<'PATCH', {
+    id: string;
+}, PostponeEndDateRequest$1, PostponeEndDateRequest, PostponeEndDateResponse$1, PostponeEndDateResponse>;
+declare function cancelOrder(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, CancelOrderRequest$1, CancelOrderRequest, CancelOrderResponse$1, CancelOrderResponse>;
+declare function markAsPaid(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, MarkAsPaidRequest$1, MarkAsPaidRequest, MarkAsPaidResponse$1, MarkAsPaidResponse>;
+declare function pauseOrder(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, PauseOrderRequest$1, PauseOrderRequest, PauseOrderResponse$1, PauseOrderResponse>;
+declare function resumeOrder(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, ResumeOrderRequest$1, ResumeOrderRequest, ResumeOrderResponse$1, ResumeOrderResponse>;
+declare function memberGetOrder(): __PublicMethodMetaInfo<'GET', {
+    id: string;
+}, MemberGetOrderRequest$1, MemberGetOrderRequest, MemberGetOrderResponse$1, MemberGetOrderResponse>;
+declare function memberListOrders(): __PublicMethodMetaInfo<'GET', {}, MemberListOrdersRequest$1, MemberListOrdersRequest, MemberListOrdersResponse$1, MemberListOrdersResponse>;
+declare function requestCancellation(): __PublicMethodMetaInfo<'POST', {
+    id: string;
+}, RequestCancellationRequest$1, RequestCancellationRequest, RequestCancellationResponse$1, RequestCancellationResponse>;
+declare function createOnlineOrder(): __PublicMethodMetaInfo<'POST', {}, CreateOnlineOrderRequest$1, CreateOnlineOrderRequest, CreateOnlineOrderResponse$1, CreateOnlineOrderResponse>;
+declare function createOfflineOrder(): __PublicMethodMetaInfo<'POST', {}, CreateOfflineOrderRequest$1, CreateOfflineOrderRequest, CreateOfflineOrderResponse$1, CreateOfflineOrderResponse>;
+declare function getOnlineOrderPreview(): __PublicMethodMetaInfo<'POST', {}, GetOnlineOrderPreviewRequest$1, GetOnlineOrderPreviewRequest, GetOnlineOrderPreviewResponse$1, GetOnlineOrderPreviewResponse>;
+declare function getOfflineOrderPreview(): __PublicMethodMetaInfo<'POST', {}, GetOfflineOrderPreviewRequest$1, GetOfflineOrderPreviewRequest, GetOfflineOrderPreviewResponse$1, GetOfflineOrderPreviewResponse>;
+declare function getPricePreview(): __PublicMethodMetaInfo<'POST', {}, GetPricePreviewRequest$1, GetPricePreviewRequest, GetPricePreviewResponse$1, GetPricePreviewResponse>;
+
+export { type __PublicMethodMetaInfo, cancelOrder, createOfflineOrder, createOnlineOrder, getOfflineOrderPreview, getOnlineOrderPreview, getPricePreview, managementGetOrder, managementListOrders, markAsPaid, memberGetOrder, memberListOrders, pauseOrder, postponeEndDate, requestCancellation, resumeOrder };