@wix/auto_sdk_ecom_subscription-contracts 1.0.145 → 1.0.147

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -6,7 +6,7 @@ import { QuerySpec, Query, NonNullablePaths } from '@wix/sdk-types';
6
6
  *
7
7
  * 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.
8
8
  *
9
- * To change a subscription contract, create a draft subscription contract, edit it, and commit it.
9
+ * To change a subscription contract, create a [draft subscription contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/draft-subscription-contracts/introduction), edit it, and commit it.
10
10
  */
11
11
  interface SubscriptionContract {
12
12
  /**
@@ -241,9 +241,13 @@ interface V1SubscriptionSettings {
241
241
  }
242
242
  declare enum SubscriptionFrequency {
243
243
  UNDEFINED = "UNDEFINED",
244
+ /** Day. */
244
245
  DAY = "DAY",
246
+ /** Week. */
245
247
  WEEK = "WEEK",
248
+ /** Month. */
246
249
  MONTH = "MONTH",
250
+ /** Year. */
247
251
  YEAR = "YEAR"
248
252
  }
249
253
  /** @enumType */
@@ -519,6 +523,12 @@ interface OrderLineItem {
519
523
  * @readonly
520
524
  */
521
525
  serviceProperties?: ServiceProperties;
526
+ /**
527
+ * Cross-border repricing record of this line item on a site whose catalog prices include tax: the catalog price, the base region's tax removed from it and the rate used.
528
+ * @internal
529
+ * @readonly
530
+ */
531
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
522
532
  }
