@wix/auto_sdk_ecom_subscription-contracts 1.0.144 → 1.0.145

package/build/internal/es/index.typings.d.mts

@@ -2,33 +2,31 @@ import * as _wix_sdk_types from '@wix/sdk-types';
 import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
 
 /**
- * A SubscriptionContract is a ...
- * You can ...
- * Read more about SubscriptionContracts
- * in this [article](<LINK_TO_KB_ARTICLE>).
+ * A subscription contract holds the terms of a buyer's subscription: the items, prices, billing frequency, and buyer, billing, and shipping details agreed on at checkout, or as later changed through draft subscription contracts.
+ *
+ * A subscription contract is created when a buyer checks out with a subscription item. Each billing cycle, an order is created from the contract's current content. The order's `lineItems.subscriptionInfo.id` holds the contract ID, and `lineItems.subscriptionInfo.cycleNumber` holds the billing cycle the order is for.
+ *
+ * To change a subscription contract, create a draft subscription contract, edit it, and commit it.
  */
 interface SubscriptionContract {
     /**
-     * SubscriptionContract ID.
+     * Subscription contract ID.
      * @format GUID
      * @readonly
      */
     _id?: string | null;
     /**
-     * Revision number, which increments by 1 each time the SubscriptionContract is updated.
-     * To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.
-     *
-     * Ignored when creating a SubscriptionOrderContract.
+     * Revision number, which increments by 1 each time the subscription contract is updated.
      * @readonly
      */
     revision?: string | null;
     /**
-     * Date and time the subscription contract was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * Date and time the subscription contract was created.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Date and time the subscription contract was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * Date and time the subscription contract was last updated.
      * @readonly
      */
     _updatedDate?: Date | null;
@@ -47,14 +45,23 @@ interface SubscriptionContract {
      */
     description?: string | null;
     /**
-     * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
-     * @internal
+     * Subscription description, in the site's default language and translated into the buyer's language. For example, `"1kg of selected coffee, once a month"`.
+     *
+     * For a subscription contract with more than one line item, holds a general name for the subscription.
      */
     subscriptionDescription?: V1SubscriptionDescription;
-    /** Subscription detailed information. */
+    /** Subscription terms, such as the billing frequency, the number of billing cycles, and whether the subscription renews automatically. */
     subscriptionSettings?: V1SubscriptionSettings;
     /**
-     * Order line items.
+     * Subscription line items. The order for each billing cycle is created with these line items.
+     *
+     * In a subscription contract:
+     * + `lineItems.subscriptionInfo.id` is the subscription contract's own ID.
+     * + `lineItems.subscriptionInfo.cycleNumber` is always `0`. The billing cycle is set on the line items of each cycle's order.
+     * + `subscriptionInfo.title` and `subscriptionInfo.description` hold the subscription contract's title and description, not the line item's own subscription option.
+     * + `refundQuantity`, `restockQuantity`, and `depositAmount` aren't updated after the line item is added. Refunds, restocks, and fulfillment are recorded on each billing cycle's order.
+     * + `extendedFields` and `decimalQuantity` aren't returned.
+     * + When coupons were included in item prices at checkout, `price` is the price before coupons, and the coupons are in `appliedDiscounts`.
      * @minSize 1
      * @maxSize 100
      */
@@ -62,20 +69,25 @@ interface SubscriptionContract {
     /** Buyer information. */
     buyerInfo?: BuyerInfo;
     /**
-     * Language for communication with the buyer. Defaults to the site language.
-     * For a site that supports multiple languages, this is the language the buyer selected.
+     * Language for communication with the buyer. For a site that supports multiple languages, this is the language the buyer selected.
+     *
+     * Default: Site language
      * @maxLength 10
      */
     buyerLanguage?: string | null;
-    /** Weight measurement unit - defaults to site's weight unit. */
+    /**
+     * Weight measurement unit.
+     *
+     * Default: Site's weight unit
+     */
     weightUnit?: WeightUnitWithLiterals;
     /**
-     * Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
+     * Currency used for the subscription contract's pricing, as a three-letter currency code in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) alphabetic format.
      * @format CURRENCY
      * @immutable
      */
     currency?: string | null;
-    /** Multi-currency information of the subscription. conversionRate may reflect updated exchange rate on created order per recurring cycle. */
+    /** Multi-currency details for a subscription paid in a currency other than the site's currency. */
     currencyConversionDetails?: CurrencyConversionDetails;
     /**
      * Whether tax is included in line item prices.
@@ -85,15 +97,19 @@ interface SubscriptionContract {
      */
     taxIncludedInPrices?: boolean;
     /**
-     * Order price summary.
+     * Price summary of a single billing cycle.
      * @readonly
      */
     priceSummary?: PriceSummary;
-    /** Summary of platform fees for this subscription contract, including totals by charge type and a breakdown of individual fees. */
+    /**
+     * Summary of platform fees calculated at checkout, including totals by charge type and a breakdown of individual fees.
+     *
+     * Not updated when draft changes are committed. Each billing cycle's order holds the platform fees for that cycle.
+     */
     platformFeeSummary?: PlatformFeeSummary;
     /** Billing address and contact details. */
     billingInfo?: AddressWithContact;
-    /** Shipping info and selected shipping option details. */
+    /** Shipping information and selected shipping option details. */
     shippingInfo?: ShippingInformation;
     /**
      * Tax information.
@@ -102,11 +118,11 @@ interface SubscriptionContract {
      */
     taxInfo?: OrderTaxInfo;
     /**
-     * Applied discounts.
+     * Discounts applied to the subscription contract.
      * @maxSize 100
      */
     appliedDiscounts?: AppliedDiscount[];
-    /** Information about the sales channel that submitted this order. */
+    /** Information about the sales channel the subscription was purchased through. */
     channelInfo?: ChannelInfo;
     /**
      * Custom fields.
@@ -114,7 +130,7 @@ interface SubscriptionContract {
      */
     customFields?: CustomField[];
     /**
-     * Order recipient address and contact details.
+     * Recipient address and contact details.
      *
      * This field may differ from the address in `shippingInfo.logistics` when:
      * + The chosen shipping option is pickup point or store pickup.
@@ -124,7 +140,7 @@ interface SubscriptionContract {
     /**
      * Custom field data for the subscription contract object.
      *
-     * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the [app dashboard](https://dev.wix.com/dc3/my-apps/) before they can be accessed with API calls.
+     * [Extended fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/about-schema-plugin-extensions) must be configured in the app dashboard before they can be accessed with API calls.
      */
     extendedFields?: ExtendedFields;
     /**
@@ -136,12 +152,13 @@ interface SubscriptionContract {
      */
     title?: string | null;
     /**
-     * Subscription title. For example, `"Monthly coffee Subscription"`.
-     * @internal
+     * Subscription title, in the site's default language and translated into the buyer's language. For example, `"Monthly coffee subscription"`.
+     *
+     * For a subscription contract with more than one line item, holds a general name for the subscription.
      */
     subscriptionTitle?: V1SubscriptionTitle;
     /**
-     * Additional fees applied to subscription contract.
+     * Additional fees applied to the subscription contract.
      * @maxSize 100
      */
     additionalFees?: AdditionalFee[];
@@ -156,7 +173,8 @@ interface SubscriptionContract {
      */
     settings?: SubscriptionContractSettings;
     /**
-     * Activities recorded on this contract (e.g. draft commits, status changes).
+     * Record of changes made to the subscription contract after checkout.
+     * @internal
      * @readonly
      * @maxSize 500
      */
@@ -164,18 +182,18 @@ interface SubscriptionContract {
 }
 interface V1SubscriptionDescription {
     /**
-     * Subscription option description.
+     * Subscription description in the site's default language.
      * @maxLength 500
      */
     original?: string;
     /**
-     * Translated subscription option description.
+     * Subscription description translated into the buyer's language.
      * @maxLength 500
      */
     translated?: string | null;
 }
 interface V1SubscriptionSettings {
-    /** Frequency of recurring payment. */
+    /** Frequency unit of the billing cycle. */
     frequency?: SubscriptionFrequencyWithLiterals;
     /**
      * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -183,19 +201,23 @@ interface V1SubscriptionSettings {
      * @max 3650
      */
     interval?: number | null;
-    /** Whether subscription is renewed automatically at the end of each period. */
+    /** Whether the subscription renews automatically at the end of each billing cycle. */
     autoRenewal?: boolean;
     /**
-     * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
+     * Number of billing cycles before the subscription ends.
      * @min 1
      */
     billingCycles?: number | null;
-    /** Whether to allow the customer to cancel the subscription. */
+    /** Whether the buyer can cancel the subscription. */
     enableCustomerCancellation?: boolean;
-    /** Period until first cycle starts. If None => no free trial */
+    /**
+     * Free trial period before the first billing cycle starts.
+     *
+     * Returned only when the subscription has a free trial.
+     */
     freeTrialPeriod?: V1FreeTrialPeriod;
     /**
-     * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
+     * Date and time the subscription starts. The first charge is made on this date, or when the free trial ends.
      * @internal
      */
     startDate?: Date | null;
@@ -227,7 +249,7 @@ declare enum SubscriptionFrequency {
 /** @enumType */
 type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
 interface V1FreeTrialPeriod {
-    /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
+    /** Frequency unit of the free trial period. */
     frequency?: SubscriptionFrequencyWithLiterals;
     /**
      * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -2113,15 +2135,13 @@ interface CustomField {
 }
 interface V1SubscriptionTitle {
     /**
-     * Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
+     * Subscription title in the site's default language.
      * @minLength 1
      * @maxLength 150
      */
     original?: string;
     /**
-     * Subscription option name translated into the buyer's language.
-     *
-     * Default: Same as `original`.
+     * Subscription title translated into the buyer's language.
      * @minLength 1
      * @maxLength 150
      */
@@ -2232,7 +2252,7 @@ declare enum SpecificItemsCouponBehavior {
 /** @enumType */
 type SpecificItemsCouponBehaviorWithLiterals = SpecificItemsCouponBehavior | 'UNDEFINED_COUPON_BEHAVIOR' | 'ITEM_SUBTOTAL_INCLUDES_DISCOUNT' | 'LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT';
 interface SubscriptionContractActivity extends SubscriptionContractActivityTargetOneOf, SubscriptionContractActivityContentOneOf {
-    /** Scopes the draft to the contract level, applying to all future cycles. */
+    /** The activity applies to all future billing cycles of the subscription contract. */
     contractTarget?: ContractTarget;
     /** Changes committed from a DraftSubscriptionContract. */
     changesApplied?: ChangesAppliedActivity;
@@ -2243,12 +2263,12 @@ interface SubscriptionContractActivity extends SubscriptionContractActivityTarge
      */
     _id?: string;
     /**
-     * When the activity occurred.
+     * Date and time the activity occurred.
      * @readonly
      */
     _createdDate?: Date | null;
     /**
-     * Identity of the draft order's initiator.
+     * Wix user or app that made the change.
      * @readonly
      */
     author?: ActivityAuthor;
@@ -2257,7 +2277,7 @@ interface SubscriptionContractActivity extends SubscriptionContractActivityTarge
 }
 /** @oneof */
 interface SubscriptionContractActivityTargetOneOf {
-    /** Scopes the draft to the contract level, applying to all future cycles. */
+    /** The activity applies to all future billing cycles of the subscription contract. */
     contractTarget?: ContractTarget;
 }
 /** @oneof */
@@ -2265,19 +2285,19 @@ interface SubscriptionContractActivityContentOneOf {
     /** Changes committed from a DraftSubscriptionContract. */
     changesApplied?: ChangesAppliedActivity;
 }
-/** Scopes the draft to the contract level, applying to all future cycles. */
+/** Target that applies changes to all future billing cycles of the subscription contract. */
 interface ContractTarget {
-    /** Cycle number of the next billing cycle (1-based). Set by the caller; returned by the server on read. */
+    /** Number of the first billing cycle the changes apply to. Billing cycles are numbered from `1`. */
     nextCycleNumber?: number | null;
 }
 interface ActivityAuthor extends ActivityAuthorValueOneOf {
     /**
-     * User ID. When the draft order was created by a Wix user.
+     * Wix user ID. Returned when a Wix user made the change.
      * @format GUID
      */
     userId?: string;
     /**
-     * App ID. When the draft order was created by an app.
+     * App ID. Returned when an app made the change.
      * @format GUID
      */
     appId?: string;
@@ -2285,74 +2305,76 @@ interface ActivityAuthor extends ActivityAuthorValueOneOf {
 /** @oneof */
 interface ActivityAuthorValueOneOf {
     /**
-     * User ID. When the draft order was created by a Wix user.
+     * Wix user ID. Returned when a Wix user made the change.
      * @format GUID
      */
     userId?: string;
     /**
-     * App ID. When the draft order was created by an app.
+     * App ID. Returned when an app made the change.
      * @format GUID
      */
     appId?: string;
 }
 interface ChangesAppliedActivity extends ChangesAppliedActivityTargetOneOf {
-    /** Scopes the draft to the contract level, applying to all future cycles. */
+    /** The changes apply to all future billing cycles of the subscription contract. */
     contractTarget?: ContractTarget;
     /**
-     * ID of the DraftSubscriptionContract that was committed.
+     * ID of the draft subscription contract whose changes were committed.
      * @format GUID
      */
     draftSubscriptionContractId?: string;
     /**
-     * Individual typed changes applied.
+     * Changes that were applied to the subscription contract.
      * @maxSize 100
      */
     changes?: ContractChange[];
     /**
-     * Reason for the edit, provided by the merchant (optional).
+     * Reason for the change, provided by the business.
      * @maxLength 200
      */
     reason?: string | null;
 }
 /** @oneof */
 interface ChangesAppliedActivityTargetOneOf {
-    /** Scopes the draft to the contract level, applying to all future cycles. */
+    /** The changes apply to all future billing cycles of the subscription contract. */
     contractTarget?: ContractTarget;
 }
-interface ContractChange extends ContractChangeValueOneOf {
+interface ContractChange extends ContractChangeChangeDetailsOneOf {
     /** Line item was modified. */
     lineItemChanged?: LineItemChanges;
     /** Line item was added to the contract. */
-    lineItemAdded?: ManagedLineItem;
+    lineItemAdded?: LineItemSummary;
     /** Line item was removed from the contract. */
-    lineItemRemoved?: ManagedLineItem;
+    lineItemRemoved?: LineItemSummary;
     /** Discount was added to the contract. */
-    discountAdded?: ManagedDiscount;
+    discountAdded?: DiscountSummary;
     /** Discount was removed from the contract. */
-    discountRemoved?: ManagedDiscount;
+    discountRemoved?: DiscountSummary;
     /** Additional fee was added to the contract. */
-    additionalFeeAdded?: ManagedAdditionalFee;
+    additionalFeeAdded?: AdditionalFeeSummary;
     /** Additional fee was removed from the contract. */
-    additionalFeeRemoved?: ManagedAdditionalFee;
+    additionalFeeRemoved?: AdditionalFeeSummary;
     /** Total price changed. */
     totalPriceChanged?: TotalPriceChange;
+    /** Type of change. */
+    changeType?: ContractChangeTypeWithLiterals;
 }
 /** @oneof */
-interface ContractChangeValueOneOf {
+interface ContractChangeChangeDetailsOneOf {
     /** Line item was modified. */
     lineItemChanged?: LineItemChanges;
     /** Line item was added to the contract. */
-    lineItemAdded?: ManagedLineItem;
+    lineItemAdded?: LineItemSummary;
     /** Line item was removed from the contract. */
-    lineItemRemoved?: ManagedLineItem;
+    lineItemRemoved?: LineItemSummary;
     /** Discount was added to the contract. */
-    discountAdded?: ManagedDiscount;
+    discountAdded?: DiscountSummary;
     /** Discount was removed from the contract. */
-    discountRemoved?: ManagedDiscount;
+    discountRemoved?: DiscountSummary;
     /** Additional fee was added to the contract. */
-    additionalFeeAdded?: ManagedAdditionalFee;
+    additionalFeeAdded?: AdditionalFeeSummary;
     /** Additional fee was removed from the contract. */
-    additionalFeeRemoved?: ManagedAdditionalFee;
+    additionalFeeRemoved?: AdditionalFeeSummary;
     /** Total price changed. */
     totalPriceChanged?: TotalPriceChange;
 }
@@ -2368,11 +2390,15 @@ interface LineItemChanges {
     quantity?: LineItemQuantityChange;
 }
 declare enum LineItemQuantityChangeType {
+    /** Unknown quantity change type. */
+    UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE = "UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE",
+    /** Quantity increased. */
     QUANTITY_INCREASED = "QUANTITY_INCREASED",
+    /** Quantity decreased. */
     QUANTITY_DECREASED = "QUANTITY_DECREASED"
 }
 /** @enumType */
-type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
+type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE' | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
 interface LineItemQuantityChange {
     /**
      * Original item quantity before the change.
@@ -2389,11 +2415,11 @@ interface LineItemQuantityChange {
      * @min 1
      * @max 1000000
      */
-    diff?: number;
+    quantityDifference?: number;
     /** Direction of the quantity change. */
     deltaType?: LineItemQuantityChangeTypeWithLiterals;
 }
-interface ManagedLineItem {
+interface LineItemSummary {
     /**
      * Line item ID.
      * @format GUID
@@ -2408,7 +2434,7 @@ interface ManagedLineItem {
      */
     quantity?: number;
 }
-interface ManagedDiscount {
+interface DiscountSummary {
     /**
      * Discount ID.
      * @format GUID
@@ -2431,7 +2457,7 @@ interface TranslatedValue {
      */
     translated?: string | null;
 }
-interface ManagedAdditionalFee {
+interface AdditionalFeeSummary {
     /**
      * Additional fee ID.
      * @format GUID
@@ -2448,8 +2474,32 @@ interface TotalPriceChange {
     /** Total price after the commit. */
     newTotal?: Price;
 }
+declare enum ContractChangeType {
+    /** Unknown change type. */
+    UNKNOWN_CONTRACT_CHANGE_TYPE = "UNKNOWN_CONTRACT_CHANGE_TYPE",
+    /** Line item was modified. */
+    LINE_ITEM_CHANGED = "LINE_ITEM_CHANGED",
+    /** Line item was added to the contract. */
+    LINE_ITEM_ADDED = "LINE_ITEM_ADDED",
+    /** Line item was removed from the contract. */
+    LINE_ITEM_REMOVED = "LINE_ITEM_REMOVED",
+    /** Discount was added to the contract. */
+    DISCOUNT_ADDED = "DISCOUNT_ADDED",
+    /** Discount was removed from the contract. */
+    DISCOUNT_REMOVED = "DISCOUNT_REMOVED",
+    /** Additional fee was added to the contract. */
+    ADDITIONAL_FEE_ADDED = "ADDITIONAL_FEE_ADDED",
+    /** Additional fee was removed from the contract. */
+    ADDITIONAL_FEE_REMOVED = "ADDITIONAL_FEE_REMOVED",
+    /** Total price changed. */
+    TOTAL_PRICE_CHANGED = "TOTAL_PRICE_CHANGED"
+}
+/** @enumType */
+type ContractChangeTypeWithLiterals = ContractChangeType | 'UNKNOWN_CONTRACT_CHANGE_TYPE' | 'LINE_ITEM_CHANGED' | 'LINE_ITEM_ADDED' | 'LINE_ITEM_REMOVED' | 'DISCOUNT_ADDED' | 'DISCOUNT_REMOVED' | 'ADDITIONAL_FEE_ADDED' | 'ADDITIONAL_FEE_REMOVED' | 'TOTAL_PRICE_CHANGED';
 declare enum ActivityType {
+    /** Unknown activity type. */
     UNKNOWN_ACTIVITY_TYPE = "UNKNOWN_ACTIVITY_TYPE",
+    /** Changes from a draft subscription contract were committed. */
     CHANGES_APPLIED = "CHANGES_APPLIED"
 }
 /** @enumType */
@@ -2480,30 +2530,26 @@ interface SubscriptionContractExpired {
     /** The subscription contract that expired. */
     subscriptionContract?: SubscriptionContract;
 }
-/**
- * ACTION event payload emitted after a successful commit.
- * Carries the full delta — downstream consumers (email notifications, activity feed)
- * subscribe to this event and have all details inline without fetching the draft.
- */
+/** Triggered when changes from a draft subscription contract are committed to a subscription contract. */
 interface SubscriptionContractChangesCommitted {
-    /** Updated SubscriptionContract after commit. */
+    /** Subscription contract after the changes were committed. */
     subscriptionContract?: SubscriptionContract;
     /**
-     * ID of the DraftSubscriptionContract that triggered this commit.
+     * ID of the draft subscription contract whose changes were committed.
      * @format GUID
      */
     draftSubscriptionContractId?: string;
-    /** The actual delta applied. */
+    /** Changes that were applied to the subscription contract. */
     changes?: SubscriptionContractDiffs;
     /**
      * Date and time the changes were committed.
      * @readonly
      */
     commitDate?: Date | null;
-    /** Side-effects requested by the caller when the changes were committed. */
+    /** Notification settings specified when the changes were committed. */
     commitSettings?: SubscriptionCommitSettings;
     /**
-     * Reason for the edit, provided by the merchant.
+     * Reason for the change, provided by the business.
      * @maxLength 200
      */
     reason?: string | null;
@@ -2512,209 +2558,224 @@ interface SubscriptionContractChangesCommitted {
 }
 interface SubscriptionContractDiffs {
     /**
-     * Per-item deltas: added, changed, or removed line items.
+     * Line items that were added, changed, or removed.
+     *
+     * A line item is `CHANGED` when a field listed in `ItemChangedDetails` changed. Line items with no change aren't included.
      * @maxSize 100
      */
     lineItems?: LineItemDelta[];
     /**
-     * Per-discount deltas.
+     * Discounts that were added, changed, or removed.
+     *
+     * A discount is `CHANGED` when its amount, the amount for any line item, or the line items it applies to changed. Discounts with no change aren't included.
      * @maxSize 100
      */
     appliedDiscounts?: AppliedDiscountDelta[];
     /**
-     * Per-fee deltas.
+     * Additional fees that were added, changed, or removed.
+     *
+     * An additional fee is `CHANGED` when its price or the line items it applies to changed. Fees with no change aren't included.
      * @maxSize 100
      */
     additionalFees?: AdditionalFeeDelta[];
-    /** Updated price summary (overwrites existing). */
+    /** Price summary after the changes. Replaces the subscription contract's previous price summary. */
     priceSummary?: PriceSummary;
-    /** Updated tax info (overwrites existing). */
+    /** Tax information after the changes. Replaces the subscription contract's previous tax information. */
     taxInfo?: OrderTaxInfo;
+    /** Shipping information after the changes. Replaces the subscription contract's previous shipping information. */
+    shippingInfo?: ShippingInformation;
 }
 interface LineItemDelta extends LineItemDeltaDeltaDetailsOneOf {
+    /** Values the line item had before the change. */
     changed?: ItemChangedDetails;
     /**
      * Line item ID.
      * @format GUID
      */
     lineItemId?: string;
-    /** Full line item content (absent for removed items). */
+    /** Line item content. For a removed line item, the line item that was removed. */
     lineItem?: OrderLineItem;
     /** Type of change applied to this line item. */
     changeType?: ChangeTypeWithLiterals;
 }
 /** @oneof */
 interface LineItemDeltaDeltaDetailsOneOf {
+    /** Values the line item had before the change. */
     changed?: ItemChangedDetails;
 }
-/** the catalog reference options before the change. */
+/** The catalog reference options before the change. */
 interface CatalogReferenceOptionsBeforeChange {
-    /** the catalog reference options. Absent when the line item had no options. */
+    /** The catalog reference options. Absent when the line item had no options. */
     options?: Record<string, any> | null;
 }
-/** the product name before the change. */
+/** The product name before the change. */
 interface ProductNameBeforeChange {
-    /** the product name. Absent when the line item had no product name. */
+    /** The product name. Absent when the line item had no product name. */
     productName?: ProductName;
 }
-/** the description lines before the change. */
+/** The description lines before the change. */
 interface DescriptionLinesBeforeChange {
     /**
-     * the description lines. Empty when the line item had no description lines.
+     * The description lines. Empty when the line item had no description lines.
      * @maxSize 20
      */
     descriptionLines?: DescriptionLine[];
 }
-/** the image before the change. */
+/** The image before the change. */
 interface ImageBeforeChange {
-    /** the image. Absent when the line item had no image. */
+    /** The image. Absent when the line item had no image. */
     image?: string;
 }
-/** the physical properties before the change. */
+/** The physical properties before the change. */
 interface PhysicalPropertiesBeforeChange {
-    /** the physical properties. Absent when the line item had no physical properties. */
+    /** The physical properties. Absent when the line item had no physical properties. */
     physicalProperties?: PhysicalProperties;
 }
-/** the item type before the change. */
+/** The item type before the change. */
 interface ItemTypeBeforeChange {
-    /** the item type. Absent when the line item had no item type. */
+    /** The item type. Absent when the line item had no item type. */
     itemType?: ItemType;
 }
-/** the fulfiller ID before the change. */
+/** The fulfiller ID before the change. */
 interface FulfillerIdBeforeChange {
     /**
-     * the fulfiller ID. Absent when the line item had no fulfiller.
+     * The fulfiller ID. Absent when the line item had no fulfiller.
      * @format GUID
      */
     fulfillerId?: string | null;
 }
-/** the digital file before the change. */
+/** The digital file before the change. */
 interface DigitalFileBeforeChange {
-    /** the digital file. Absent when the line item had no digital file. */
+    /** The digital file. Absent when the line item had no digital file. */
     digitalFile?: DigitalFile;
 }
-/** the price description before the change. */
+/** The price description before the change. */
 interface PriceDescriptionBeforeChange {
-    /** the price description. Absent when the line item had no price description. */
+    /** The price description. Absent when the line item had no price description. */
     priceDescription?: PriceDescription;
 }
-/** the delivery profile ID before the change. */
+/** The delivery profile ID before the change. */
 interface DeliveryProfileIdBeforeChange {
     /**
-     * the delivery profile ID. Absent when the line item had no delivery profile.
+     * The delivery profile ID. Absent when the line item had no delivery profile.
      * @format GUID
      */
     deliveryProfileId?: string | null;
 }
-/** the shipping group ID before the change. */
+/** The shipping group ID before the change. */
 interface ShippingGroupIdBeforeChange {
     /**
-     * the shipping group ID. Absent when the line item had no shipping group.
+     * The shipping group ID. Absent when the line item had no shipping group.
      * @format GUID
      */
     shippingGroupId?: string | null;
 }
-/** the tax info before the change. */
+/** The tax info before the change. */
 interface TaxInfoBeforeChange {
-    /** the tax info. Absent when the line item had no tax info. */
+    /** The tax info. Absent when the line item had no tax info. */
     taxInfo?: LineItemTaxInfo;
 }
-/** the inventory app ID before the change. */
+/** The inventory app ID before the change. */
 interface InventoryAppIdBeforeChange {
     /**
-     * the inventory app ID. Absent when the line item had no inventory app.
+     * The inventory app ID. Absent when the line item had no inventory app.
      * @format GUID
      */
     inventoryAppId?: string | null;
 }
-/** the root catalog item ID before the change. */
+/** The root catalog item ID before the change. */
 interface RootCatalogItemIdBeforeChange {
     /**
-     * the root catalog item ID. Absent when the line item had no root catalog item.
+     * The root catalog item ID. Absent when the line item had no root catalog item.
      * @minLength 1
      * @maxLength 36
      */
     rootCatalogItemId?: string | null;
 }
-/** the modifier groups before the change. */
+/** The modifier groups before the change. */
 interface ModifierGroupsBeforeChange {
     /**
-     * the modifier groups. Empty when the line item had no modifier groups.
+     * The modifier groups. Empty when the line item had no modifier groups.
      * @maxSize 10
      */
     modifierGroups?: ModifierGroup[];
 }
-/** the price undetermined flag before the change. */
+/** The price undetermined flag before the change. */
 interface PriceUndeterminedBeforeChange {
-    /** whether the price of the line item was undetermined. */
+    /** Whether the price of the line item was undetermined. */
     priceUndetermined?: boolean;
 }
-/** Describes the type of change applied to an element. */
+/** Type of change to a line item, discount, or additional fee. */
 declare enum ChangeType {
+    /** Unknown change type. */
     UNKNOWN_CHANGE_TYPE = "UNKNOWN_CHANGE_TYPE",
-    /** Element was added (absent in the original contract). */
+    /** The line item, discount, or additional fee was added to the subscription contract. */
     ADDED = "ADDED",
-    /** Element was modified from the original contract. */
+    /** The line item, discount, or additional fee was changed. */
     CHANGED = "CHANGED",
-    /** Element was removed from the contract. */
+    /** The line item, discount, or additional fee was removed from the subscription contract. */
     REMOVED = "REMOVED"
 }
 /** @enumType */
 type ChangeTypeWithLiterals = ChangeType | 'UNKNOWN_CHANGE_TYPE' | 'ADDED' | 'CHANGED' | 'REMOVED';
 interface ItemChangedDetails {
     /**
-     * The quantity before the change.
+     * The quantity before the change. Set only when the quantity changed.
      * @min 1
      * @max 1000000
      */
     quantityBeforeChange?: number | null;
-    /** The price before the change. */
+    /** The price before the change. Set only when the price changed. */
     priceBeforeChange?: Price;
-    /** the catalog reference options before the change. Set only when the catalog reference options changed. */
+    /** The catalog reference options before the change. Set only when the catalog reference options changed. */
     catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
-    /** the product name before the change. Set only when the product name changed. */
+    /** The product name before the change. Set only when the product name changed. */
     productNameBeforeChange?: ProductNameBeforeChange;
-    /** the description lines before the change. Set only when the description lines changed. */
+    /** The description lines before the change. Set only when the description lines changed. */
     descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
-    /** the image before the change. Set only when the image changed. */
+    /** The image before the change. Set only when the image changed. */
     imageBeforeChange?: ImageBeforeChange;
-    /** the physical properties before the change. Set only when the physical properties changed. */
+    /** The physical properties before the change. Set only when the physical properties changed. */
     physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
-    /** the item type before the change. Set only when the item type changed. */
+    /** The item type before the change. Set only when the item type changed. */
     itemTypeBeforeChange?: ItemTypeBeforeChange;
-    /** the fulfiller ID before the change. Set only when the fulfiller ID changed. */
+    /** The fulfiller ID before the change. Set only when the fulfiller ID changed. */
     fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
-    /** the digital file before the change. Set only when the digital file changed. */
+    /** The digital file before the change. Set only when the digital file changed. */
     digitalFileBeforeChange?: DigitalFileBeforeChange;
-    /** the price description before the change. Set only when the price description changed. */
+    /** The price description before the change. Set only when the price description changed. */
     priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
     /**
-     * the delivery profile ID before the change. Set only when the delivery profile ID changed.
+     * The delivery profile ID before the change. Set only when the delivery profile ID changed.
      * @internal
      */
     deliveryProfileIdBeforeChange?: DeliveryProfileIdBeforeChange;
     /**
-     * the shipping group ID before the change. Set only when the shipping group ID changed.
+     * The shipping group ID before the change. Set only when the shipping group ID changed.
      * @internal
      */
     shippingGroupIdBeforeChange?: ShippingGroupIdBeforeChange;
-    /** the tax info before the change. Set only when the tax group changed. */
+    /** The tax info before the change. Set only when the line item's tax group changed because its catalog options changed. */
     taxInfoBeforeChange?: TaxInfoBeforeChange;
-    /** the inventory app ID before the change. Set only when the inventory app ID changed. */
+    /**
+     * The inventory app ID before the change. Set only when the inventory app ID changed.
+     * @internal
+     */
     inventoryAppIdBeforeChange?: InventoryAppIdBeforeChange;
     /**
-     * the root catalog item ID before the change. Set only when the root catalog item ID changed.
+     * The root catalog item ID before the change. Set only when the root catalog item ID changed.
      * @internal
      */
     rootCatalogItemIdBeforeChange?: RootCatalogItemIdBeforeChange;
-    /** the modifier groups before the change. Set only when the modifier groups changed. */
+    /** The modifier groups before the change. Set only when the modifier groups changed. */
     modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
-    /** the price undetermined flag before the change. Set only when the price undetermined flag changed. */
+    /** The price undetermined flag before the change. Set only when the price undetermined flag changed. */
     priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
 }
 interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
     /** Discount content after the change. */
     changed?: AppliedDiscount;
+    /** Discount that was added. */
     added?: AppliedDiscount;
     /**
      * Discount ID.
@@ -2728,11 +2789,13 @@ interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
 interface AppliedDiscountDeltaDeltaDetailsOneOf {
     /** Discount content after the change. */
     changed?: AppliedDiscount;
+    /** Discount that was added. */
     added?: AppliedDiscount;
 }
 interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
     /** Additional fee content after the change. */
     changed?: AdditionalFee;
+    /** Additional fee that was added. */
     added?: AdditionalFee;
     /**
      * Additional fee ID.
@@ -2746,12 +2809,21 @@ interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
 interface AdditionalFeeDeltaDeltaDetailsOneOf {
     /** Additional fee content after the change. */
     changed?: AdditionalFee;
+    /** Additional fee that was added. */
     added?: AdditionalFee;
 }
 interface SubscriptionCommitSettings {
-    /** If false, do not send notifications to buyer. Default is true. */
+    /**
+     * Whether to send the buyer a notification about the committed changes.
+     *
+     * Default: `true`
+     */
     sendNotificationsToBuyer?: boolean | null;
-    /** If false, do not send notifications to business. Default is true. */
+    /**
+     * Whether to send the business a notification about the committed changes.
+     *
+     * Default: `true`
+     */
     sendNotificationsToBusiness?: boolean | null;
 }
 /** Triggered when a subscription contract's next charge is coming up. */
@@ -2782,13 +2854,13 @@ interface CreateSubscriptionContractResponse {
 }
 interface GetSubscriptionContractRequest {
     /**
-     * ID of the SubscriptionContract to retrieve.
+     * ID of the subscription contract to retrieve.
      * @format GUID
      */
     subscriptionContractId: string;
 }
 interface GetSubscriptionContractResponse {
-    /** The requested SubscriptionContract. */
+    /** Retrieved subscription contract. */
     subscriptionContract?: SubscriptionContract;
 }
 interface UpdateSubscriptionContractRequest {
@@ -2807,26 +2879,24 @@ interface UpdateSubscriptionContractResponse {
     subscriptionContract?: SubscriptionContract;
 }
 interface QuerySubscriptionContractsRequest {
-    /** WQL expression. */
+    /** Filter, sort, and paging options for the query. */
     query?: CursorQuery;
 }
 interface CursorQuery extends CursorQueryPagingMethodOneOf {
     /** 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`
-     * Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     * Filter object. See [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) for more information.
+     *
+     * Supported properties:
+     * `id`, `buyerInfo.contactId`
      */
     filter?: Record<string, any> | null;
     /**
      * Sort object in the following format:
      * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-     * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
      * @maxSize 5
      */
     sort?: Sorting[];
@@ -2838,11 +2908,18 @@ interface CursorQueryPagingMethodOneOf {
 }
 interface Sorting {
     /**
-     * Name of the field to sort by.
+     * Field to sort by.
+     *
+     * Supported properties:
+     * `id`, `buyerInfo.contactId`
      * @maxLength 512
      */
     fieldName?: string;
-    /** Sort order. */
+    /**
+     * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+     *
+     * Default: `ASC`
+     */
     order?: SortOrderWithLiterals;
 }
 declare enum SortOrder {
@@ -2867,9 +2944,9 @@ interface CursorPaging {
     cursor?: string | null;
 }
 interface QuerySubscriptionContractsResponse {
-    /** List of SubscriptionContracts. */
+    /** Retrieved subscription contracts. */
     subscriptionContracts?: SubscriptionContract[];
-    /** Paging metadata */
+    /** Paging metadata. */
     pagingMetadata?: CursorPagingMetadata;
 }
 interface CursorPagingMetadata {
@@ -3175,6 +3252,12 @@ interface AccountInfo {
      */
     siteId?: string | null;
 }
+/** @docsIgnore */
+type GetSubscriptionContractApplicationErrors = {
+    code?: 'NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
 interface BaseEventMetadata {
     /**
      * App instance ID.
@@ -3230,11 +3313,35 @@ interface AccountInfoMetadata {
     /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
     parentAccountId?: string;
 }
+interface SubscriptionContractCommittedEnvelope {
+    data: SubscriptionContractChangesCommitted;
+    metadata: EventMetadata;
+}
+/**
+ * Triggered when changes from a draft subscription contract are committed to a subscription contract.
+ * The event holds the updated contract and every change that was applied.
+ * @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Manage Restaurants - all permissions
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
+ * @webhook
+ * @eventType wix.ecom.subscription_contracts.v1.subscription_contract_committed
+ * @slug committed
+ * @documentationMaturity preview
+ */
+declare function onSubscriptionContractCommitted(handler: (event: SubscriptionContractCommittedEnvelope) => void | Promise<void>): void;
 interface SubscriptionContractCreatedEnvelope {
     entity: SubscriptionContract;
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
@@ -3252,7 +3359,9 @@ declare function onSubscriptionContractCreated(handler: (event: SubscriptionCont
 interface SubscriptionContractDeletedEnvelope {
     metadata: EventMetadata;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a subscription contract is deleted. A subscription contract is deleted when the buyer's personal data is erased. It isn't deleted when the subscription ends.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
@@ -3273,7 +3382,11 @@ interface SubscriptionContractUpdatedEnvelope {
     /** @hidden */
     modifiedFields: Record<string, any>;
 }
-/** @permissionScope Manage Stores - all permissions
+/**
+ * Triggered when a subscription contract is updated.
+ * Fires when changes from a draft subscription contract are committed, and when the contract's `priceSummary` is set to the billed totals at the start of the first billing cycle.
+ * Also fires right after a subscription contract is created, while billing for the subscription is set up. These updates can leave every documented field unchanged.
+ * @permissionScope Manage Stores - all permissions
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
  * @permissionScope Read eCommerce - all read permissions
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
@@ -3289,26 +3402,36 @@ interface SubscriptionContractUpdatedEnvelope {
  */
 declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
 /**
- * Retrieves a SubscriptionContract.
- * @param subscriptionContractId - ID of the SubscriptionContract to retrieve.
+ * Retrieves a subscription contract.
+ *
+ *
+ * To retrieve the subscription contract an order was created from, specify the order's `lineItems.subscriptionInfo.id` as `subscriptionContractId`. You can retrieve the order with [Get Order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/get-order).
+ *
+ * To retrieve the orders created from a subscription contract, call [Search Orders](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/search-orders) with a filter on `lineItems.subscriptionInfo.id`.
+ * @param subscriptionContractId - ID of the subscription contract to retrieve.
  * @public
  * @documentationMaturity preview
  * @requiredField subscriptionContractId
  * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
  * @applicableIdentity APP
- * @returns The requested SubscriptionContract.
+ * @returns Retrieved subscription contract.
  * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
  */
-declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `activities` | `activities.${number}.changesApplied.draftSubscriptionContractId` | `activities.${number}._id` | `activities.${number}.author.userId` | `activities.${number}.author.appId` | `activities.${number}.activityType`, 4>>;
+declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionDescription.original` | `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `subscriptionTitle.original` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source`, 4> & {
+    __applicationErrorsType?: GetSubscriptionContractApplicationErrors;
+}>;
 /**
- * Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
+ * Retrieves a list of up to 100 subscription contracts, given the provided paging, filtering, and sorting.
+ *
+ *
+ * Query Subscription Contracts runs with these defaults, which you can override:
  *
- * Up to 300 SubscriptionContracts can be returned per request.
+ * - `id` is sorted in `ASC` order
+ * - `cursorPaging.limit` is `50`
  *
- * To learn how to query SubscriptionContracts, see [API Query Language][2].
+ * You can filter and sort by `id` and `buyerInfo.contactId`. For example, to retrieve all of a buyer's subscription contracts, filter by `buyerInfo.contactId`.
  *
- * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
- * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
+ * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
  * @public
  * @documentationMaturity preview
  * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
@@ -3393,7 +3516,7 @@ interface SubscriptionContractsQueryBuilder {
  * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.QuerySubscriptionContracts
  * @requiredField query
  */
-declare function typedQuerySubscriptionContracts(query: SubscriptionContractQuery): Promise<NonNullablePaths<QuerySubscriptionContractsResponse, `subscriptionContracts` | `subscriptionContracts.${number}.subscriptionSettings.frequency` | `subscriptionContracts.${number}.subscriptionSettings.autoRenewal` | `subscriptionContracts.${number}.subscriptionSettings.enableCustomerCancellation` | `subscriptionContracts.${number}.subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionContracts.${number}.subscriptionSettings.freeTrialPeriod.interval` | `subscriptionContracts.${number}.buyerInfo.visitorId` | `subscriptionContracts.${number}.buyerInfo.memberId` | `subscriptionContracts.${number}.weightUnit` | `subscriptionContracts.${number}.taxIncludedInPrices` | `subscriptionContracts.${number}.shippingInfo.title` | `subscriptionContracts.${number}.channelInfo.type`, 4>>;
+declare function typedQuerySubscriptionContracts(query: SubscriptionContractQuery): Promise<NonNullablePaths<QuerySubscriptionContractsResponse, `subscriptionContracts` | `subscriptionContracts.${number}.subscriptionDescription.original` | `subscriptionContracts.${number}.subscriptionSettings.frequency` | `subscriptionContracts.${number}.subscriptionSettings.autoRenewal` | `subscriptionContracts.${number}.subscriptionSettings.enableCustomerCancellation` | `subscriptionContracts.${number}.subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionContracts.${number}.subscriptionSettings.freeTrialPeriod.interval` | `subscriptionContracts.${number}.buyerInfo.visitorId` | `subscriptionContracts.${number}.buyerInfo.memberId` | `subscriptionContracts.${number}.weightUnit` | `subscriptionContracts.${number}.taxIncludedInPrices` | `subscriptionContracts.${number}.shippingInfo.title` | `subscriptionContracts.${number}.channelInfo.type` | `subscriptionContracts.${number}.subscriptionTitle.original`, 4>>;
 interface SubscriptionContractQuerySpec extends QuerySpec {
     paging: 'cursor';
     wql: [
@@ -3425,29 +3548,32 @@ type SubscriptionContractQuery = {
         cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
     };
     /**
-    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`
-    Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+    Filter object. See [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) for more information.
+  
+    Supported properties:
+    `id`, `buyerInfo.contactId`
     */
     filter?: CommonQueryWithEntityContext['filter'] | null;
     /**
     Sort object in the following format:
     `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
-    Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+  
+    Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
     @maxSize: 5
     */
     sort?: {
         /**
-      Name of the field to sort by.
+      Field to sort by.
+    
+      Supported properties:
+      `id`, `buyerInfo.contactId`
       @maxLength: 512
       */
         fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
         /**
-      Sort order.
+      Sort order. Use `ASC` for ascending order or `DESC` for descending order.
+    
+      Default: `ASC`
       */
         order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
     }[];
@@ -3456,4 +3582,4 @@ declare const utils: {
     query: _wix_sdk_types.QueryHelpers<SubscriptionContract, SubscriptionContractQuerySpec, SubscriptionContractQuery>;
 };
 
-export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, type ActivityAuthor, type ActivityAuthorValueOneOf, ActivityType, type ActivityTypeWithLiterals, type AdditionalFee, type AdditionalFeeDelta, type AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, type CatalogReferenceOptionsBeforeChange, ChangeType, type ChangeTypeWithLiterals, type ChangesAppliedActivity, type ChangesAppliedActivityTargetOneOf, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommitSubscriptionContractChangesRequest, type CommitSubscriptionContractChangesResponse, type CommonQueryWithEntityContext, type ContractChange, type ContractChangeValueOneOf, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type CyclePriceOverride, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryProfileIdBeforeChange, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DescriptionLinesBeforeChange, type DigitalFile, type DigitalFileBeforeChange, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FulfillerIdBeforeChange, type FullAddressContactDetails, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImageBeforeChange, type InventoryAppIdBeforeChange, type ItemChangedDetails, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeBeforeChange, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemCyclePriceOverrides, type LineItemDelta, type LineItemDeltaDeltaDetailsOneOf, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type ModifierGroupsBeforeChange, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PhysicalPropertiesBeforeChange, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceDescriptionBeforeChange, type PriceSummary, type PriceUndeterminedBeforeChange, type ProductName, type ProductNameBeforeChange, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestockLocation, type RestoreInfo, type RootCatalogItemIdBeforeChange, type ServiceProperties, type ShippingGroupIdBeforeChange, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SpecificItemsCouponBehavior, type SpecificItemsCouponBehaviorWithLiterals, type StreetAddress, type SubscriptionCommitSettings, type SubscriptionContract, type SubscriptionContractActivity, type SubscriptionContractActivityContentOneOf, type SubscriptionContractActivityTargetOneOf, type SubscriptionContractCanceled, type SubscriptionContractChangesCommitted, type SubscriptionContractChargeUpcoming, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractDiffs, type SubscriptionContractExpired, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractSettings, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, type SubscriptionSettingsProductPeriodAlignmentWithLiterals, type SubscriptionTitle, type TaxInfoBeforeChange, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1CyclePriceOverride, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, type ActivityAuthor, type ActivityAuthorValueOneOf, ActivityType, type ActivityTypeWithLiterals, type AdditionalFee, type AdditionalFeeDelta, type AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type AdditionalFeeSummary, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, type CatalogReferenceOptionsBeforeChange, ChangeType, type ChangeTypeWithLiterals, type ChangesAppliedActivity, type ChangesAppliedActivityTargetOneOf, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommitSubscriptionContractChangesRequest, type CommitSubscriptionContractChangesResponse, type CommonQueryWithEntityContext, type ContractChange, type ContractChangeChangeDetailsOneOf, ContractChangeType, type ContractChangeTypeWithLiterals, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type CyclePriceOverride, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryProfileIdBeforeChange, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DescriptionLinesBeforeChange, type DigitalFile, type DigitalFileBeforeChange, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, type DiscountSummary, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FulfillerIdBeforeChange, type FullAddressContactDetails, type GetSubscriptionContractApplicationErrors, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImageBeforeChange, type InventoryAppIdBeforeChange, type ItemChangedDetails, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeBeforeChange, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemCyclePriceOverrides, type LineItemDelta, type LineItemDeltaDeltaDetailsOneOf, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemSummary, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type ModifierGroupsBeforeChange, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PhysicalPropertiesBeforeChange, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceDescriptionBeforeChange, type PriceSummary, type PriceUndeterminedBeforeChange, type ProductName, type ProductNameBeforeChange, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestockLocation, type RestoreInfo, type RootCatalogItemIdBeforeChange, type ServiceProperties, type ShippingGroupIdBeforeChange, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SpecificItemsCouponBehavior, type SpecificItemsCouponBehaviorWithLiterals, type StreetAddress, type SubscriptionCommitSettings, type SubscriptionContract, type SubscriptionContractActivity, type SubscriptionContractActivityContentOneOf, type SubscriptionContractActivityTargetOneOf, type SubscriptionContractCanceled, type SubscriptionContractChangesCommitted, type SubscriptionContractChargeUpcoming, type SubscriptionContractCommittedEnvelope, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractDiffs, type SubscriptionContractExpired, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractSettings, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, type SubscriptionSettingsProductPeriodAlignmentWithLiterals, type SubscriptionTitle, type TaxInfoBeforeChange, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1CyclePriceOverride, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCommitted, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };