@wix/auto_sdk_ecom_subscription-contracts 1.0.144 → 1.0.146

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.
@@ -2,33 +2,31 @@ import { GetSubscriptionContractRequest as GetSubscriptionContractRequest$1, Get
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
5
- * A SubscriptionContract is a ...
6
- * You can ...
7
- * Read more about SubscriptionContracts
8
- * in this [article](<LINK_TO_KB_ARTICLE>).
5
+ * 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.
6
+ *
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
+ *
9
+ * To change a subscription contract, create a draft subscription contract, edit it, and commit it.
9
10
  */
10
11
  interface SubscriptionContract {
11
12
  /**
12
- * SubscriptionContract ID.
13
+ * Subscription contract ID.
13
14
  * @format GUID
14
15
  * @readonly
15
16
  */
16
17
  id?: string | null;
17
18
  /**
18
- * Revision number, which increments by 1 each time the SubscriptionContract is updated.
19
- * To prevent conflicting changes, the current revision must be passed when updating the SubscriptionContract.
20
- *
21
- * Ignored when creating a SubscriptionOrderContract.
19
+ * Revision number, which increments by 1 each time the subscription contract is updated.
22
20
  * @readonly
23
21
  */
24
22
  revision?: string | null;
25
23
  /**
26
- * Date and time the subscription contract was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
24
+ * Date and time the subscription contract was created.
27
25
  * @readonly
28
26
  */
29
27
  createdDate?: Date | null;
30
28
  /**
31
- * 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.
29
+ * Date and time the subscription contract was last updated.
32
30
  * @readonly
33
31
  */
34
32
  updatedDate?: Date | null;
@@ -40,10 +38,24 @@ interface SubscriptionContract {
40
38
  * @targetRemovalDate 2025-10-01
41
39
  */
42
40
  description?: string | null;
43
- /** Subscription detailed information. */
41
+ /**
42
+ * Subscription description, in the site's default language and translated into the buyer's language. For example, `"1kg of selected coffee, once a month"`.
43
+ *
44
+ * For a subscription contract with more than one line item, holds a general name for the subscription.
45
+ */
46
+ subscriptionDescription?: V1SubscriptionDescription;
47
+ /** Subscription terms, such as the billing frequency, the number of billing cycles, and whether the subscription renews automatically. */
44
48
  subscriptionSettings?: V1SubscriptionSettings;
45
49
  /**
46
- * Order line items.
50
+ * Subscription line items. The order for each billing cycle is created with these line items.
51
+ *
52
+ * In a subscription contract:
53
+ * + `lineItems.subscriptionInfo.id` is the subscription contract's own ID.
54
+ * + `lineItems.subscriptionInfo.cycleNumber` is always `0`. The billing cycle is set on the line items of each cycle's order.
55
+ * + `subscriptionInfo.title` and `subscriptionInfo.description` hold the subscription contract's title and description, not the line item's own subscription option.
56
+ * + `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.
57
+ * + `extendedFields` and `decimalQuantity` aren't returned.
58
+ * + When coupons were included in item prices at checkout, `price` is the price before coupons, and the coupons are in `appliedDiscounts`.
47
59
  * @minSize 1
48
60
  * @maxSize 100
49
61
  */
@@ -51,20 +63,25 @@ interface SubscriptionContract {
51
63
  /** Buyer information. */
52
64
  buyerInfo?: BuyerInfo;
53
65
  /**
54
- * Language for communication with the buyer. Defaults to the site language.
55
- * For a site that supports multiple languages, this is the language the buyer selected.
66
+ * Language for communication with the buyer. For a site that supports multiple languages, this is the language the buyer selected.
67
+ *
68
+ * Default: Site language
56
69
  * @maxLength 10
57
70
  */
58
71
  buyerLanguage?: string | null;
59
- /** Weight measurement unit - defaults to site's weight unit. */
72
+ /**
73
+ * Weight measurement unit.
74
+ *
75
+ * Default: Site's weight unit
76
+ */
60
77
  weightUnit?: WeightUnitWithLiterals;
61
78
  /**
62
- * 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.
79
+ * 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.
63
80
  * @format CURRENCY
64
81
  * @immutable
65
82
  */
66
83
  currency?: string | null;
67
- /** Multi-currency information of the subscription. conversionRate may reflect updated exchange rate on created order per recurring cycle. */
84
+ /** Multi-currency details for a subscription paid in a currency other than the site's currency. */
68
85
  currencyConversionDetails?: CurrencyConversionDetails;
69
86
  /**
70
87
  * Whether tax is included in line item prices.
@@ -74,22 +91,26 @@ interface SubscriptionContract {
74
91
  */
75
92
  taxIncludedInPrices?: boolean;
76
93
  /**
77
- * Order price summary.
94
+ * Price summary of a single billing cycle.
78
95
  * @readonly
79
96
  */
80
97
  priceSummary?: PriceSummary;
81
- /** Summary of platform fees for this subscription contract, including totals by charge type and a breakdown of individual fees. */
98
+ /**
99
+ * Summary of platform fees calculated at checkout, including totals by charge type and a breakdown of individual fees.
100
+ *
101
+ * Not updated when draft changes are committed. Each billing cycle's order holds the platform fees for that cycle.
102
+ */
82
103
  platformFeeSummary?: PlatformFeeSummary;
83
104
  /** Billing address and contact details. */
84
105
  billingInfo?: AddressWithContact;
85
- /** Shipping info and selected shipping option details. */
106
+ /** Shipping information and selected shipping option details. */
86
107
  shippingInfo?: ShippingInformation;
87
108
  /**
88
- * Applied discounts.
109
+ * Discounts applied to the subscription contract.
89
110
  * @maxSize 100
90
111
  */
91
112
  appliedDiscounts?: AppliedDiscount[];
92
- /** Information about the sales channel that submitted this order. */
113
+ /** Information about the sales channel the subscription was purchased through. */
93
114
  channelInfo?: ChannelInfo;
94
115
  /**
95
116
  * Custom fields.
@@ -97,7 +118,7 @@ interface SubscriptionContract {
97
118
  */
98
119
  customFields?: CustomField[];
99
120
  /**
100
- * Order recipient address and contact details.
121
+ * Recipient address and contact details.
101
122
  *
102
123
  * This field may differ from the address in `shippingInfo.logistics` when:
103
124
  * + The chosen shipping option is pickup point or store pickup.
@@ -107,7 +128,7 @@ interface SubscriptionContract {
107
128
  /**
108
129
  * Custom field data for the subscription contract object.
109
130
  *
110
- * [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.
131
+ * [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.
111
132
  */
112
133
  extendedFields?: ExtendedFields;
113
134
  /**
@@ -119,31 +140,31 @@ interface SubscriptionContract {
119
140
  */
120
141
  title?: string | null;
121
142
  /**
122
- * Additional fees applied to subscription contract.
123
- * @maxSize 100
143
+ * Subscription title, in the site's default language and translated into the buyer's language. For example, `"Monthly coffee subscription"`.
144
+ *
145
+ * For a subscription contract with more than one line item, holds a general name for the subscription.
124
146
  */
125
- additionalFees?: AdditionalFee[];
147
+ subscriptionTitle?: V1SubscriptionTitle;
126
148
  /**
127
- * Activities recorded on this contract (e.g. draft commits, status changes).
128
- * @readonly
129
- * @maxSize 500
149
+ * Additional fees applied to the subscription contract.
150
+ * @maxSize 100
130
151
  */
131
- activities?: SubscriptionContractActivity[];
152
+ additionalFees?: AdditionalFee[];
132
153
  }
133
154
  interface V1SubscriptionDescription {
134
155
  /**
135
- * Subscription option description.
156
+ * Subscription description in the site's default language.
136
157
  * @maxLength 500
137
158
  */
138
159
  original?: string;
139
160
  /**
140
- * Translated subscription option description.
161
+ * Subscription description translated into the buyer's language.
141
162
  * @maxLength 500
142
163
  */
143
164
  translated?: string | null;
144
165
  }
145
166
  interface V1SubscriptionSettings {
146
- /** Frequency of recurring payment. */
167
+ /** Frequency unit of the billing cycle. */
147
168
  frequency?: SubscriptionFrequencyWithLiterals;
148
169
  /**
149
170
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -151,16 +172,20 @@ interface V1SubscriptionSettings {
151
172
  * @max 3650
152
173
  */
153
174
  interval?: number | null;
154
- /** Whether subscription is renewed automatically at the end of each period. */
175
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
155
176
  autoRenewal?: boolean;
156
177
  /**
157
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
178
+ * Number of billing cycles before the subscription ends.
158
179
  * @min 1
159
180
  */
160
181
  billingCycles?: number | null;
161
- /** Whether to allow the customer to cancel the subscription. */
182
+ /** Whether the buyer can cancel the subscription. */
162
183
  enableCustomerCancellation?: boolean;
163
- /** Period until first cycle starts. If None => no free trial */
184
+ /**
185
+ * Free trial period before the first billing cycle starts.
186
+ *
187
+ * Returned only when the subscription has a free trial.
188
+ */
164
189
  freeTrialPeriod?: V1FreeTrialPeriod;
165
190
  }
166
191
  declare enum SubscriptionFrequency {
@@ -173,7 +198,7 @@ declare enum SubscriptionFrequency {
173
198
  /** @enumType */
174
199
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
175
200
  interface V1FreeTrialPeriod {
176
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
201
+ /** Frequency unit of the free trial period. */
177
202
  frequency?: SubscriptionFrequencyWithLiterals;
178
203
  /**
179
204
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -1123,6 +1148,76 @@ interface ServiceProperties {
1123
1148
  */
1124
1149
  numberOfParticipants?: number | null;
1125
1150
  }
1151
+ /**
1152
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1153
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1154
+ *
1155
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1156
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1157
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1158
+ */
1159
+ interface CrossBorderPriceAdjustment {
1160
+ /**
1161
+ * ID of the tax region whose tax is built into the catalog prices.
1162
+ * @format GUID
1163
+ */
1164
+ baseTaxRegionId?: string;
1165
+ /**
1166
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1167
+ * @format GUID
1168
+ */
1169
+ destinationTaxRegionId?: string | null;
1170
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1171
+ catalogPrice?: Price;
1172
+ /** 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. */
1173
+ baseTaxAmount?: Price;
1174
+ /** Outcome of the repricing for this line. */
1175
+ status?: RepriceStatusWithLiterals;
1176
+ /** 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`. */
1177
+ baseRateSource?: BaseRateSourceWithLiterals;
1178
+ /**
1179
+ * 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.
1180
+ * @format DECIMAL_VALUE
1181
+ * @decimalValue options { gte:0, maxScale:6 }
1182
+ */
1183
+ baseRate?: string | null;
1184
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1185
+ baseRateCapturedDate?: Date | null;
1186
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1187
+ destinationTaxIncluded?: boolean | null;
1188
+ }
1189
+ /** Outcome of the repricing for one line. */
1190
+ declare enum RepriceStatus {
1191
+ /** Base tax removed and the destination's tax applied. */
1192
+ APPLIED = "APPLIED",
1193
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1194
+ KEPT = "KEPT",
1195
+ /** 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`. */
1196
+ STRIP_ONLY = "STRIP_ONLY",
1197
+ /** The destination is the base region. Nothing was removed. */
1198
+ SAME_REGION = "SAME_REGION",
1199
+ /** 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. */
1200
+ SAME_COUNTRY = "SAME_COUNTRY",
1201
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1202
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1203
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1204
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1205
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1206
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1207
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1208
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1209
+ }
1210
+ /** @enumType */
1211
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1212
+ /** Where the base region's rate came from. */
1213
+ declare enum BaseRateSource {
1214
+ /** The manual tax calculator computed the base tax for this calculation. */
1215
+ MANUAL_SPI = "MANUAL_SPI",
1216
+ /** The rate captured from Avalara by the embedded-rate probe. */
1217
+ AVALARA_PROBE = "AVALARA_PROBE"
1218
+ }
1219
+ /** @enumType */
1220
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1126
1221
  /** Buyer information. */
1127
1222
  interface BuyerInfo extends BuyerInfoIdOneOf {
1128
1223
  /**
@@ -1566,6 +1661,56 @@ interface OrderTaxBreakdown {
1566
1661
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1567
1662
  aggregatedTaxAmount?: Price;
1568
1663
  }
1664
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1665
+ interface CrossBorderCalculation {
1666
+ /** Whether the calculation repriced the lines for the destination's tax. */
1667
+ applied?: boolean;
1668
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
1669
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
1670
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
1671
+ mode?: CrossBorderRepricingModeWithLiterals;
1672
+ /**
1673
+ * Request ID of the calculation, for log correlation.
1674
+ * @maxLength 100
1675
+ */
1676
+ requestId?: string | null;
1677
+ }
1678
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
1679
+ declare enum CrossBorderNotApplicableReason {
1680
+ /** The repricing feature toggle is off. */
1681
+ FEATURE_DISABLED = "FEATURE_DISABLED",
1682
+ /** The site hasn't opted in to cross-border repricing. */
1683
+ NOT_OPTED_IN = "NOT_OPTED_IN",
1684
+ /** The site's prices no longer include tax. */
1685
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
1686
+ /** The base tax region doesn't exist on the site. */
1687
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
1688
+ /** The base region uses the manual calculator and has no tax mapping. */
1689
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
1690
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
1691
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
1692
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
1693
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
1694
+ /** The line items were repriced. Repricing the shipping option failed. */
1695
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
1696
+ /** The line items were repriced. Repricing the additional fees failed. */
1697
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
1698
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
1699
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
1700
+ }
1701
+ /** @enumType */
1702
+ 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';
1703
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
1704
+ declare enum CrossBorderRepricingMode {
1705
+ /** Nothing is repriced. */
1706
+ DISABLED = "DISABLED",
1707
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
1708
+ STRIP_ONLY = "STRIP_ONLY",
1709
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
1710
+ FULL = "FULL"
1711
+ }
1712
+ /** @enumType */
1713
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1569
1714
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1570
1715
  /** Coupon applied by the customer. */
1571
1716
  coupon?: Coupon;
@@ -1802,15 +1947,13 @@ interface CustomField {
1802
1947
  }
1803
1948
  interface V1SubscriptionTitle {
1804
1949
  /**
1805
- * 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).
1950
+ * Subscription title in the site's default language.
1806
1951
  * @minLength 1
1807
1952
  * @maxLength 150
1808
1953
  */
1809
1954
  original?: string;
1810
1955
  /**
1811
- * Subscription option name translated into the buyer's language.
1812
- *
1813
- * Default: Same as `original`.
1956
+ * Subscription title translated into the buyer's language.
1814
1957
  * @minLength 1
1815
1958
  * @maxLength 150
1816
1959
  */
@@ -1913,7 +2056,7 @@ declare enum SpecificItemsCouponBehavior {
1913
2056
  /** @enumType */
1914
2057
  type SpecificItemsCouponBehaviorWithLiterals = SpecificItemsCouponBehavior | 'UNDEFINED_COUPON_BEHAVIOR' | 'ITEM_SUBTOTAL_INCLUDES_DISCOUNT' | 'LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT';
1915
2058
  interface SubscriptionContractActivity extends SubscriptionContractActivityTargetOneOf, SubscriptionContractActivityContentOneOf {
1916
- /** Scopes the draft to the contract level, applying to all future cycles. */
2059
+ /** The activity applies to all future billing cycles of the subscription contract. */
1917
2060
  contractTarget?: ContractTarget;
1918
2061
  /** Changes committed from a DraftSubscriptionContract. */
1919
2062
  changesApplied?: ChangesAppliedActivity;
@@ -1924,12 +2067,12 @@ interface SubscriptionContractActivity extends SubscriptionContractActivityTarge
1924
2067
  */
1925
2068
  id?: string;
1926
2069
  /**
1927
- * When the activity occurred.
2070
+ * Date and time the activity occurred.
1928
2071
  * @readonly
1929
2072
  */
1930
2073
  createdDate?: Date | null;
1931
2074
  /**
1932
- * Identity of the draft order's initiator.
2075
+ * Wix user or app that made the change.
1933
2076
  * @readonly
1934
2077
  */
1935
2078
  author?: ActivityAuthor;
@@ -1938,7 +2081,7 @@ interface SubscriptionContractActivity extends SubscriptionContractActivityTarge
1938
2081
  }
1939
2082
  /** @oneof */
1940
2083
  interface SubscriptionContractActivityTargetOneOf {
1941
- /** Scopes the draft to the contract level, applying to all future cycles. */
2084
+ /** The activity applies to all future billing cycles of the subscription contract. */
1942
2085
  contractTarget?: ContractTarget;
1943
2086
  }
1944
2087
  /** @oneof */
@@ -1946,19 +2089,19 @@ interface SubscriptionContractActivityContentOneOf {
1946
2089
  /** Changes committed from a DraftSubscriptionContract. */
1947
2090
  changesApplied?: ChangesAppliedActivity;
1948
2091
  }
1949
- /** Scopes the draft to the contract level, applying to all future cycles. */
2092
+ /** Target that applies changes to all future billing cycles of the subscription contract. */
1950
2093
  interface ContractTarget {
1951
- /** Cycle number of the next billing cycle (1-based). Set by the caller; returned by the server on read. */
2094
+ /** Number of the first billing cycle the changes apply to. Billing cycles are numbered from `1`. */
1952
2095
  nextCycleNumber?: number | null;
1953
2096
  }
1954
2097
  interface ActivityAuthor extends ActivityAuthorValueOneOf {
1955
2098
  /**
1956
- * User ID. When the draft order was created by a Wix user.
2099
+ * Wix user ID. Returned when a Wix user made the change.
1957
2100
  * @format GUID
1958
2101
  */
1959
2102
  userId?: string;
1960
2103
  /**
1961
- * App ID. When the draft order was created by an app.
2104
+ * App ID. Returned when an app made the change.
1962
2105
  * @format GUID
1963
2106
  */
1964
2107
  appId?: string;
@@ -1966,74 +2109,76 @@ interface ActivityAuthor extends ActivityAuthorValueOneOf {
1966
2109
  /** @oneof */
1967
2110
  interface ActivityAuthorValueOneOf {
1968
2111
  /**
1969
- * User ID. When the draft order was created by a Wix user.
2112
+ * Wix user ID. Returned when a Wix user made the change.
1970
2113
  * @format GUID
1971
2114
  */
1972
2115
  userId?: string;
1973
2116
  /**
1974
- * App ID. When the draft order was created by an app.
2117
+ * App ID. Returned when an app made the change.
1975
2118
  * @format GUID
1976
2119
  */
1977
2120
  appId?: string;
1978
2121
  }
1979
2122
  interface ChangesAppliedActivity extends ChangesAppliedActivityTargetOneOf {
1980
- /** Scopes the draft to the contract level, applying to all future cycles. */
2123
+ /** The changes apply to all future billing cycles of the subscription contract. */
1981
2124
  contractTarget?: ContractTarget;
1982
2125
  /**
1983
- * ID of the DraftSubscriptionContract that was committed.
2126
+ * ID of the draft subscription contract whose changes were committed.
1984
2127
  * @format GUID
1985
2128
  */
1986
2129
  draftSubscriptionContractId?: string;
1987
2130
  /**
1988
- * Individual typed changes applied.
2131
+ * Changes that were applied to the subscription contract.
1989
2132
  * @maxSize 100
1990
2133
  */
1991
2134
  changes?: ContractChange[];
1992
2135
  /**
1993
- * Reason for the edit, provided by the merchant (optional).
2136
+ * Reason for the change, provided by the business.
1994
2137
  * @maxLength 200
1995
2138
  */
1996
2139
  reason?: string | null;
1997
2140
  }
1998
2141
  /** @oneof */
1999
2142
  interface ChangesAppliedActivityTargetOneOf {
2000
- /** Scopes the draft to the contract level, applying to all future cycles. */
2143
+ /** The changes apply to all future billing cycles of the subscription contract. */
2001
2144
  contractTarget?: ContractTarget;
2002
2145
  }
2003
- interface ContractChange extends ContractChangeValueOneOf {
2146
+ interface ContractChange extends ContractChangeChangeDetailsOneOf {
2004
2147
  /** Line item was modified. */
2005
2148
  lineItemChanged?: LineItemChanges;
2006
2149
  /** Line item was added to the contract. */
2007
- lineItemAdded?: ManagedLineItem;
2150
+ lineItemAdded?: LineItemSummary;
2008
2151
  /** Line item was removed from the contract. */
2009
- lineItemRemoved?: ManagedLineItem;
2152
+ lineItemRemoved?: LineItemSummary;
2010
2153
  /** Discount was added to the contract. */
2011
- discountAdded?: ManagedDiscount;
2154
+ discountAdded?: DiscountSummary;
2012
2155
  /** Discount was removed from the contract. */
2013
- discountRemoved?: ManagedDiscount;
2156
+ discountRemoved?: DiscountSummary;
2014
2157
  /** Additional fee was added to the contract. */
2015
- additionalFeeAdded?: ManagedAdditionalFee;
2158
+ additionalFeeAdded?: AdditionalFeeSummary;
2016
2159
  /** Additional fee was removed from the contract. */
2017
- additionalFeeRemoved?: ManagedAdditionalFee;
2160
+ additionalFeeRemoved?: AdditionalFeeSummary;
2018
2161
  /** Total price changed. */
2019
2162
  totalPriceChanged?: TotalPriceChange;
2163
+ /** Type of change. */
2164
+ changeType?: ContractChangeTypeWithLiterals;
2020
2165
  }
2021
2166
  /** @oneof */
2022
- interface ContractChangeValueOneOf {
2167
+ interface ContractChangeChangeDetailsOneOf {
2023
2168
  /** Line item was modified. */
2024
2169
  lineItemChanged?: LineItemChanges;
2025
2170
  /** Line item was added to the contract. */
2026
- lineItemAdded?: ManagedLineItem;
2171
+ lineItemAdded?: LineItemSummary;
2027
2172
  /** Line item was removed from the contract. */
2028
- lineItemRemoved?: ManagedLineItem;
2173
+ lineItemRemoved?: LineItemSummary;
2029
2174
  /** Discount was added to the contract. */
2030
- discountAdded?: ManagedDiscount;
2175
+ discountAdded?: DiscountSummary;
2031
2176
  /** Discount was removed from the contract. */
2032
- discountRemoved?: ManagedDiscount;
2177
+ discountRemoved?: DiscountSummary;
2033
2178
  /** Additional fee was added to the contract. */
2034
- additionalFeeAdded?: ManagedAdditionalFee;
2179
+ additionalFeeAdded?: AdditionalFeeSummary;
2035
2180
  /** Additional fee was removed from the contract. */
2036
- additionalFeeRemoved?: ManagedAdditionalFee;
2181
+ additionalFeeRemoved?: AdditionalFeeSummary;
2037
2182
  /** Total price changed. */
2038
2183
  totalPriceChanged?: TotalPriceChange;
2039
2184
  }
@@ -2049,11 +2194,15 @@ interface LineItemChanges {
2049
2194
  quantity?: LineItemQuantityChange;
2050
2195
  }
2051
2196
  declare enum LineItemQuantityChangeType {
2197
+ /** Unknown quantity change type. */
2198
+ UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE = "UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE",
2199
+ /** Quantity increased. */
2052
2200
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
2201
+ /** Quantity decreased. */
2053
2202
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
2054
2203
  }
2055
2204
  /** @enumType */
2056
- type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
2205
+ type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE' | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
2057
2206
  interface LineItemQuantityChange {
2058
2207
  /**
2059
2208
  * Original item quantity before the change.
@@ -2070,11 +2219,11 @@ interface LineItemQuantityChange {
2070
2219
  * @min 1
2071
2220
  * @max 1000000
2072
2221
  */
2073
- diff?: number;
2222
+ quantityDifference?: number;
2074
2223
  /** Direction of the quantity change. */
2075
2224
  deltaType?: LineItemQuantityChangeTypeWithLiterals;
2076
2225
  }
2077
- interface ManagedLineItem {
2226
+ interface LineItemSummary {
2078
2227
  /**
2079
2228
  * Line item ID.
2080
2229
  * @format GUID
@@ -2089,7 +2238,7 @@ interface ManagedLineItem {
2089
2238
  */
2090
2239
  quantity?: number;
2091
2240
  }
2092
- interface ManagedDiscount {
2241
+ interface DiscountSummary {
2093
2242
  /**
2094
2243
  * Discount ID.
2095
2244
  * @format GUID
@@ -2112,7 +2261,7 @@ interface TranslatedValue {
2112
2261
  */
2113
2262
  translated?: string | null;
2114
2263
  }
2115
- interface ManagedAdditionalFee {
2264
+ interface AdditionalFeeSummary {
2116
2265
  /**
2117
2266
  * Additional fee ID.
2118
2267
  * @format GUID
@@ -2129,8 +2278,32 @@ interface TotalPriceChange {
2129
2278
  /** Total price after the commit. */
2130
2279
  newTotal?: Price;
2131
2280
  }
2281
+ declare enum ContractChangeType {
2282
+ /** Unknown change type. */
2283
+ UNKNOWN_CONTRACT_CHANGE_TYPE = "UNKNOWN_CONTRACT_CHANGE_TYPE",
2284
+ /** Line item was modified. */
2285
+ LINE_ITEM_CHANGED = "LINE_ITEM_CHANGED",
2286
+ /** Line item was added to the contract. */
2287
+ LINE_ITEM_ADDED = "LINE_ITEM_ADDED",
2288
+ /** Line item was removed from the contract. */
2289
+ LINE_ITEM_REMOVED = "LINE_ITEM_REMOVED",
2290
+ /** Discount was added to the contract. */
2291
+ DISCOUNT_ADDED = "DISCOUNT_ADDED",
2292
+ /** Discount was removed from the contract. */
2293
+ DISCOUNT_REMOVED = "DISCOUNT_REMOVED",
2294
+ /** Additional fee was added to the contract. */
2295
+ ADDITIONAL_FEE_ADDED = "ADDITIONAL_FEE_ADDED",
2296
+ /** Additional fee was removed from the contract. */
2297
+ ADDITIONAL_FEE_REMOVED = "ADDITIONAL_FEE_REMOVED",
2298
+ /** Total price changed. */
2299
+ TOTAL_PRICE_CHANGED = "TOTAL_PRICE_CHANGED"
2300
+ }
2301
+ /** @enumType */
2302
+ 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';
2132
2303
  declare enum ActivityType {
2304
+ /** Unknown activity type. */
2133
2305
  UNKNOWN_ACTIVITY_TYPE = "UNKNOWN_ACTIVITY_TYPE",
2306
+ /** Changes from a draft subscription contract were committed. */
2134
2307
  CHANGES_APPLIED = "CHANGES_APPLIED"
2135
2308
  }
2136
2309
  /** @enumType */
@@ -2161,30 +2334,26 @@ interface SubscriptionContractExpired {
2161
2334
  /** The subscription contract that expired. */
2162
2335
  subscriptionContract?: SubscriptionContract;
2163
2336
  }
2164
- /**
2165
- * ACTION event payload emitted after a successful commit.
2166
- * Carries the full delta — downstream consumers (email notifications, activity feed)
2167
- * subscribe to this event and have all details inline without fetching the draft.
2168
- */
2337
+ /** Triggered when changes from a draft subscription contract are committed to a subscription contract. */
2169
2338
  interface SubscriptionContractChangesCommitted {
2170
- /** Updated SubscriptionContract after commit. */
2339
+ /** Subscription contract after the changes were committed. */
2171
2340
  subscriptionContract?: SubscriptionContract;
2172
2341
  /**
2173
- * ID of the DraftSubscriptionContract that triggered this commit.
2342
+ * ID of the draft subscription contract whose changes were committed.
2174
2343
  * @format GUID
2175
2344
  */
2176
2345
  draftSubscriptionContractId?: string;
2177
- /** The actual delta applied. */
2346
+ /** Changes that were applied to the subscription contract. */
2178
2347
  changes?: SubscriptionContractDiffs;
2179
2348
  /**
2180
2349
  * Date and time the changes were committed.
2181
2350
  * @readonly
2182
2351
  */
2183
2352
  commitDate?: Date | null;
2184
- /** Side-effects requested by the caller when the changes were committed. */
2353
+ /** Notification settings specified when the changes were committed. */
2185
2354
  commitSettings?: SubscriptionCommitSettings;
2186
2355
  /**
2187
- * Reason for the edit, provided by the merchant.
2356
+ * Reason for the change, provided by the business.
2188
2357
  * @maxLength 200
2189
2358
  */
2190
2359
  reason?: string | null;
@@ -2193,39 +2362,49 @@ interface SubscriptionContractChangesCommitted {
2193
2362
  }
2194
2363
  interface SubscriptionContractDiffs {
2195
2364
  /**
2196
- * Per-item deltas: added, changed, or removed line items.
2365
+ * Line items that were added, changed, or removed.
2366
+ *
2367
+ * A line item is `CHANGED` when a field listed in `ItemChangedDetails` changed. Line items with no change aren't included.
2197
2368
  * @maxSize 100
2198
2369
  */
2199
2370
  lineItems?: LineItemDelta[];
2200
2371
  /**
2201
- * Per-discount deltas.
2372
+ * Discounts that were added, changed, or removed.
2373
+ *
2374
+ * 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.
2202
2375
  * @maxSize 100
2203
2376
  */
2204
2377
  appliedDiscounts?: AppliedDiscountDelta[];
2205
2378
  /**
2206
- * Per-fee deltas.
2379
+ * Additional fees that were added, changed, or removed.
2380
+ *
2381
+ * An additional fee is `CHANGED` when its price or the line items it applies to changed. Fees with no change aren't included.
2207
2382
  * @maxSize 100
2208
2383
  */
2209
2384
  additionalFees?: AdditionalFeeDelta[];
2210
- /** Updated price summary (overwrites existing). */
2385
+ /** Price summary after the changes. Replaces the subscription contract's previous price summary. */
2211
2386
  priceSummary?: PriceSummary;
2212
- /** Updated tax info (overwrites existing). */
2387
+ /** Tax information after the changes. Replaces the subscription contract's previous tax information. */
2213
2388
  taxInfo?: OrderTaxInfo;
2389
+ /** Shipping information after the changes. Replaces the subscription contract's previous shipping information. */
2390
+ shippingInfo?: ShippingInformation;
2214
2391
  }
2215
2392
  interface LineItemDelta extends LineItemDeltaDeltaDetailsOneOf {
2393
+ /** Values the line item had before the change. */
2216
2394
  changed?: ItemChangedDetails;
2217
2395
  /**
2218
2396
  * Line item ID.
2219
2397
  * @format GUID
2220
2398
  */
2221
2399
  lineItemId?: string;
2222
- /** Full line item content (absent for removed items). */
2400
+ /** Line item content. For a removed line item, the line item that was removed. */
2223
2401
  lineItem?: OrderLineItem;
2224
2402
  /** Type of change applied to this line item. */
2225
2403
  changeType?: ChangeTypeWithLiterals;
2226
2404
  }
2227
2405
  /** @oneof */
2228
2406
  interface LineItemDeltaDeltaDetailsOneOf {
2407
+ /** Values the line item had before the change. */
2229
2408
  changed?: ItemChangedDetails;
2230
2409
  }
2231
2410
  interface CommonImage {
@@ -2261,159 +2440,159 @@ interface CommonImage {
2261
2440
  */
2262
2441
  filename?: string | null;
2263
2442
  }
2264
- /** the catalog reference options before the change. */
2443
+ /** The catalog reference options before the change. */
2265
2444
  interface CatalogReferenceOptionsBeforeChange {
2266
- /** the catalog reference options. Absent when the line item had no options. */
2445
+ /** The catalog reference options. Absent when the line item had no options. */
2267
2446
  options?: Record<string, any> | null;
2268
2447
  }
2269
- /** the product name before the change. */
2448
+ /** The product name before the change. */
2270
2449
  interface ProductNameBeforeChange {
2271
- /** the product name. Absent when the line item had no product name. */
2450
+ /** The product name. Absent when the line item had no product name. */
2272
2451
  productName?: ProductName;
2273
2452
  }
2274
- /** the description lines before the change. */
2453
+ /** The description lines before the change. */
2275
2454
  interface DescriptionLinesBeforeChange {
2276
2455
  /**
2277
- * the description lines. Empty when the line item had no description lines.
2456
+ * The description lines. Empty when the line item had no description lines.
2278
2457
  * @maxSize 20
2279
2458
  */
2280
2459
  descriptionLines?: DescriptionLine[];
2281
2460
  }
2282
- /** the image before the change. */
2461
+ /** The image before the change. */
2283
2462
  interface ImageBeforeChange {
2284
- /** the image. Absent when the line item had no image. */
2463
+ /** The image. Absent when the line item had no image. */
2285
2464
  image?: CommonImage;
2286
2465
  }
2287
- /** the physical properties before the change. */
2466
+ /** The physical properties before the change. */
2288
2467
  interface PhysicalPropertiesBeforeChange {
2289
- /** the physical properties. Absent when the line item had no physical properties. */
2468
+ /** The physical properties. Absent when the line item had no physical properties. */
2290
2469
  physicalProperties?: PhysicalProperties;
2291
2470
  }
2292
- /** the item type before the change. */
2471
+ /** The item type before the change. */
2293
2472
  interface ItemTypeBeforeChange {
2294
- /** the item type. Absent when the line item had no item type. */
2473
+ /** The item type. Absent when the line item had no item type. */
2295
2474
  itemType?: ItemType;
2296
2475
  }
2297
- /** the fulfiller ID before the change. */
2476
+ /** The fulfiller ID before the change. */
2298
2477
  interface FulfillerIdBeforeChange {
2299
2478
  /**
2300
- * the fulfiller ID. Absent when the line item had no fulfiller.
2479
+ * The fulfiller ID. Absent when the line item had no fulfiller.
2301
2480
  * @format GUID
2302
2481
  */
2303
2482
  fulfillerId?: string | null;
2304
2483
  }
2305
- /** the digital file before the change. */
2484
+ /** The digital file before the change. */
2306
2485
  interface DigitalFileBeforeChange {
2307
- /** the digital file. Absent when the line item had no digital file. */
2486
+ /** The digital file. Absent when the line item had no digital file. */
2308
2487
  digitalFile?: DigitalFile;
2309
2488
  }
2310
- /** the price description before the change. */
2489
+ /** The price description before the change. */
2311
2490
  interface PriceDescriptionBeforeChange {
2312
- /** the price description. Absent when the line item had no price description. */
2491
+ /** The price description. Absent when the line item had no price description. */
2313
2492
  priceDescription?: PriceDescription;
2314
2493
  }
2315
- /** the delivery profile ID before the change. */
2494
+ /** The delivery profile ID before the change. */
2316
2495
  interface DeliveryProfileIdBeforeChange {
2317
2496
  /**
2318
- * the delivery profile ID. Absent when the line item had no delivery profile.
2497
+ * The delivery profile ID. Absent when the line item had no delivery profile.
2319
2498
  * @format GUID
2320
2499
  */
2321
2500
  deliveryProfileId?: string | null;
2322
2501
  }
2323
- /** the shipping group ID before the change. */
2502
+ /** The shipping group ID before the change. */
2324
2503
  interface ShippingGroupIdBeforeChange {
2325
2504
  /**
2326
- * the shipping group ID. Absent when the line item had no shipping group.
2505
+ * The shipping group ID. Absent when the line item had no shipping group.
2327
2506
  * @format GUID
2328
2507
  */
2329
2508
  shippingGroupId?: string | null;
2330
2509
  }
2331
- /** the tax info before the change. */
2510
+ /** The tax info before the change. */
2332
2511
  interface TaxInfoBeforeChange {
2333
- /** the tax info. Absent when the line item had no tax info. */
2512
+ /** The tax info. Absent when the line item had no tax info. */
2334
2513
  taxInfo?: LineItemTaxInfo;
2335
2514
  }
2336
- /** the inventory app ID before the change. */
2515
+ /** The inventory app ID before the change. */
2337
2516
  interface InventoryAppIdBeforeChange {
2338
2517
  /**
2339
- * the inventory app ID. Absent when the line item had no inventory app.
2518
+ * The inventory app ID. Absent when the line item had no inventory app.
2340
2519
  * @format GUID
2341
2520
  */
2342
2521
  inventoryAppId?: string | null;
2343
2522
  }
2344
- /** the root catalog item ID before the change. */
2523
+ /** The root catalog item ID before the change. */
2345
2524
  interface RootCatalogItemIdBeforeChange {
2346
2525
  /**
2347
- * the root catalog item ID. Absent when the line item had no root catalog item.
2526
+ * The root catalog item ID. Absent when the line item had no root catalog item.
2348
2527
  * @minLength 1
2349
2528
  * @maxLength 36
2350
2529
  */
2351
2530
  rootCatalogItemId?: string | null;
2352
2531
  }
2353
- /** the modifier groups before the change. */
2532
+ /** The modifier groups before the change. */
2354
2533
  interface ModifierGroupsBeforeChange {
2355
2534
  /**
2356
- * the modifier groups. Empty when the line item had no modifier groups.
2535
+ * The modifier groups. Empty when the line item had no modifier groups.
2357
2536
  * @maxSize 10
2358
2537
  */
2359
2538
  modifierGroups?: ModifierGroup[];
2360
2539
  }
2361
- /** the price undetermined flag before the change. */
2540
+ /** The price undetermined flag before the change. */
2362
2541
  interface PriceUndeterminedBeforeChange {
2363
- /** whether the price of the line item was undetermined. */
2542
+ /** Whether the price of the line item was undetermined. */
2364
2543
  priceUndetermined?: boolean;
2365
2544
  }
2366
- /** Describes the type of change applied to an element. */
2545
+ /** Type of change to a line item, discount, or additional fee. */
2367
2546
  declare enum ChangeType {
2547
+ /** Unknown change type. */
2368
2548
  UNKNOWN_CHANGE_TYPE = "UNKNOWN_CHANGE_TYPE",
2369
- /** Element was added (absent in the original contract). */
2549
+ /** The line item, discount, or additional fee was added to the subscription contract. */
2370
2550
  ADDED = "ADDED",
2371
- /** Element was modified from the original contract. */
2551
+ /** The line item, discount, or additional fee was changed. */
2372
2552
  CHANGED = "CHANGED",
2373
- /** Element was removed from the contract. */
2553
+ /** The line item, discount, or additional fee was removed from the subscription contract. */
2374
2554
  REMOVED = "REMOVED"
2375
2555
  }
2376
2556
  /** @enumType */
2377
2557
  type ChangeTypeWithLiterals = ChangeType | 'UNKNOWN_CHANGE_TYPE' | 'ADDED' | 'CHANGED' | 'REMOVED';
2378
2558
  interface ItemChangedDetails {
2379
2559
  /**
2380
- * The quantity before the change.
2560
+ * The quantity before the change. Set only when the quantity changed.
2381
2561
  * @min 1
2382
2562
  * @max 1000000
2383
2563
  */
2384
2564
  quantityBeforeChange?: number | null;
2385
- /** The price before the change. */
2565
+ /** The price before the change. Set only when the price changed. */
2386
2566
  priceBeforeChange?: Price;
2387
- /** the catalog reference options before the change. Set only when the catalog reference options changed. */
2567
+ /** The catalog reference options before the change. Set only when the catalog reference options changed. */
2388
2568
  catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
2389
- /** the product name before the change. Set only when the product name changed. */
2569
+ /** The product name before the change. Set only when the product name changed. */
2390
2570
  productNameBeforeChange?: ProductNameBeforeChange;
2391
- /** the description lines before the change. Set only when the description lines changed. */
2571
+ /** The description lines before the change. Set only when the description lines changed. */
2392
2572
  descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
2393
- /** the image before the change. Set only when the image changed. */
2573
+ /** The image before the change. Set only when the image changed. */
2394
2574
  imageBeforeChange?: ImageBeforeChange;
2395
- /** the physical properties before the change. Set only when the physical properties changed. */
2575
+ /** The physical properties before the change. Set only when the physical properties changed. */
2396
2576
  physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
2397
- /** the item type before the change. Set only when the item type changed. */
2577
+ /** The item type before the change. Set only when the item type changed. */
2398
2578
  itemTypeBeforeChange?: ItemTypeBeforeChange;
2399
- /** the fulfiller ID before the change. Set only when the fulfiller ID changed. */
2579
+ /** The fulfiller ID before the change. Set only when the fulfiller ID changed. */
2400
2580
  fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
2401
- /** the digital file before the change. Set only when the digital file changed. */
2581
+ /** The digital file before the change. Set only when the digital file changed. */
2402
2582
  digitalFileBeforeChange?: DigitalFileBeforeChange;
2403
- /** the price description before the change. Set only when the price description changed. */
2583
+ /** The price description before the change. Set only when the price description changed. */
2404
2584
  priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
2405
- /** the tax info before the change. Set only when the tax group changed. */
2585
+ /** The tax info before the change. Set only when the line item's tax group changed because its catalog options changed. */
2406
2586
  taxInfoBeforeChange?: TaxInfoBeforeChange;
2407
- /** the inventory app ID before the change. Set only when the inventory app ID changed. */
2408
- inventoryAppIdBeforeChange?: InventoryAppIdBeforeChange;
2409
- /** the modifier groups before the change. Set only when the modifier groups changed. */
2587
+ /** The modifier groups before the change. Set only when the modifier groups changed. */
2410
2588
  modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
2411
- /** the price undetermined flag before the change. Set only when the price undetermined flag changed. */
2589
+ /** The price undetermined flag before the change. Set only when the price undetermined flag changed. */
2412
2590
  priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
2413
2591
  }
2414
2592
  interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2415
2593
  /** Discount content after the change. */
2416
2594
  changed?: AppliedDiscount;
2595
+ /** Discount that was added. */
2417
2596
  added?: AppliedDiscount;
2418
2597
  /**
2419
2598
  * Discount ID.
@@ -2427,11 +2606,13 @@ interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2427
2606
  interface AppliedDiscountDeltaDeltaDetailsOneOf {
2428
2607
  /** Discount content after the change. */
2429
2608
  changed?: AppliedDiscount;
2609
+ /** Discount that was added. */
2430
2610
  added?: AppliedDiscount;
2431
2611
  }
2432
2612
  interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
2433
2613
  /** Additional fee content after the change. */
2434
2614
  changed?: AdditionalFee;
2615
+ /** Additional fee that was added. */
2435
2616
  added?: AdditionalFee;
2436
2617
  /**
2437
2618
  * Additional fee ID.
@@ -2445,12 +2626,21 @@ interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
2445
2626
  interface AdditionalFeeDeltaDeltaDetailsOneOf {
2446
2627
  /** Additional fee content after the change. */
2447
2628
  changed?: AdditionalFee;
2629
+ /** Additional fee that was added. */
2448
2630
  added?: AdditionalFee;
2449
2631
  }
2450
2632
  interface SubscriptionCommitSettings {
2451
- /** If false, do not send notifications to buyer. Default is true. */
2633
+ /**
2634
+ * Whether to send the buyer a notification about the committed changes.
2635
+ *
2636
+ * Default: `true`
2637
+ */
2452
2638
  sendNotificationsToBuyer?: boolean | null;
2453
- /** If false, do not send notifications to business. Default is true. */
2639
+ /**
2640
+ * Whether to send the business a notification about the committed changes.
2641
+ *
2642
+ * Default: `true`
2643
+ */
2454
2644
  sendNotificationsToBusiness?: boolean | null;
2455
2645
  }
2456
2646
  /** Triggered when a subscription contract's next charge is coming up. */
@@ -2481,13 +2671,13 @@ interface CreateSubscriptionContractResponse {
2481
2671
  }
2482
2672
  interface GetSubscriptionContractRequest {
2483
2673
  /**
2484
- * ID of the SubscriptionContract to retrieve.
2674
+ * ID of the subscription contract to retrieve.
2485
2675
  * @format GUID
2486
2676
  */
2487
2677
  subscriptionContractId: string;
2488
2678
  }
2489
2679
  interface GetSubscriptionContractResponse {
2490
- /** The requested SubscriptionContract. */
2680
+ /** Retrieved subscription contract. */
2491
2681
  subscriptionContract?: SubscriptionContract;
2492
2682
  }
2493
2683
  interface UpdateSubscriptionContractRequest {
@@ -2499,26 +2689,24 @@ interface UpdateSubscriptionContractResponse {
2499
2689
  subscriptionContract?: SubscriptionContract;
2500
2690
  }
2501
2691
  interface QuerySubscriptionContractsRequest {
2502
- /** WQL expression. */
2692
+ /** Filter, sort, and paging options for the query. */
2503
2693
  query?: CursorQuery;
2504
2694
  }
2505
2695
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
2506
2696
  /** 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`. */
2507
2697
  cursorPaging?: CursorPaging;
2508
2698
  /**
2509
- * Filter object in the following format:
2510
- * `"filter" : {
2511
- * "fieldName1": "value1",
2512
- * "fieldName2":{"$operator":"value2"}
2513
- * }`
2514
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2515
- * Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
2699
+ * 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.
2700
+ *
2701
+ * Supported properties:
2702
+ * `id`, `buyerInfo.contactId`
2516
2703
  */
2517
2704
  filter?: Record<string, any> | null;
2518
2705
  /**
2519
2706
  * Sort object in the following format:
2520
2707
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2521
- * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
2708
+ *
2709
+ * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
2522
2710
  * @maxSize 5
2523
2711
  */
2524
2712
  sort?: Sorting[];
@@ -2530,11 +2718,18 @@ interface CursorQueryPagingMethodOneOf {
2530
2718
  }
2531
2719
  interface Sorting {
2532
2720
  /**
2533
- * Name of the field to sort by.
2721
+ * Field to sort by.
2722
+ *
2723
+ * Supported properties:
2724
+ * `id`, `buyerInfo.contactId`
2534
2725
  * @maxLength 512
2535
2726
  */
2536
2727
  fieldName?: string;
2537
- /** Sort order. */
2728
+ /**
2729
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
2730
+ *
2731
+ * Default: `ASC`
2732
+ */
2538
2733
  order?: SortOrderWithLiterals;
2539
2734
  }
2540
2735
  declare enum SortOrder {
@@ -2559,9 +2754,9 @@ interface CursorPaging {
2559
2754
  cursor?: string | null;
2560
2755
  }
2561
2756
  interface QuerySubscriptionContractsResponse {
2562
- /** List of SubscriptionContracts. */
2757
+ /** Retrieved subscription contracts. */
2563
2758
  subscriptionContracts?: SubscriptionContract[];
2564
- /** Paging metadata */
2759
+ /** Paging metadata. */
2565
2760
  pagingMetadata?: CursorPagingMetadata;
2566
2761
  }
2567
2762
  interface CursorPagingMetadata {
@@ -2864,6 +3059,12 @@ interface AccountInfo {
2864
3059
  */
2865
3060
  siteId?: string | null;
2866
3061
  }
3062
+ /** @docsIgnore */
3063
+ type GetSubscriptionContractApplicationErrors = {
3064
+ code?: 'NOT_FOUND';
3065
+ description?: string;
3066
+ data?: Record<string, any>;
3067
+ };
2867
3068
 
2868
3069
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2869
3070
  getUrl: (context: any) => string;
@@ -2880,4 +3081,4 @@ declare function getSubscriptionContract(): __PublicMethodMetaInfo<'GET', {
2880
3081
  }, GetSubscriptionContractRequest$1, GetSubscriptionContractRequest, GetSubscriptionContractResponse$1, GetSubscriptionContractResponse>;
2881
3082
  declare function querySubscriptionContracts(): __PublicMethodMetaInfo<'GET', {}, QuerySubscriptionContractsRequest$1, QuerySubscriptionContractsRequest, QuerySubscriptionContractsResponse$1, QuerySubscriptionContractsResponse>;
2882
3083
 
2883
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionInitiator as ActionInitiatorOriginal, type ActionInitiatorWithLiterals as ActionInitiatorWithLiteralsOriginal, type ActivityAuthor as ActivityAuthorOriginal, type ActivityAuthorValueOneOf as ActivityAuthorValueOneOfOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AdditionalFeeDeltaDeltaDetailsOneOf as AdditionalFeeDeltaDeltaDetailsOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaDetailsOneOf as AppliedDiscountDeltaDeltaDetailsOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateSubscriptionContractsRequest as BulkCreateSubscriptionContractsRequestOriginal, type BulkCreateSubscriptionContractsResponse as BulkCreateSubscriptionContractsResponseOriginal, type BulkSubscriptionContractResult as BulkSubscriptionContractResultOriginal, type BulkUpdateSubscriptionContractsRequest as BulkUpdateSubscriptionContractsRequestOriginal, type BulkUpdateSubscriptionContractsResponse as BulkUpdateSubscriptionContractsResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type CatalogReferenceOptionsBeforeChange as CatalogReferenceOptionsBeforeChangeOriginal, type CatalogReference as CatalogReferenceOriginal, ChangeType as ChangeTypeOriginal, type ChangeTypeWithLiterals as ChangeTypeWithLiteralsOriginal, type ChangesAppliedActivity as ChangesAppliedActivityOriginal, type ChangesAppliedActivityTargetOneOf as ChangesAppliedActivityTargetOneOfOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type Color as ColorOriginal, type CommitSubscriptionContractChangesRequest as CommitSubscriptionContractChangesRequestOriginal, type CommitSubscriptionContractChangesResponse as CommitSubscriptionContractChangesResponseOriginal, type CommonImage as CommonImageOriginal, type ContractChange as ContractChangeOriginal, type ContractChangeValueOneOf as ContractChangeValueOneOfOriginal, type ContractTarget as ContractTargetOriginal, type Coupon as CouponOriginal, type CreateSubscriptionContractRequest as CreateSubscriptionContractRequestOriginal, type CreateSubscriptionContractResponse as CreateSubscriptionContractResponseOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomField as CustomFieldOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryProfileIdBeforeChange as DeliveryProfileIdBeforeChangeOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DescriptionLinesBeforeChange as DescriptionLinesBeforeChangeOriginal, type DigitalFileBeforeChange as DigitalFileBeforeChangeOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FocalPoint as FocalPointOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerIdBeforeChange as FulfillerIdBeforeChangeOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetSubscriptionContractRequest as GetSubscriptionContractRequestOriginal, type GetSubscriptionContractResponse as GetSubscriptionContractResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImageBeforeChange as ImageBeforeChangeOriginal, type Image as ImageOriginal, type InventoryAppIdBeforeChange as InventoryAppIdBeforeChangeOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeBeforeChange as ItemTypeBeforeChangeOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemCyclePriceOverrides as LineItemCyclePriceOverridesOriginal, type LineItemDeltaDeltaDetailsOneOf as LineItemDeltaDeltaDetailsOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, type MaskedSubscriptionContract as MaskedSubscriptionContractOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifierGroup as ModifierGroupOriginal, type ModifierGroupsBeforeChange as ModifierGroupsBeforeChangeOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type PhysicalPropertiesBeforeChange as PhysicalPropertiesBeforeChangeOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PriceDescriptionBeforeChange as PriceDescriptionBeforeChangeOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type PriceUndeterminedBeforeChange as PriceUndeterminedBeforeChangeOriginal, type ProductNameBeforeChange as ProductNameBeforeChangeOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type QuerySubscriptionContractsRequest as QuerySubscriptionContractsRequestOriginal, type QuerySubscriptionContractsResponse as QuerySubscriptionContractsResponseOriginal, type RestockLocation as RestockLocationOriginal, type RestoreInfo as RestoreInfoOriginal, type RootCatalogItemIdBeforeChange as RootCatalogItemIdBeforeChangeOriginal, type ServiceProperties as ServicePropertiesOriginal, type ShippingGroupIdBeforeChange as ShippingGroupIdBeforeChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRegion as ShippingRegionOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type SubscriptionCommitSettings as SubscriptionCommitSettingsOriginal, type SubscriptionContractActivityContentOneOf as SubscriptionContractActivityContentOneOfOriginal, type SubscriptionContractActivity as SubscriptionContractActivityOriginal, type SubscriptionContractActivityTargetOneOf as SubscriptionContractActivityTargetOneOfOriginal, type SubscriptionContractCanceled as SubscriptionContractCanceledOriginal, type SubscriptionContractChangesCommitted as SubscriptionContractChangesCommittedOriginal, type SubscriptionContractChargeUpcoming as SubscriptionContractChargeUpcomingOriginal, type SubscriptionContractDiffs as SubscriptionContractDiffsOriginal, type SubscriptionContractExpired as SubscriptionContractExpiredOriginal, type SubscriptionContract as SubscriptionContractOriginal, type SubscriptionContractSettings as SubscriptionContractSettingsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, SubscriptionSettingsProductPeriodAlignment as SubscriptionSettingsProductPeriodAlignmentOriginal, type SubscriptionSettingsProductPeriodAlignmentWithLiterals as SubscriptionSettingsProductPeriodAlignmentWithLiteralsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TaxInfoBeforeChange as TaxInfoBeforeChangeOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type UpdateSubscriptionContractRequest as UpdateSubscriptionContractRequestOriginal, type UpdateSubscriptionContractResponse as UpdateSubscriptionContractResponseOriginal, type V1BillingSettings as V1BillingSettingsOriginal, type V1CyclePriceOverride as V1CyclePriceOverrideOriginal, type V1FreeTrialPeriod as V1FreeTrialPeriodOriginal, type V1SubscriptionDescription as V1SubscriptionDescriptionOriginal, type V1SubscriptionSettings as V1SubscriptionSettingsOriginal, type V1SubscriptionTitle as V1SubscriptionTitleOriginal, V2SubscriptionFrequency as V2SubscriptionFrequencyOriginal, type V2SubscriptionFrequencyWithLiterals as V2SubscriptionFrequencyWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type __PublicMethodMetaInfo, getSubscriptionContract, querySubscriptionContracts };
3084
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionInitiator as ActionInitiatorOriginal, type ActionInitiatorWithLiterals as ActionInitiatorWithLiteralsOriginal, type ActivityAuthor as ActivityAuthorOriginal, type ActivityAuthorValueOneOf as ActivityAuthorValueOneOfOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AdditionalFeeDeltaDeltaDetailsOneOf as AdditionalFeeDeltaDeltaDetailsOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AdditionalFeeSummary as AdditionalFeeSummaryOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaDetailsOneOf as AppliedDiscountDeltaDeltaDetailsOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateSubscriptionContractsRequest as BulkCreateSubscriptionContractsRequestOriginal, type BulkCreateSubscriptionContractsResponse as BulkCreateSubscriptionContractsResponseOriginal, type BulkSubscriptionContractResult as BulkSubscriptionContractResultOriginal, type BulkUpdateSubscriptionContractsRequest as BulkUpdateSubscriptionContractsRequestOriginal, type BulkUpdateSubscriptionContractsResponse as BulkUpdateSubscriptionContractsResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type CatalogReferenceOptionsBeforeChange as CatalogReferenceOptionsBeforeChangeOriginal, type CatalogReference as CatalogReferenceOriginal, ChangeType as ChangeTypeOriginal, type ChangeTypeWithLiterals as ChangeTypeWithLiteralsOriginal, type ChangesAppliedActivity as ChangesAppliedActivityOriginal, type ChangesAppliedActivityTargetOneOf as ChangesAppliedActivityTargetOneOfOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type Color as ColorOriginal, type CommitSubscriptionContractChangesRequest as CommitSubscriptionContractChangesRequestOriginal, type CommitSubscriptionContractChangesResponse as CommitSubscriptionContractChangesResponseOriginal, type CommonImage as CommonImageOriginal, type ContractChangeChangeDetailsOneOf as ContractChangeChangeDetailsOneOfOriginal, type ContractChange as ContractChangeOriginal, ContractChangeType as ContractChangeTypeOriginal, type ContractChangeTypeWithLiterals as ContractChangeTypeWithLiteralsOriginal, type ContractTarget as ContractTargetOriginal, type Coupon as CouponOriginal, type CreateSubscriptionContractRequest as CreateSubscriptionContractRequestOriginal, type CreateSubscriptionContractResponse as CreateSubscriptionContractResponseOriginal, type CrossBorderCalculation as CrossBorderCalculationOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomField as CustomFieldOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryProfileIdBeforeChange as DeliveryProfileIdBeforeChangeOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DescriptionLinesBeforeChange as DescriptionLinesBeforeChangeOriginal, type DigitalFileBeforeChange as DigitalFileBeforeChangeOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, type DiscountSummary as DiscountSummaryOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FocalPoint as FocalPointOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerIdBeforeChange as FulfillerIdBeforeChangeOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetSubscriptionContractApplicationErrors as GetSubscriptionContractApplicationErrorsOriginal, type GetSubscriptionContractRequest as GetSubscriptionContractRequestOriginal, type GetSubscriptionContractResponse as GetSubscriptionContractResponseOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type ImageBeforeChange as ImageBeforeChangeOriginal, type Image as ImageOriginal, type InventoryAppIdBeforeChange as InventoryAppIdBeforeChangeOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeBeforeChange as ItemTypeBeforeChangeOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemCyclePriceOverrides as LineItemCyclePriceOverridesOriginal, type LineItemDeltaDeltaDetailsOneOf as LineItemDeltaDeltaDetailsOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemSummary as LineItemSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type MaskedSubscriptionContract as MaskedSubscriptionContractOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifierGroup as ModifierGroupOriginal, type ModifierGroupsBeforeChange as ModifierGroupsBeforeChangeOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type PhysicalPropertiesBeforeChange as PhysicalPropertiesBeforeChangeOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PriceDescriptionBeforeChange as PriceDescriptionBeforeChangeOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type PriceUndeterminedBeforeChange as PriceUndeterminedBeforeChangeOriginal, type ProductNameBeforeChange as ProductNameBeforeChangeOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type QuerySubscriptionContractsRequest as QuerySubscriptionContractsRequestOriginal, type QuerySubscriptionContractsResponse as QuerySubscriptionContractsResponseOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type RestockLocation as RestockLocationOriginal, type RestoreInfo as RestoreInfoOriginal, type RootCatalogItemIdBeforeChange as RootCatalogItemIdBeforeChangeOriginal, type ServiceProperties as ServicePropertiesOriginal, type ShippingGroupIdBeforeChange as ShippingGroupIdBeforeChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRegion as ShippingRegionOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type SubscriptionCommitSettings as SubscriptionCommitSettingsOriginal, type SubscriptionContractActivityContentOneOf as SubscriptionContractActivityContentOneOfOriginal, type SubscriptionContractActivity as SubscriptionContractActivityOriginal, type SubscriptionContractActivityTargetOneOf as SubscriptionContractActivityTargetOneOfOriginal, type SubscriptionContractCanceled as SubscriptionContractCanceledOriginal, type SubscriptionContractChangesCommitted as SubscriptionContractChangesCommittedOriginal, type SubscriptionContractChargeUpcoming as SubscriptionContractChargeUpcomingOriginal, type SubscriptionContractDiffs as SubscriptionContractDiffsOriginal, type SubscriptionContractExpired as SubscriptionContractExpiredOriginal, type SubscriptionContract as SubscriptionContractOriginal, type SubscriptionContractSettings as SubscriptionContractSettingsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, SubscriptionSettingsProductPeriodAlignment as SubscriptionSettingsProductPeriodAlignmentOriginal, type SubscriptionSettingsProductPeriodAlignmentWithLiterals as SubscriptionSettingsProductPeriodAlignmentWithLiteralsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TaxInfoBeforeChange as TaxInfoBeforeChangeOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type UpdateSubscriptionContractRequest as UpdateSubscriptionContractRequestOriginal, type UpdateSubscriptionContractResponse as UpdateSubscriptionContractResponseOriginal, type V1BillingSettings as V1BillingSettingsOriginal, type V1CyclePriceOverride as V1CyclePriceOverrideOriginal, type V1FreeTrialPeriod as V1FreeTrialPeriodOriginal, type V1SubscriptionDescription as V1SubscriptionDescriptionOriginal, type V1SubscriptionSettings as V1SubscriptionSettingsOriginal, type V1SubscriptionTitle as V1SubscriptionTitleOriginal, V2SubscriptionFrequency as V2SubscriptionFrequencyOriginal, type V2SubscriptionFrequencyWithLiterals as V2SubscriptionFrequencyWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type __PublicMethodMetaInfo, getSubscriptionContract, querySubscriptionContracts };