523
533
  interface ProductName {
524
534
  /**
@@ -938,10 +948,16 @@ interface DigitalFile {
938
948
  interface SubscriptionInfo {
939
949
  /**
940
950
  * Subscription ID.
951
+ *
952
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
953
+ * To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
941
954
  * @format GUID
942
955
  */
943
956
  _id?: string | null;
944
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
957
+ /**
958
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
959
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
960
+ */
945
961
  cycleNumber?: number;
946
962
  /**
947
963
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -1017,7 +1033,7 @@ interface SubscriptionDescription {
1017
1033
  translated?: string | null;
1018
1034
  }
1019
1035
  interface SubscriptionSettings {
1020
- /** Frequency of recurring payment. */
1036
+ /** Frequency unit of the billing cycle. */
1021
1037
  frequency?: V2SubscriptionFrequencyWithLiterals;
1022
1038
  /**
1023
1039
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -1025,16 +1041,20 @@ interface SubscriptionSettings {
1025
1041
  * @max 3650
1026
1042
  */
1027
1043
  interval?: number | null;
1028
- /** Whether subscription is renewed automatically at the end of each period. */
1044
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
1029
1045
  autoRenewal?: boolean;
1030
1046
  /**
1031
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1047
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
1032
1048
  * @min 1
1033
1049
  */
1034
1050
  billingCycles?: number | null;
1035
- /** Whether to allow the customer to cancel the subscription. */
1051
+ /** Whether the buyer can cancel the subscription. */
1036
1052
  enableCustomerCancellation?: boolean;
1037
- /** Period until first cycle starts. If None => no free trial */
1053
+ /**
1054
+ * Free trial period before the first billing cycle starts.
1055
+ *
1056
+ * Returned only when the subscription has a free trial.
1057
+ */
1038
1058
  freeTrialPeriod?: FreeTrialPeriod;
1039
1059
  /**
1040
1060
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1063,7 +1083,7 @@ declare enum V2SubscriptionFrequency {
1063
1083
  /** @enumType */
1064
1084
  type V2SubscriptionFrequencyWithLiterals = V2SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1065
1085
  interface FreeTrialPeriod {
1066
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1086
+ /** Frequency unit of the free trial period. */
1067
1087
  frequency?: V2SubscriptionFrequencyWithLiterals;
1068
1088
  /**
1069
1089
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -1348,6 +1368,76 @@ interface ServiceProperties {
1348
1368
  */
1349
1369
  endDate?: Date | null;
1350
1370
  }
1371
+ /**
1372
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1373
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1374
+ *
1375
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1376
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1377
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1378
+ */
1379
+ interface CrossBorderPriceAdjustment {
1380
+ /**
1381
+ * ID of the tax region whose tax is built into the catalog prices.
1382
+ * @format GUID
1383
+ */
1384
+ baseTaxRegionId?: string;
1385
+ /**
1386
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1387
+ * @format GUID
1388
+ */
1389
+ destinationTaxRegionId?: string | null;
1390
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1391
+ catalogPrice?: Price;
1392
+ /** Base region's tax removed per unit. Zero when `status` is `KEPT`, `SAME_REGION`, `SAME_COUNTRY`, `NOT_APPLICABLE`, `NOT_APPLICABLE_MODIFIERS` or `CONVERTED_CURRENCY_SUBSCRIPTION`, where nothing was removed. */
1393
+ baseTaxAmount?: Price;
1394
+ /** Outcome of the repricing for this line. */
1395
+ status?: RepriceStatusWithLiterals;
1396
+ /** Where the base region's rate came from. Meaningful only when a rate was applied, that is when `status` is `APPLIED`, `STRIP_ONLY` or `NO_DESTINATION_REGION`. */
1397
+ baseRateSource?: BaseRateSourceWithLiterals;
1398
+ /**
1399
+ * Base region's rate used to remove the tax, as a decimal numeral between 0 and 1. For example, `"0.22"`. Absent when no rate was applied.
1400
+ * @format DECIMAL_VALUE
1401
+ * @decimalValue options { gte:0, maxScale:6 }
1402
+ */
1403
+ baseRate?: string | null;
1404
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1405
+ baseRateCapturedDate?: Date | null;
1406
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1407
+ destinationTaxIncluded?: boolean | null;
1408
+ }
1409
+ /** Outcome of the repricing for one line. */
1410
+ declare enum RepriceStatus {
1411
+ /** Base tax removed and the destination's tax applied. */
1412
+ APPLIED = "APPLIED",
1413
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1414
+ KEPT = "KEPT",
1415
+ /** Base tax removed and no destination tax applied, as in a tax-exempt calculation. This is the outcome; the mode that asks for it is `CrossBorderRepricingMode.STRIP_ONLY`. */
1416
+ STRIP_ONLY = "STRIP_ONLY",
1417
+ /** The destination is the base region. Nothing was removed. */
1418
+ SAME_REGION = "SAME_REGION",
1419
+ /** The destination is in the base region's country, outside the US and Canada, so the catalog price already carries the destination's tax. Nothing was removed. */
1420
+ SAME_COUNTRY = "SAME_COUNTRY",
1421
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1422
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1423
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1424
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1425
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1426
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1427
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1428
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1429
+ }
1430
+ /** @enumType */
1431
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1432
+ /** Where the base region's rate came from. */
1433
+ declare enum BaseRateSource {
1434
+ /** The manual tax calculator computed the base tax for this calculation. */
1435
+ MANUAL_SPI = "MANUAL_SPI",
1436
+ /** The rate captured from Avalara by the embedded-rate probe. */
1437
+ AVALARA_PROBE = "AVALARA_PROBE"
1438
+ }
1439
+ /** @enumType */
1440
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1351
1441
  /** Buyer information. */
1352
1442
  interface BuyerInfo extends BuyerInfoIdOneOf {
1353
1443
  /**
@@ -1766,6 +1856,12 @@ interface ShippingPrice {
1766
1856
  * @readonly
1767
1857
  */
1768
1858
  discount?: Price;
1859
+ /**
1860
+ * Cross-border repricing record of the shipping cost on a site whose catalog prices include tax.
1861
+ * @internal
1862
+ * @readonly
1863
+ */
1864
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
1769
1865
  }
1770
1866
  interface ShippingRegion {
1771
1867
  /**
@@ -1802,6 +1898,12 @@ interface OrderTaxInfo {
1802
1898
  * @readonly
1803
1899
  */
1804
1900
  totalExempt?: Price;
1901
+ /**
1902
+ * Cross-border repricing outcome of the last calculation that produced this tax: whether the lines were repriced for the destination's tax, in which mode, and when they weren't, why. Replaced on every edit, unlike the order's `crossBorderRepricing` marker.
1903
+ * @internal
1904
+ * @readonly
1905
+ */
1906
+ crossBorderCalculation?: CrossBorderCalculation;
1805
1907
  }
1806
1908
  /**
1807
1909
  * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
@@ -1844,6 +1946,56 @@ interface OrderTaxBreakdown {
1844
1946
  */
1845
1947
  aggregatedExemptAmount?: Price;
1846
1948
  }
1949
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1950
+ interface CrossBorderCalculation {
1951
+ /** Whether the calculation repriced the lines for the destination's tax. */
1952
+ applied?: boolean;
1953
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
1954
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
1955
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
1956
+ mode?: CrossBorderRepricingModeWithLiterals;
1957
+ /**
1958
+ * Request ID of the calculation, for log correlation.
1959
+ * @maxLength 100
1960
+ */
1961
+ requestId?: string | null;
1962
+ }
1963
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
1964
+ declare enum CrossBorderNotApplicableReason {
1965
+ /** The repricing feature toggle is off. */
1966
+ FEATURE_DISABLED = "FEATURE_DISABLED",
1967
+ /** The site hasn't opted in to cross-border repricing. */
1968
+ NOT_OPTED_IN = "NOT_OPTED_IN",
1969
+ /** The site's prices no longer include tax. */
1970
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
1971
+ /** The base tax region doesn't exist on the site. */
1972
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
1973
+ /** The base region uses the manual calculator and has no tax mapping. */
1974
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
1975
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
1976
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
1977
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
1978
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
1979
+ /** The line items were repriced. Repricing the shipping option failed. */
1980
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
1981
+ /** The line items were repriced. Repricing the additional fees failed. */
1982
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
1983
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
1984
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
1985
+ }
1986
+ /** @enumType */
1987
+ type CrossBorderNotApplicableReasonWithLiterals = CrossBorderNotApplicableReason | 'FEATURE_DISABLED' | 'NOT_OPTED_IN' | 'TAX_INCLUSIVE_PRICING_OFF' | 'BASE_TAX_REGION_NOT_FOUND' | 'BASE_REGION_HAS_NO_MANUAL_MAPPING' | 'EMBEDDED_RATE_MISSING' | 'CROSS_BORDER_REPRICING_FAILED' | 'SHIPPING_REPRICING_FAILED' | 'FEES_REPRICING_FAILED' | 'SETTINGS_UNAVAILABLE';
1988
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
1989
+ declare enum CrossBorderRepricingMode {
1990
+ /** Nothing is repriced. */
1991
+ DISABLED = "DISABLED",
1992
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
1993
+ STRIP_ONLY = "STRIP_ONLY",
1994
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
1995
+ FULL = "FULL"
1996
+ }
1997
+ /** @enumType */
1998
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1847
1999
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1848
2000
  /** Coupon applied by the customer. */
1849
2001
  coupon?: Coupon;
@@ -2204,6 +2356,12 @@ interface AdditionalFee {
2204
2356
  source?: AdditionalFeeSourceWithLiterals;
2205
2357
  /** Address type tax was calculated against for this fee. */
2206
2358
  taxableAddress?: TaxableAddress;
2359
+ /**
2360
+ * Cross-border repricing record of the fee on a site whose catalog prices include tax.
2361
+ * @internal
2362
+ * @readonly
2363
+ */
2364
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
2207
2365
  }
2208
2366
  declare enum AdditionalFeeSource {
2209
2367
  /** The additional fee was added by an additional fee service plugin. */
@@ -2553,7 +2711,7 @@ interface SubscriptionContractChangesCommitted {
2553
2711
  * @maxLength 200
2554
2712
  */
2555
2713
  reason?: string | null;
2556
- /** Price summary of the contract after the commit. */
2714
+ /** Price summary of the subscription contract after the commit. Same as `changes.priceSummary`. */
2557
2715
  priceSummary?: PriceSummary;
2558
2716
  }
2559
2717
  interface SubscriptionContractDiffs {
@@ -2580,7 +2738,7 @@ interface SubscriptionContractDiffs {
2580
2738
  additionalFees?: AdditionalFeeDelta[];
2581
2739
  /** Price summary after the changes. Replaces the subscription contract's previous price summary. */
2582
2740
  priceSummary?: PriceSummary;
2583
- /** Tax information after the changes. Replaces the subscription contract's previous tax information. */
2741
+ /** Tax information after the changes. */
2584
2742
  taxInfo?: OrderTaxInfo;
2585
2743
  /** Shipping information after the changes. Replaces the subscription contract's previous shipping information. */
2586
2744
  shippingInfo?: ShippingInformation;
@@ -2603,104 +2761,104 @@ interface LineItemDeltaDeltaDetailsOneOf {
2603
2761
  /** Values the line item had before the change. */
2604
2762
  changed?: ItemChangedDetails;
2605
2763
  }
2606
- /** The catalog reference options before the change. */
2764
+ /** Catalog reference options before the change. */
2607
2765
  interface CatalogReferenceOptionsBeforeChange {
2608
- /** The catalog reference options. Absent when the line item had no options. */
2766
+ /** Catalog reference options. Absent when the line item had no options. */
2609
2767
  options?: Record<string, any> | null;
2610
2768
  }
2611
- /** The product name before the change. */
2769
+ /** Product name before the change. */
2612
2770
  interface ProductNameBeforeChange {
2613
- /** The product name. Absent when the line item had no product name. */
2771
+ /** Product name. Absent when the line item had no product name. */
2614
2772
  productName?: ProductName;
2615
2773
  }
2616
- /** The description lines before the change. */
2774
+ /** Description lines before the change. */
2617
2775
  interface DescriptionLinesBeforeChange {
2618
2776
  /**
2619
- * The description lines. Empty when the line item had no description lines.
2777
+ * Description lines. Empty when the line item had no description lines.
2620
2778
  * @maxSize 20
2621
2779
  */
2622
2780
  descriptionLines?: DescriptionLine[];
2623
2781
  }
2624
- /** The image before the change. */
2782
+ /** Image before the change. */
2625
2783
  interface ImageBeforeChange {
2626
- /** The image. Absent when the line item had no image. */
2784
+ /** Image. Absent when the line item had no image. */
2627
2785
  image?: string;
2628
2786
  }
2629
- /** The physical properties before the change. */
2787
+ /** Physical properties before the change. */
2630
2788
  interface PhysicalPropertiesBeforeChange {
2631
- /** The physical properties. Absent when the line item had no physical properties. */
2789
+ /** Physical properties. Absent when the line item had no physical properties. */
2632
2790
  physicalProperties?: PhysicalProperties;
2633
2791
  }
2634
- /** The item type before the change. */
2792
+ /** Item type before the change. */
2635
2793
  interface ItemTypeBeforeChange {
2636
- /** The item type. Absent when the line item had no item type. */
2794
+ /** Item type. Absent when the line item had no item type. */
2637
2795
  itemType?: ItemType;
2638
2796
  }
2639
- /** The fulfiller ID before the change. */
2797
+ /** Fulfiller ID before the change. */
2640
2798
  interface FulfillerIdBeforeChange {
2641
2799
  /**
2642
- * The fulfiller ID. Absent when the line item had no fulfiller.
2800
+ * Fulfiller ID. Absent when the line item had no fulfiller.
2643
2801
  * @format GUID
2644
2802
  */
2645
2803
  fulfillerId?: string | null;
2646
2804
  }
2647
- /** The digital file before the change. */
2805
+ /** Digital file before the change. */
2648
2806
  interface DigitalFileBeforeChange {
2649
- /** The digital file. Absent when the line item had no digital file. */
2807
+ /** Digital file. Absent when the line item had no digital file. */
2650
2808
  digitalFile?: DigitalFile;
2651
2809
  }
2652
- /** The price description before the change. */
2810
+ /** Price description before the change. */
2653
2811
  interface PriceDescriptionBeforeChange {
2654
- /** The price description. Absent when the line item had no price description. */
2812
+ /** Price description. Absent when the line item had no price description. */
2655
2813
  priceDescription?: PriceDescription;
2656
2814
  }
2657
- /** The delivery profile ID before the change. */
2815
+ /** Delivery profile ID before the change. */
2658
2816
  interface DeliveryProfileIdBeforeChange {
2659
2817
  /**
2660
- * The delivery profile ID. Absent when the line item had no delivery profile.
2818
+ * Delivery profile ID. Absent when the line item had no delivery profile.
2661
2819
  * @format GUID
2662
2820
  */
2663
2821
  deliveryProfileId?: string | null;
2664
2822
  }
2665
- /** The shipping group ID before the change. */
2823
+ /** Shipping group ID before the change. */
2666
2824
  interface ShippingGroupIdBeforeChange {
2667
2825
  /**
2668
- * The shipping group ID. Absent when the line item had no shipping group.
2826
+ * Shipping group ID. Absent when the line item had no shipping group.
2669
2827
  * @format GUID
2670
2828
  */
2671
2829
  shippingGroupId?: string | null;
2672
2830
  }
2673
- /** The tax info before the change. */
2831
+ /** Tax info before the change. */
2674
2832
  interface TaxInfoBeforeChange {
2675
- /** The tax info. Absent when the line item had no tax info. */
2833
+ /** Tax info. Absent when the line item had no tax info. */
2676
2834
  taxInfo?: LineItemTaxInfo;
2677
2835
  }
2678
- /** The inventory app ID before the change. */
2836
+ /** Inventory app ID before the change. */
2679
2837
  interface InventoryAppIdBeforeChange {
2680
2838
  /**
2681
- * The inventory app ID. Absent when the line item had no inventory app.
2839
+ * Inventory app ID. Absent when the line item had no inventory app.
2682
2840
  * @format GUID
2683
2841
  */
2684
2842
  inventoryAppId?: string | null;
2685
2843
  }
2686
- /** The root catalog item ID before the change. */
2844
+ /** Root catalog item ID before the change. */
2687
2845
  interface RootCatalogItemIdBeforeChange {
2688
2846
  /**
2689
- * The root catalog item ID. Absent when the line item had no root catalog item.
2847
+ * Root catalog item ID. Absent when the line item had no root catalog item.
2690
2848
  * @minLength 1
2691
2849
  * @maxLength 36
2692
2850
  */
2693
2851
  rootCatalogItemId?: string | null;
2694
2852
  }
2695
- /** The modifier groups before the change. */
2853
+ /** Modifier groups before the change. */
2696
2854
  interface ModifierGroupsBeforeChange {
2697
2855
  /**
2698
- * The modifier groups. Empty when the line item had no modifier groups.
2856
+ * Modifier groups. Empty when the line item had no modifier groups.
2699
2857
  * @maxSize 10
2700
2858
  */
2701
2859
  modifierGroups?: ModifierGroup[];
2702
2860
  }
2703
- /** The price undetermined flag before the change. */
2861
+ /** Price undetermined flag before the change. */
2704
2862
  interface PriceUndeterminedBeforeChange {
2705
2863
  /** Whether the price of the line item was undetermined. */
2706
2864
  priceUndetermined?: boolean;
@@ -2720,56 +2878,56 @@ declare enum ChangeType {
2720
2878
  type ChangeTypeWithLiterals = ChangeType | 'UNKNOWN_CHANGE_TYPE' | 'ADDED' | 'CHANGED' | 'REMOVED';
2721
2879
  interface ItemChangedDetails {
2722
2880
  /**
2723
- * The quantity before the change. Set only when the quantity changed.
2881
+ * Quantity before the change. Set only when the quantity changed.
2724
2882
  * @min 1
2725
2883
  * @max 1000000
2726
2884
  */
2727
2885
  quantityBeforeChange?: number | null;
2728
- /** The price before the change. Set only when the price changed. */
2886
+ /** Price before the change. Set only when the price changed. */
2729
2887
  priceBeforeChange?: Price;
2730
- /** The catalog reference options before the change. Set only when the catalog reference options changed. */
2888
+ /** Catalog reference options before the change. Set only when the catalog reference options changed. */
2731
2889
  catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
2732
- /** The product name before the change. Set only when the product name changed. */
2890
+ /** Product name before the change. Set only when the product name changed. */
2733
2891
  productNameBeforeChange?: ProductNameBeforeChange;
2734
- /** The description lines before the change. Set only when the description lines changed. */
2892
+ /** Description lines before the change. Set only when the description lines changed. */
2735
2893
  descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
2736
- /** The image before the change. Set only when the image changed. */
2894
+ /** Image before the change. Set only when the image changed. */
2737
2895
  imageBeforeChange?: ImageBeforeChange;
2738
- /** The physical properties before the change. Set only when the physical properties changed. */
2896
+ /** Physical properties before the change. Set only when the physical properties changed. */
2739
2897
  physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
2740
- /** The item type before the change. Set only when the item type changed. */
2898
+ /** Item type before the change. Set only when the item type changed. */
2741
2899
  itemTypeBeforeChange?: ItemTypeBeforeChange;
2742
- /** The fulfiller ID before the change. Set only when the fulfiller ID changed. */
2900
+ /** Fulfiller ID before the change. Set only when the fulfiller ID changed. */
2743
2901
  fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
2744
- /** The digital file before the change. Set only when the digital file changed. */
2902
+ /** Digital file before the change. Set only when the digital file changed. */
2745
2903
  digitalFileBeforeChange?: DigitalFileBeforeChange;
2746
- /** The price description before the change. Set only when the price description changed. */
2904
+ /** Price description before the change. Set only when the price description changed. */
2747
2905
  priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
2748
2906
  /**
2749
- * The delivery profile ID before the change. Set only when the delivery profile ID changed.
2907
+ * Delivery profile ID before the change. Set only when the delivery profile ID changed.
2750
2908
  * @internal
2751
2909
  */
2752
2910
  deliveryProfileIdBeforeChange?: DeliveryProfileIdBeforeChange;
2753
2911
  /**
2754
- * The shipping group ID before the change. Set only when the shipping group ID changed.
2912
+ * Shipping group ID before the change. Set only when the shipping group ID changed.
2755
2913
  * @internal
2756
2914
  */
2757
2915
  shippingGroupIdBeforeChange?: ShippingGroupIdBeforeChange;
2758
- /** The tax info before the change. Set only when the line item's tax group changed because its catalog options changed. */
2916
+ /** Tax info before the change. Set only when the line item's tax group changed. */
2759
2917
  taxInfoBeforeChange?: TaxInfoBeforeChange;
2760
2918
  /**
2761
- * The inventory app ID before the change. Set only when the inventory app ID changed.
2919
+ * Inventory app ID before the change. Set only when the inventory app ID changed.
2762
2920
  * @internal
2763
2921
  */
2764
2922
  inventoryAppIdBeforeChange?: InventoryAppIdBeforeChange;
2765
2923
  /**
2766
- * The root catalog item ID before the change. Set only when the root catalog item ID changed.
2924
+ * Root catalog item ID before the change. Set only when the root catalog item ID changed.
2767
2925
  * @internal
2768
2926
  */
2769
2927
  rootCatalogItemIdBeforeChange?: RootCatalogItemIdBeforeChange;
2770
- /** The modifier groups before the change. Set only when the modifier groups changed. */
2928
+ /** Modifier groups before the change. Set only when the modifier groups changed. */
2771
2929
  modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
2772
- /** The price undetermined flag before the change. Set only when the price undetermined flag changed. */
2930
+ /** Price undetermined flag before the change. Set only when the price undetermined flag changed. */
2773
2931
  priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
2774
2932
  }
2775
2933
  interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
@@ -3582,4 +3740,4 @@ declare const utils: {
3582
3740
  query: _wix_sdk_types.QueryHelpers<SubscriptionContract, SubscriptionContractQuerySpec, SubscriptionContractQuery>;
3583
3741
  };
3584
3742
 
3585
- 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 };
3743
+ 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, BaseRateSource, type BaseRateSourceWithLiterals, 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 CrossBorderCalculation, CrossBorderNotApplicableReason, type CrossBorderNotApplicableReasonWithLiterals, type CrossBorderPriceAdjustment, CrossBorderRepricingMode, type CrossBorderRepricingModeWithLiterals, 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, RepriceStatus, type RepriceStatusWithLiterals, 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 };