@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;
@@ -47,14 +45,23 @@ interface SubscriptionContract {
47
45
  */
48
46
  description?: string | null;
49
47
  /**
50
- * Subscription option description. For example, `"1kg of selected coffee, once a month"`.
51
- * @internal
48
+ * Subscription description, in the site's default language and translated into the buyer's language. For example, `"1kg of selected coffee, once a month"`.
49
+ *
50
+ * For a subscription contract with more than one line item, holds a general name for the subscription.
52
51
  */
53
52
  subscriptionDescription?: V1SubscriptionDescription;
54
- /** Subscription detailed information. */
53
+ /** Subscription terms, such as the billing frequency, the number of billing cycles, and whether the subscription renews automatically. */
55
54
  subscriptionSettings?: V1SubscriptionSettings;
56
55
  /**
57
- * Order line items.
56
+ * Subscription line items. The order for each billing cycle is created with these line items.
57
+ *
58
+ * In a subscription contract:
59
+ * + `lineItems.subscriptionInfo.id` is the subscription contract's own ID.
60
+ * + `lineItems.subscriptionInfo.cycleNumber` is always `0`. The billing cycle is set on the line items of each cycle's order.
61
+ * + `subscriptionInfo.title` and `subscriptionInfo.description` hold the subscription contract's title and description, not the line item's own subscription option.
62
+ * + `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.
63
+ * + `extendedFields` and `decimalQuantity` aren't returned.
64
+ * + When coupons were included in item prices at checkout, `price` is the price before coupons, and the coupons are in `appliedDiscounts`.
58
65
  * @minSize 1
59
66
  * @maxSize 100
60
67
  */
@@ -62,20 +69,25 @@ interface SubscriptionContract {
62
69
  /** Buyer information. */
63
70
  buyerInfo?: BuyerInfo;
64
71
  /**
65
- * Language for communication with the buyer. Defaults to the site language.
66
- * For a site that supports multiple languages, this is the language the buyer selected.
72
+ * Language for communication with the buyer. For a site that supports multiple languages, this is the language the buyer selected.
73
+ *
74
+ * Default: Site language
67
75
  * @maxLength 10
68
76
  */
69
77
  buyerLanguage?: string | null;
70
- /** Weight measurement unit - defaults to site's weight unit. */
78
+ /**
79
+ * Weight measurement unit.
80
+ *
81
+ * Default: Site's weight unit
82
+ */
71
83
  weightUnit?: WeightUnitWithLiterals;
72
84
  /**
73
- * 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.
85
+ * 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.
74
86
  * @format CURRENCY
75
87
  * @immutable
76
88
  */
77
89
  currency?: string | null;
78
- /** Multi-currency information of the subscription. conversionRate may reflect updated exchange rate on created order per recurring cycle. */
90
+ /** Multi-currency details for a subscription paid in a currency other than the site's currency. */
79
91
  currencyConversionDetails?: CurrencyConversionDetails;
80
92
  /**
81
93
  * Whether tax is included in line item prices.
@@ -85,15 +97,19 @@ interface SubscriptionContract {
85
97
  */
86
98
  taxIncludedInPrices?: boolean;
87
99
  /**
88
- * Order price summary.
100
+ * Price summary of a single billing cycle.
89
101
  * @readonly
90
102
  */
91
103
  priceSummary?: PriceSummary;
92
- /** Summary of platform fees for this subscription contract, including totals by charge type and a breakdown of individual fees. */
104
+ /**
105
+ * Summary of platform fees calculated at checkout, including totals by charge type and a breakdown of individual fees.
106
+ *
107
+ * Not updated when draft changes are committed. Each billing cycle's order holds the platform fees for that cycle.
108
+ */
93
109
  platformFeeSummary?: PlatformFeeSummary;
94
110
  /** Billing address and contact details. */
95
111
  billingInfo?: AddressWithContact;
96
- /** Shipping info and selected shipping option details. */
112
+ /** Shipping information and selected shipping option details. */
97
113
  shippingInfo?: ShippingInformation;
98
114
  /**
99
115
  * Tax information.
@@ -102,11 +118,11 @@ interface SubscriptionContract {
102
118
  */
103
119
  taxInfo?: OrderTaxInfo;
104
120
  /**
105
- * Applied discounts.
121
+ * Discounts applied to the subscription contract.
106
122
  * @maxSize 100
107
123
  */
108
124
  appliedDiscounts?: AppliedDiscount[];
109
- /** Information about the sales channel that submitted this order. */
125
+ /** Information about the sales channel the subscription was purchased through. */
110
126
  channelInfo?: ChannelInfo;
111
127
  /**
112
128
  * Custom fields.
@@ -114,7 +130,7 @@ interface SubscriptionContract {
114
130
  */
115
131
  customFields?: CustomField[];
116
132
  /**
117
- * Order recipient address and contact details.
133
+ * Recipient address and contact details.
118
134
  *
119
135
  * This field may differ from the address in `shippingInfo.logistics` when:
120
136
  * + The chosen shipping option is pickup point or store pickup.
@@ -124,7 +140,7 @@ interface SubscriptionContract {
124
140
  /**
125
141
  * Custom field data for the subscription contract object.
126
142
  *
127
- * [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.
143
+ * [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.
128
144
  */
129
145
  extendedFields?: ExtendedFields;
130
146
  /**
@@ -136,12 +152,13 @@ interface SubscriptionContract {
136
152
  */
137
153
  title?: string | null;
138
154
  /**
139
- * Subscription title. For example, `"Monthly coffee Subscription"`.
140
- * @internal
155
+ * Subscription title, in the site's default language and translated into the buyer's language. For example, `"Monthly coffee subscription"`.
156
+ *
157
+ * For a subscription contract with more than one line item, holds a general name for the subscription.
141
158
  */
142
159
  subscriptionTitle?: V1SubscriptionTitle;
143
160
  /**
144
- * Additional fees applied to subscription contract.
161
+ * Additional fees applied to the subscription contract.
145
162
  * @maxSize 100
146
163
  */
147
164
  additionalFees?: AdditionalFee[];
@@ -156,7 +173,8 @@ interface SubscriptionContract {
156
173
  */
157
174
  settings?: SubscriptionContractSettings;
158
175
  /**
159
- * Activities recorded on this contract (e.g. draft commits, status changes).
176
+ * Record of changes made to the subscription contract after checkout.
177
+ * @internal
160
178
  * @readonly
161
179
  * @maxSize 500
162
180
  */
@@ -164,18 +182,18 @@ interface SubscriptionContract {
164
182
  }
165
183
  interface V1SubscriptionDescription {
166
184
  /**
167
- * Subscription option description.
185
+ * Subscription description in the site's default language.
168
186
  * @maxLength 500
169
187
  */
170
188
  original?: string;
171
189
  /**
172
- * Translated subscription option description.
190
+ * Subscription description translated into the buyer's language.
173
191
  * @maxLength 500
174
192
  */
175
193
  translated?: string | null;
176
194
  }
177
195
  interface V1SubscriptionSettings {
178
- /** Frequency of recurring payment. */
196
+ /** Frequency unit of the billing cycle. */
179
197
  frequency?: SubscriptionFrequencyWithLiterals;
180
198
  /**
181
199
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -183,19 +201,23 @@ interface V1SubscriptionSettings {
183
201
  * @max 3650
184
202
  */
185
203
  interval?: number | null;
186
- /** Whether subscription is renewed automatically at the end of each period. */
204
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
187
205
  autoRenewal?: boolean;
188
206
  /**
189
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
207
+ * Number of billing cycles before the subscription ends.
190
208
  * @min 1
191
209
  */
192
210
  billingCycles?: number | null;
193
- /** Whether to allow the customer to cancel the subscription. */
211
+ /** Whether the buyer can cancel the subscription. */
194
212
  enableCustomerCancellation?: boolean;
195
- /** Period until first cycle starts. If None => no free trial */
213
+ /**
214
+ * Free trial period before the first billing cycle starts.
215
+ *
216
+ * Returned only when the subscription has a free trial.
217
+ */
196
218
  freeTrialPeriod?: V1FreeTrialPeriod;
197
219
  /**
198
- * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
220
+ * Date and time the subscription starts. The first charge is made on this date, or when the free trial ends.
199
221
  * @internal
200
222
  */
201
223
  startDate?: Date | null;
@@ -227,7 +249,7 @@ declare enum SubscriptionFrequency {
227
249
  /** @enumType */
228
250
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
229
251
  interface V1FreeTrialPeriod {
230
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
252
+ /** Frequency unit of the free trial period. */
231
253
  frequency?: SubscriptionFrequencyWithLiterals;
232
254
  /**
233
255
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -497,6 +519,12 @@ interface OrderLineItem {
497
519
  * @readonly
498
520
  */
499
521
  serviceProperties?: ServiceProperties;
522
+ /**
523
+ * 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.
524
+ * @internal
525
+ * @readonly
526
+ */
527
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
500
528
  }
501
529
  interface ProductName {
502
530
  /**
@@ -1367,6 +1395,76 @@ interface ServiceProperties {
1367
1395
  */
1368
1396
  endDate?: Date | null;
1369
1397
  }
1398
+ /**
1399
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1400
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1401
+ *
1402
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1403
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1404
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1405
+ */
1406
+ interface CrossBorderPriceAdjustment {
1407
+ /**
1408
+ * ID of the tax region whose tax is built into the catalog prices.
1409
+ * @format GUID
1410
+ */
1411
+ baseTaxRegionId?: string;
1412
+ /**
1413
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1414
+ * @format GUID
1415
+ */
1416
+ destinationTaxRegionId?: string | null;
1417
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1418
+ catalogPrice?: Price;
1419
+ /** 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. */
1420
+ baseTaxAmount?: Price;
1421
+ /** Outcome of the repricing for this line. */
1422
+ status?: RepriceStatusWithLiterals;
1423
+ /** 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`. */
1424
+ baseRateSource?: BaseRateSourceWithLiterals;
1425
+ /**
1426
+ * 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.
1427
+ * @format DECIMAL_VALUE
1428
+ * @decimalValue options { gte:0, maxScale:6 }
1429
+ */
1430
+ baseRate?: string | null;
1431
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1432
+ baseRateCapturedDate?: Date | null;
1433
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1434
+ destinationTaxIncluded?: boolean | null;
1435
+ }
1436
+ /** Outcome of the repricing for one line. */
1437
+ declare enum RepriceStatus {
1438
+ /** Base tax removed and the destination's tax applied. */
1439
+ APPLIED = "APPLIED",
1440
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1441
+ KEPT = "KEPT",
1442
+ /** 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`. */
1443
+ STRIP_ONLY = "STRIP_ONLY",
1444
+ /** The destination is the base region. Nothing was removed. */
1445
+ SAME_REGION = "SAME_REGION",
1446
+ /** 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. */
1447
+ SAME_COUNTRY = "SAME_COUNTRY",
1448
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1449
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1450
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1451
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1452
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1453
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1454
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1455
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1456
+ }
1457
+ /** @enumType */
1458
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1459
+ /** Where the base region's rate came from. */
1460
+ declare enum BaseRateSource {
1461
+ /** The manual tax calculator computed the base tax for this calculation. */
1462
+ MANUAL_SPI = "MANUAL_SPI",
1463
+ /** The rate captured from Avalara by the embedded-rate probe. */
1464
+ AVALARA_PROBE = "AVALARA_PROBE"
1465
+ }
1466
+ /** @enumType */
1467
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1370
1468
  /** Buyer information. */
1371
1469
  interface BuyerInfo extends BuyerInfoIdOneOf {
1372
1470
  /**
@@ -1785,6 +1883,12 @@ interface ShippingPrice {
1785
1883
  * @readonly
1786
1884
  */
1787
1885
  discount?: Price;
1886
+ /**
1887
+ * Cross-border repricing record of the shipping cost on a site whose catalog prices include tax.
1888
+ * @internal
1889
+ * @readonly
1890
+ */
1891
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
1788
1892
  }
1789
1893
  interface ShippingRegion {
1790
1894
  /**
@@ -1821,6 +1925,12 @@ interface OrderTaxInfo {
1821
1925
  * @readonly
1822
1926
  */
1823
1927
  totalExempt?: Price;
1928
+ /**
1929
+ * 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.
1930
+ * @internal
1931
+ * @readonly
1932
+ */
1933
+ crossBorderCalculation?: CrossBorderCalculation;
1824
1934
  }
1825
1935
  /**
1826
1936
  * 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.
@@ -1863,6 +1973,56 @@ interface OrderTaxBreakdown {
1863
1973
  */
1864
1974
  aggregatedExemptAmount?: Price;
1865
1975
  }
1976
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1977
+ interface CrossBorderCalculation {
1978
+ /** Whether the calculation repriced the lines for the destination's tax. */
1979
+ applied?: boolean;
1980
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
1981
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
1982
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
1983
+ mode?: CrossBorderRepricingModeWithLiterals;
1984
+ /**
1985
+ * Request ID of the calculation, for log correlation.
1986
+ * @maxLength 100
1987
+ */
1988
+ requestId?: string | null;
1989
+ }
1990
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
1991
+ declare enum CrossBorderNotApplicableReason {
1992
+ /** The repricing feature toggle is off. */
1993
+ FEATURE_DISABLED = "FEATURE_DISABLED",
1994
+ /** The site hasn't opted in to cross-border repricing. */
1995
+ NOT_OPTED_IN = "NOT_OPTED_IN",
1996
+ /** The site's prices no longer include tax. */
1997
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
1998
+ /** The base tax region doesn't exist on the site. */
1999
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
2000
+ /** The base region uses the manual calculator and has no tax mapping. */
2001
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
2002
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
2003
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
2004
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
2005
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
2006
+ /** The line items were repriced. Repricing the shipping option failed. */
2007
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
2008
+ /** The line items were repriced. Repricing the additional fees failed. */
2009
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
2010
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
2011
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
2012
+ }
2013
+ /** @enumType */
2014
+ 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';
2015
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
2016
+ declare enum CrossBorderRepricingMode {
2017
+ /** Nothing is repriced. */
2018
+ DISABLED = "DISABLED",
2019
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
2020
+ STRIP_ONLY = "STRIP_ONLY",
2021
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
2022
+ FULL = "FULL"
2023
+ }
2024
+ /** @enumType */
2025
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1866
2026
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1867
2027
  /** Coupon applied by the customer. */
1868
2028
  coupon?: Coupon;
@@ -2154,15 +2314,13 @@ interface CustomField {
2154
2314
  }
2155
2315
  interface V1SubscriptionTitle {
2156
2316
  /**
2157
- * 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).
2317
+ * Subscription title in the site's default language.
2158
2318
  * @minLength 1
2159
2319
  * @maxLength 150
2160
2320
  */
2161
2321
  original?: string;
2162
2322
  /**
2163
- * Subscription option name translated into the buyer's language.
2164
- *
2165
- * Default: Same as `original`.
2323
+ * Subscription title translated into the buyer's language.
2166
2324
  * @minLength 1
2167
2325
  * @maxLength 150
2168
2326
  */
@@ -2225,6 +2383,12 @@ interface AdditionalFee {
2225
2383
  source?: AdditionalFeeSourceWithLiterals;
2226
2384
  /** Address type tax was calculated against for this fee. */
2227
2385
  taxableAddress?: TaxableAddress;
2386
+ /**
2387
+ * Cross-border repricing record of the fee on a site whose catalog prices include tax.
2388
+ * @internal
2389
+ * @readonly
2390
+ */
2391
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
2228
2392
  }
2229
2393
  declare enum AdditionalFeeSource {
2230
2394
  /** The additional fee was added by an additional fee service plugin. */
@@ -2273,7 +2437,7 @@ declare enum SpecificItemsCouponBehavior {
2273
2437
  /** @enumType */
2274
2438
  type SpecificItemsCouponBehaviorWithLiterals = SpecificItemsCouponBehavior | 'UNDEFINED_COUPON_BEHAVIOR' | 'ITEM_SUBTOTAL_INCLUDES_DISCOUNT' | 'LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT';
2275
2439
  interface SubscriptionContractActivity extends SubscriptionContractActivityTargetOneOf, SubscriptionContractActivityContentOneOf {
2276
- /** Scopes the draft to the contract level, applying to all future cycles. */
2440
+ /** The activity applies to all future billing cycles of the subscription contract. */
2277
2441
  contractTarget?: ContractTarget;
2278
2442
  /** Changes committed from a DraftSubscriptionContract. */
2279
2443
  changesApplied?: ChangesAppliedActivity;
@@ -2284,12 +2448,12 @@ interface SubscriptionContractActivity extends SubscriptionContractActivityTarge
2284
2448
  */
2285
2449
  id?: string;
2286
2450
  /**
2287
- * When the activity occurred.
2451
+ * Date and time the activity occurred.
2288
2452
  * @readonly
2289
2453
  */
2290
2454
  createdDate?: Date | null;
2291
2455
  /**
2292
- * Identity of the draft order's initiator.
2456
+ * Wix user or app that made the change.
2293
2457
  * @readonly
2294
2458
  */
2295
2459
  author?: ActivityAuthor;
@@ -2298,7 +2462,7 @@ interface SubscriptionContractActivity extends SubscriptionContractActivityTarge
2298
2462
  }
2299
2463
  /** @oneof */
2300
2464
  interface SubscriptionContractActivityTargetOneOf {
2301
- /** Scopes the draft to the contract level, applying to all future cycles. */
2465
+ /** The activity applies to all future billing cycles of the subscription contract. */
2302
2466
  contractTarget?: ContractTarget;
2303
2467
  }
2304
2468
  /** @oneof */
@@ -2306,19 +2470,19 @@ interface SubscriptionContractActivityContentOneOf {
2306
2470
  /** Changes committed from a DraftSubscriptionContract. */
2307
2471
  changesApplied?: ChangesAppliedActivity;
2308
2472
  }
2309
- /** Scopes the draft to the contract level, applying to all future cycles. */
2473
+ /** Target that applies changes to all future billing cycles of the subscription contract. */
2310
2474
  interface ContractTarget {
2311
- /** Cycle number of the next billing cycle (1-based). Set by the caller; returned by the server on read. */
2475
+ /** Number of the first billing cycle the changes apply to. Billing cycles are numbered from `1`. */
2312
2476
  nextCycleNumber?: number | null;
2313
2477
  }
2314
2478
  interface ActivityAuthor extends ActivityAuthorValueOneOf {
2315
2479
  /**
2316
- * User ID. When the draft order was created by a Wix user.
2480
+ * Wix user ID. Returned when a Wix user made the change.
2317
2481
  * @format GUID
2318
2482
  */
2319
2483
  userId?: string;
2320
2484
  /**
2321
- * App ID. When the draft order was created by an app.
2485
+ * App ID. Returned when an app made the change.
2322
2486
  * @format GUID
2323
2487
  */
2324
2488
  appId?: string;
@@ -2326,74 +2490,76 @@ interface ActivityAuthor extends ActivityAuthorValueOneOf {
2326
2490
  /** @oneof */
2327
2491
  interface ActivityAuthorValueOneOf {
2328
2492
  /**
2329
- * User ID. When the draft order was created by a Wix user.
2493
+ * Wix user ID. Returned when a Wix user made the change.
2330
2494
  * @format GUID
2331
2495
  */
2332
2496
  userId?: string;
2333
2497
  /**
2334
- * App ID. When the draft order was created by an app.
2498
+ * App ID. Returned when an app made the change.
2335
2499
  * @format GUID
2336
2500
  */
2337
2501
  appId?: string;
2338
2502
  }
2339
2503
  interface ChangesAppliedActivity extends ChangesAppliedActivityTargetOneOf {
2340
- /** Scopes the draft to the contract level, applying to all future cycles. */
2504
+ /** The changes apply to all future billing cycles of the subscription contract. */
2341
2505
  contractTarget?: ContractTarget;
2342
2506
  /**
2343
- * ID of the DraftSubscriptionContract that was committed.
2507
+ * ID of the draft subscription contract whose changes were committed.
2344
2508
  * @format GUID
2345
2509
  */
2346
2510
  draftSubscriptionContractId?: string;
2347
2511
  /**
2348
- * Individual typed changes applied.
2512
+ * Changes that were applied to the subscription contract.
2349
2513
  * @maxSize 100
2350
2514
  */
2351
2515
  changes?: ContractChange[];
2352
2516
  /**
2353
- * Reason for the edit, provided by the merchant (optional).
2517
+ * Reason for the change, provided by the business.
2354
2518
  * @maxLength 200
2355
2519
  */
2356
2520
  reason?: string | null;
2357
2521
  }
2358
2522
  /** @oneof */
2359
2523
  interface ChangesAppliedActivityTargetOneOf {
2360
- /** Scopes the draft to the contract level, applying to all future cycles. */
2524
+ /** The changes apply to all future billing cycles of the subscription contract. */
2361
2525
  contractTarget?: ContractTarget;
2362
2526
  }
2363
- interface ContractChange extends ContractChangeValueOneOf {
2527
+ interface ContractChange extends ContractChangeChangeDetailsOneOf {
2364
2528
  /** Line item was modified. */
2365
2529
  lineItemChanged?: LineItemChanges;
2366
2530
  /** Line item was added to the contract. */
2367
- lineItemAdded?: ManagedLineItem;
2531
+ lineItemAdded?: LineItemSummary;
2368
2532
  /** Line item was removed from the contract. */
2369
- lineItemRemoved?: ManagedLineItem;
2533
+ lineItemRemoved?: LineItemSummary;
2370
2534
  /** Discount was added to the contract. */
2371
- discountAdded?: ManagedDiscount;
2535
+ discountAdded?: DiscountSummary;
2372
2536
  /** Discount was removed from the contract. */
2373
- discountRemoved?: ManagedDiscount;
2537
+ discountRemoved?: DiscountSummary;
2374
2538
  /** Additional fee was added to the contract. */
2375
- additionalFeeAdded?: ManagedAdditionalFee;
2539
+ additionalFeeAdded?: AdditionalFeeSummary;
2376
2540
  /** Additional fee was removed from the contract. */
2377
- additionalFeeRemoved?: ManagedAdditionalFee;
2541
+ additionalFeeRemoved?: AdditionalFeeSummary;
2378
2542
  /** Total price changed. */
2379
2543
  totalPriceChanged?: TotalPriceChange;
2544
+ /** Type of change. */
2545
+ changeType?: ContractChangeTypeWithLiterals;
2380
2546
  }
2381
2547
  /** @oneof */
2382
- interface ContractChangeValueOneOf {
2548
+ interface ContractChangeChangeDetailsOneOf {
2383
2549
  /** Line item was modified. */
2384
2550
  lineItemChanged?: LineItemChanges;
2385
2551
  /** Line item was added to the contract. */
2386
- lineItemAdded?: ManagedLineItem;
2552
+ lineItemAdded?: LineItemSummary;
2387
2553
  /** Line item was removed from the contract. */
2388
- lineItemRemoved?: ManagedLineItem;
2554
+ lineItemRemoved?: LineItemSummary;
2389
2555
  /** Discount was added to the contract. */
2390
- discountAdded?: ManagedDiscount;
2556
+ discountAdded?: DiscountSummary;
2391
2557
  /** Discount was removed from the contract. */
2392
- discountRemoved?: ManagedDiscount;
2558
+ discountRemoved?: DiscountSummary;
2393
2559
  /** Additional fee was added to the contract. */
2394
- additionalFeeAdded?: ManagedAdditionalFee;
2560
+ additionalFeeAdded?: AdditionalFeeSummary;
2395
2561
  /** Additional fee was removed from the contract. */
2396
- additionalFeeRemoved?: ManagedAdditionalFee;
2562
+ additionalFeeRemoved?: AdditionalFeeSummary;
2397
2563
  /** Total price changed. */
2398
2564
  totalPriceChanged?: TotalPriceChange;
2399
2565
  }
@@ -2409,11 +2575,15 @@ interface LineItemChanges {
2409
2575
  quantity?: LineItemQuantityChange;
2410
2576
  }
2411
2577
  declare enum LineItemQuantityChangeType {
2578
+ /** Unknown quantity change type. */
2579
+ UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE = "UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE",
2580
+ /** Quantity increased. */
2412
2581
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
2582
+ /** Quantity decreased. */
2413
2583
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
2414
2584
  }
2415
2585
  /** @enumType */
2416
- type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
2586
+ type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE' | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
2417
2587
  interface LineItemQuantityChange {
2418
2588
  /**
2419
2589
  * Original item quantity before the change.
@@ -2430,11 +2600,11 @@ interface LineItemQuantityChange {
2430
2600
  * @min 1
2431
2601
  * @max 1000000
2432
2602
  */
2433
- diff?: number;
2603
+ quantityDifference?: number;
2434
2604
  /** Direction of the quantity change. */
2435
2605
  deltaType?: LineItemQuantityChangeTypeWithLiterals;
2436
2606
  }
2437
- interface ManagedLineItem {
2607
+ interface LineItemSummary {
2438
2608
  /**
2439
2609
  * Line item ID.
2440
2610
  * @format GUID
@@ -2449,7 +2619,7 @@ interface ManagedLineItem {
2449
2619
  */
2450
2620
  quantity?: number;
2451
2621
  }
2452
- interface ManagedDiscount {
2622
+ interface DiscountSummary {
2453
2623
  /**
2454
2624
  * Discount ID.
2455
2625
  * @format GUID
@@ -2472,7 +2642,7 @@ interface TranslatedValue {
2472
2642
  */
2473
2643
  translated?: string | null;
2474
2644
  }
2475
- interface ManagedAdditionalFee {
2645
+ interface AdditionalFeeSummary {
2476
2646
  /**
2477
2647
  * Additional fee ID.
2478
2648
  * @format GUID
@@ -2489,8 +2659,32 @@ interface TotalPriceChange {
2489
2659
  /** Total price after the commit. */
2490
2660
  newTotal?: Price;
2491
2661
  }
2662
+ declare enum ContractChangeType {
2663
+ /** Unknown change type. */
2664
+ UNKNOWN_CONTRACT_CHANGE_TYPE = "UNKNOWN_CONTRACT_CHANGE_TYPE",
2665
+ /** Line item was modified. */
2666
+ LINE_ITEM_CHANGED = "LINE_ITEM_CHANGED",
2667
+ /** Line item was added to the contract. */
2668
+ LINE_ITEM_ADDED = "LINE_ITEM_ADDED",
2669
+ /** Line item was removed from the contract. */
2670
+ LINE_ITEM_REMOVED = "LINE_ITEM_REMOVED",
2671
+ /** Discount was added to the contract. */
2672
+ DISCOUNT_ADDED = "DISCOUNT_ADDED",
2673
+ /** Discount was removed from the contract. */
2674
+ DISCOUNT_REMOVED = "DISCOUNT_REMOVED",
2675
+ /** Additional fee was added to the contract. */
2676
+ ADDITIONAL_FEE_ADDED = "ADDITIONAL_FEE_ADDED",
2677
+ /** Additional fee was removed from the contract. */
2678
+ ADDITIONAL_FEE_REMOVED = "ADDITIONAL_FEE_REMOVED",
2679
+ /** Total price changed. */
2680
+ TOTAL_PRICE_CHANGED = "TOTAL_PRICE_CHANGED"
2681
+ }
2682
+ /** @enumType */
2683
+ 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';
2492
2684
  declare enum ActivityType {
2685
+ /** Unknown activity type. */
2493
2686
  UNKNOWN_ACTIVITY_TYPE = "UNKNOWN_ACTIVITY_TYPE",
2687
+ /** Changes from a draft subscription contract were committed. */
2494
2688
  CHANGES_APPLIED = "CHANGES_APPLIED"
2495
2689
  }
2496
2690
  /** @enumType */
@@ -2521,30 +2715,26 @@ interface SubscriptionContractExpired {
2521
2715
  /** The subscription contract that expired. */
2522
2716
  subscriptionContract?: SubscriptionContract;
2523
2717
  }
2524
- /**
2525
- * ACTION event payload emitted after a successful commit.
2526
- * Carries the full delta — downstream consumers (email notifications, activity feed)
2527
- * subscribe to this event and have all details inline without fetching the draft.
2528
- */
2718
+ /** Triggered when changes from a draft subscription contract are committed to a subscription contract. */
2529
2719
  interface SubscriptionContractChangesCommitted {
2530
- /** Updated SubscriptionContract after commit. */
2720
+ /** Subscription contract after the changes were committed. */
2531
2721
  subscriptionContract?: SubscriptionContract;
2532
2722
  /**
2533
- * ID of the DraftSubscriptionContract that triggered this commit.
2723
+ * ID of the draft subscription contract whose changes were committed.
2534
2724
  * @format GUID
2535
2725
  */
2536
2726
  draftSubscriptionContractId?: string;
2537
- /** The actual delta applied. */
2727
+ /** Changes that were applied to the subscription contract. */
2538
2728
  changes?: SubscriptionContractDiffs;
2539
2729
  /**
2540
2730
  * Date and time the changes were committed.
2541
2731
  * @readonly
2542
2732
  */
2543
2733
  commitDate?: Date | null;
2544
- /** Side-effects requested by the caller when the changes were committed. */
2734
+ /** Notification settings specified when the changes were committed. */
2545
2735
  commitSettings?: SubscriptionCommitSettings;
2546
2736
  /**
2547
- * Reason for the edit, provided by the merchant.
2737
+ * Reason for the change, provided by the business.
2548
2738
  * @maxLength 200
2549
2739
  */
2550
2740
  reason?: string | null;
@@ -2553,39 +2743,49 @@ interface SubscriptionContractChangesCommitted {
2553
2743
  }
2554
2744
  interface SubscriptionContractDiffs {
2555
2745
  /**
2556
- * Per-item deltas: added, changed, or removed line items.
2746
+ * Line items that were added, changed, or removed.
2747
+ *
2748
+ * A line item is `CHANGED` when a field listed in `ItemChangedDetails` changed. Line items with no change aren't included.
2557
2749
  * @maxSize 100
2558
2750
  */
2559
2751
  lineItems?: LineItemDelta[];
2560
2752
  /**
2561
- * Per-discount deltas.
2753
+ * Discounts that were added, changed, or removed.
2754
+ *
2755
+ * 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.
2562
2756
  * @maxSize 100
2563
2757
  */
2564
2758
  appliedDiscounts?: AppliedDiscountDelta[];
2565
2759
  /**
2566
- * Per-fee deltas.
2760
+ * Additional fees that were added, changed, or removed.
2761
+ *
2762
+ * An additional fee is `CHANGED` when its price or the line items it applies to changed. Fees with no change aren't included.
2567
2763
  * @maxSize 100
2568
2764
  */
2569
2765
  additionalFees?: AdditionalFeeDelta[];
2570
- /** Updated price summary (overwrites existing). */
2766
+ /** Price summary after the changes. Replaces the subscription contract's previous price summary. */
2571
2767
  priceSummary?: PriceSummary;
2572
- /** Updated tax info (overwrites existing). */
2768
+ /** Tax information after the changes. Replaces the subscription contract's previous tax information. */
2573
2769
  taxInfo?: OrderTaxInfo;
2770
+ /** Shipping information after the changes. Replaces the subscription contract's previous shipping information. */
2771
+ shippingInfo?: ShippingInformation;
2574
2772
  }
2575
2773
  interface LineItemDelta extends LineItemDeltaDeltaDetailsOneOf {
2774
+ /** Values the line item had before the change. */
2576
2775
  changed?: ItemChangedDetails;
2577
2776
  /**
2578
2777
  * Line item ID.
2579
2778
  * @format GUID
2580
2779
  */
2581
2780
  lineItemId?: string;
2582
- /** Full line item content (absent for removed items). */
2781
+ /** Line item content. For a removed line item, the line item that was removed. */
2583
2782
  lineItem?: OrderLineItem;
2584
2783
  /** Type of change applied to this line item. */
2585
2784
  changeType?: ChangeTypeWithLiterals;
2586
2785
  }
2587
2786
  /** @oneof */
2588
2787
  interface LineItemDeltaDeltaDetailsOneOf {
2788
+ /** Values the line item had before the change. */
2589
2789
  changed?: ItemChangedDetails;
2590
2790
  }
2591
2791
  interface CommonImage {
@@ -2621,174 +2821,179 @@ interface CommonImage {
2621
2821
  */
2622
2822
  filename?: string | null;
2623
2823
  }
2624
- /** the catalog reference options before the change. */
2824
+ /** The catalog reference options before the change. */
2625
2825
  interface CatalogReferenceOptionsBeforeChange {
2626
- /** the catalog reference options. Absent when the line item had no options. */
2826
+ /** The catalog reference options. Absent when the line item had no options. */
2627
2827
  options?: Record<string, any> | null;
2628
2828
  }
2629
- /** the product name before the change. */
2829
+ /** The product name before the change. */
2630
2830
  interface ProductNameBeforeChange {
2631
- /** the product name. Absent when the line item had no product name. */
2831
+ /** The product name. Absent when the line item had no product name. */
2632
2832
  productName?: ProductName;
2633
2833
  }
2634
- /** the description lines before the change. */
2834
+ /** The description lines before the change. */
2635
2835
  interface DescriptionLinesBeforeChange {
2636
2836
  /**
2637
- * the description lines. Empty when the line item had no description lines.
2837
+ * The description lines. Empty when the line item had no description lines.
2638
2838
  * @maxSize 20
2639
2839
  */
2640
2840
  descriptionLines?: DescriptionLine[];
2641
2841
  }
2642
- /** the image before the change. */
2842
+ /** The image before the change. */
2643
2843
  interface ImageBeforeChange {
2644
- /** the image. Absent when the line item had no image. */
2844
+ /** The image. Absent when the line item had no image. */
2645
2845
  image?: CommonImage;
2646
2846
  }
2647
- /** the physical properties before the change. */
2847
+ /** The physical properties before the change. */
2648
2848
  interface PhysicalPropertiesBeforeChange {
2649
- /** the physical properties. Absent when the line item had no physical properties. */
2849
+ /** The physical properties. Absent when the line item had no physical properties. */
2650
2850
  physicalProperties?: PhysicalProperties;
2651
2851
  }
2652
- /** the item type before the change. */
2852
+ /** The item type before the change. */
2653
2853
  interface ItemTypeBeforeChange {
2654
- /** the item type. Absent when the line item had no item type. */
2854
+ /** The item type. Absent when the line item had no item type. */
2655
2855
  itemType?: ItemType;
2656
2856
  }
2657
- /** the fulfiller ID before the change. */
2857
+ /** The fulfiller ID before the change. */
2658
2858
  interface FulfillerIdBeforeChange {
2659
2859
  /**
2660
- * the fulfiller ID. Absent when the line item had no fulfiller.
2860
+ * The fulfiller ID. Absent when the line item had no fulfiller.
2661
2861
  * @format GUID
2662
2862
  */
2663
2863
  fulfillerId?: string | null;
2664
2864
  }
2665
- /** the digital file before the change. */
2865
+ /** The digital file before the change. */
2666
2866
  interface DigitalFileBeforeChange {
2667
- /** the digital file. Absent when the line item had no digital file. */
2867
+ /** The digital file. Absent when the line item had no digital file. */
2668
2868
  digitalFile?: DigitalFile;
2669
2869
  }
2670
- /** the price description before the change. */
2870
+ /** The price description before the change. */
2671
2871
  interface PriceDescriptionBeforeChange {
2672
- /** the price description. Absent when the line item had no price description. */
2872
+ /** The price description. Absent when the line item had no price description. */
2673
2873
  priceDescription?: PriceDescription;
2674
2874
  }
2675
- /** the delivery profile ID before the change. */
2875
+ /** The delivery profile ID before the change. */
2676
2876
  interface DeliveryProfileIdBeforeChange {
2677
2877
  /**
2678
- * the delivery profile ID. Absent when the line item had no delivery profile.
2878
+ * The delivery profile ID. Absent when the line item had no delivery profile.
2679
2879
  * @format GUID
2680
2880
  */
2681
2881
  deliveryProfileId?: string | null;
2682
2882
  }
2683
- /** the shipping group ID before the change. */
2883
+ /** The shipping group ID before the change. */
2684
2884
  interface ShippingGroupIdBeforeChange {
2685
2885
  /**
2686
- * the shipping group ID. Absent when the line item had no shipping group.
2886
+ * The shipping group ID. Absent when the line item had no shipping group.
2687
2887
  * @format GUID
2688
2888
  */
2689
2889
  shippingGroupId?: string | null;
2690
2890
  }
2691
- /** the tax info before the change. */
2891
+ /** The tax info before the change. */
2692
2892
  interface TaxInfoBeforeChange {
2693
- /** the tax info. Absent when the line item had no tax info. */
2893
+ /** The tax info. Absent when the line item had no tax info. */
2694
2894
  taxInfo?: LineItemTaxInfo;
2695
2895
  }
2696
- /** the inventory app ID before the change. */
2896
+ /** The inventory app ID before the change. */
2697
2897
  interface InventoryAppIdBeforeChange {
2698
2898
  /**
2699
- * the inventory app ID. Absent when the line item had no inventory app.
2899
+ * The inventory app ID. Absent when the line item had no inventory app.
2700
2900
  * @format GUID
2701
2901
  */
2702
2902
  inventoryAppId?: string | null;
2703
2903
  }
2704
- /** the root catalog item ID before the change. */
2904
+ /** The root catalog item ID before the change. */
2705
2905
  interface RootCatalogItemIdBeforeChange {
2706
2906
  /**
2707
- * the root catalog item ID. Absent when the line item had no root catalog item.
2907
+ * The root catalog item ID. Absent when the line item had no root catalog item.
2708
2908
  * @minLength 1
2709
2909
  * @maxLength 36
2710
2910
  */
2711
2911
  rootCatalogItemId?: string | null;
2712
2912
  }
2713
- /** the modifier groups before the change. */
2913
+ /** The modifier groups before the change. */
2714
2914
  interface ModifierGroupsBeforeChange {
2715
2915
  /**
2716
- * the modifier groups. Empty when the line item had no modifier groups.
2916
+ * The modifier groups. Empty when the line item had no modifier groups.
2717
2917
  * @maxSize 10
2718
2918
  */
2719
2919
  modifierGroups?: ModifierGroup[];
2720
2920
  }
2721
- /** the price undetermined flag before the change. */
2921
+ /** The price undetermined flag before the change. */
2722
2922
  interface PriceUndeterminedBeforeChange {
2723
- /** whether the price of the line item was undetermined. */
2923
+ /** Whether the price of the line item was undetermined. */
2724
2924
  priceUndetermined?: boolean;
2725
2925
  }
2726
- /** Describes the type of change applied to an element. */
2926
+ /** Type of change to a line item, discount, or additional fee. */
2727
2927
  declare enum ChangeType {
2928
+ /** Unknown change type. */
2728
2929
  UNKNOWN_CHANGE_TYPE = "UNKNOWN_CHANGE_TYPE",
2729
- /** Element was added (absent in the original contract). */
2930
+ /** The line item, discount, or additional fee was added to the subscription contract. */
2730
2931
  ADDED = "ADDED",
2731
- /** Element was modified from the original contract. */
2932
+ /** The line item, discount, or additional fee was changed. */
2732
2933
  CHANGED = "CHANGED",
2733
- /** Element was removed from the contract. */
2934
+ /** The line item, discount, or additional fee was removed from the subscription contract. */
2734
2935
  REMOVED = "REMOVED"
2735
2936
  }
2736
2937
  /** @enumType */
2737
2938
  type ChangeTypeWithLiterals = ChangeType | 'UNKNOWN_CHANGE_TYPE' | 'ADDED' | 'CHANGED' | 'REMOVED';
2738
2939
  interface ItemChangedDetails {
2739
2940
  /**
2740
- * The quantity before the change.
2941
+ * The quantity before the change. Set only when the quantity changed.
2741
2942
  * @min 1
2742
2943
  * @max 1000000
2743
2944
  */
2744
2945
  quantityBeforeChange?: number | null;
2745
- /** The price before the change. */
2946
+ /** The price before the change. Set only when the price changed. */
2746
2947
  priceBeforeChange?: Price;
2747
- /** the catalog reference options before the change. Set only when the catalog reference options changed. */
2948
+ /** The catalog reference options before the change. Set only when the catalog reference options changed. */
2748
2949
  catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
2749
- /** the product name before the change. Set only when the product name changed. */
2950
+ /** The product name before the change. Set only when the product name changed. */
2750
2951
  productNameBeforeChange?: ProductNameBeforeChange;
2751
- /** the description lines before the change. Set only when the description lines changed. */
2952
+ /** The description lines before the change. Set only when the description lines changed. */
2752
2953
  descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
2753
- /** the image before the change. Set only when the image changed. */
2954
+ /** The image before the change. Set only when the image changed. */
2754
2955
  imageBeforeChange?: ImageBeforeChange;
2755
- /** the physical properties before the change. Set only when the physical properties changed. */
2956
+ /** The physical properties before the change. Set only when the physical properties changed. */
2756
2957
  physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
2757
- /** the item type before the change. Set only when the item type changed. */
2958
+ /** The item type before the change. Set only when the item type changed. */
2758
2959
  itemTypeBeforeChange?: ItemTypeBeforeChange;
2759
- /** the fulfiller ID before the change. Set only when the fulfiller ID changed. */
2960
+ /** The fulfiller ID before the change. Set only when the fulfiller ID changed. */
2760
2961
  fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
2761
- /** the digital file before the change. Set only when the digital file changed. */
2962
+ /** The digital file before the change. Set only when the digital file changed. */
2762
2963
  digitalFileBeforeChange?: DigitalFileBeforeChange;
2763
- /** the price description before the change. Set only when the price description changed. */
2964
+ /** The price description before the change. Set only when the price description changed. */
2764
2965
  priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
2765
2966
  /**
2766
- * the delivery profile ID before the change. Set only when the delivery profile ID changed.
2967
+ * The delivery profile ID before the change. Set only when the delivery profile ID changed.
2767
2968
  * @internal
2768
2969
  */
2769
2970
  deliveryProfileIdBeforeChange?: DeliveryProfileIdBeforeChange;
2770
2971
  /**
2771
- * the shipping group ID before the change. Set only when the shipping group ID changed.
2972
+ * The shipping group ID before the change. Set only when the shipping group ID changed.
2772
2973
  * @internal
2773
2974
  */
2774
2975
  shippingGroupIdBeforeChange?: ShippingGroupIdBeforeChange;
2775
- /** the tax info before the change. Set only when the tax group changed. */
2976
+ /** The tax info before the change. Set only when the line item's tax group changed because its catalog options changed. */
2776
2977
  taxInfoBeforeChange?: TaxInfoBeforeChange;
2777
- /** the inventory app ID before the change. Set only when the inventory app ID changed. */
2978
+ /**
2979
+ * The inventory app ID before the change. Set only when the inventory app ID changed.
2980
+ * @internal
2981
+ */
2778
2982
  inventoryAppIdBeforeChange?: InventoryAppIdBeforeChange;
2779
2983
  /**
2780
- * the root catalog item ID before the change. Set only when the root catalog item ID changed.
2984
+ * The root catalog item ID before the change. Set only when the root catalog item ID changed.
2781
2985
  * @internal
2782
2986
  */
2783
2987
  rootCatalogItemIdBeforeChange?: RootCatalogItemIdBeforeChange;
2784
- /** the modifier groups before the change. Set only when the modifier groups changed. */
2988
+ /** The modifier groups before the change. Set only when the modifier groups changed. */
2785
2989
  modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
2786
- /** the price undetermined flag before the change. Set only when the price undetermined flag changed. */
2990
+ /** The price undetermined flag before the change. Set only when the price undetermined flag changed. */
2787
2991
  priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
2788
2992
  }
2789
2993
  interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2790
2994
  /** Discount content after the change. */
2791
2995
  changed?: AppliedDiscount;
2996
+ /** Discount that was added. */
2792
2997
  added?: AppliedDiscount;
2793
2998
  /**
2794
2999
  * Discount ID.
@@ -2802,11 +3007,13 @@ interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2802
3007
  interface AppliedDiscountDeltaDeltaDetailsOneOf {
2803
3008
  /** Discount content after the change. */
2804
3009
  changed?: AppliedDiscount;
3010
+ /** Discount that was added. */
2805
3011
  added?: AppliedDiscount;
2806
3012
  }
2807
3013
  interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
2808
3014
  /** Additional fee content after the change. */
2809
3015
  changed?: AdditionalFee;
3016
+ /** Additional fee that was added. */
2810
3017
  added?: AdditionalFee;
2811
3018
  /**
2812
3019
  * Additional fee ID.
@@ -2820,12 +3027,21 @@ interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
2820
3027
  interface AdditionalFeeDeltaDeltaDetailsOneOf {
2821
3028
  /** Additional fee content after the change. */
2822
3029
  changed?: AdditionalFee;
3030
+ /** Additional fee that was added. */
2823
3031
  added?: AdditionalFee;
2824
3032
  }
2825
3033
  interface SubscriptionCommitSettings {
2826
- /** If false, do not send notifications to buyer. Default is true. */
3034
+ /**
3035
+ * Whether to send the buyer a notification about the committed changes.
3036
+ *
3037
+ * Default: `true`
3038
+ */
2827
3039
  sendNotificationsToBuyer?: boolean | null;
2828
- /** If false, do not send notifications to business. Default is true. */
3040
+ /**
3041
+ * Whether to send the business a notification about the committed changes.
3042
+ *
3043
+ * Default: `true`
3044
+ */
2829
3045
  sendNotificationsToBusiness?: boolean | null;
2830
3046
  }
2831
3047
  /** Triggered when a subscription contract's next charge is coming up. */
@@ -2856,13 +3072,13 @@ interface CreateSubscriptionContractResponse {
2856
3072
  }
2857
3073
  interface GetSubscriptionContractRequest {
2858
3074
  /**
2859
- * ID of the SubscriptionContract to retrieve.
3075
+ * ID of the subscription contract to retrieve.
2860
3076
  * @format GUID
2861
3077
  */
2862
3078
  subscriptionContractId: string;
2863
3079
  }
2864
3080
  interface GetSubscriptionContractResponse {
2865
- /** The requested SubscriptionContract. */
3081
+ /** Retrieved subscription contract. */
2866
3082
  subscriptionContract?: SubscriptionContract;
2867
3083
  }
2868
3084
  interface UpdateSubscriptionContractRequest {
@@ -2881,26 +3097,24 @@ interface UpdateSubscriptionContractResponse {
2881
3097
  subscriptionContract?: SubscriptionContract;
2882
3098
  }
2883
3099
  interface QuerySubscriptionContractsRequest {
2884
- /** WQL expression. */
3100
+ /** Filter, sort, and paging options for the query. */
2885
3101
  query?: CursorQuery;
2886
3102
  }
2887
3103
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
2888
3104
  /** 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`. */
2889
3105
  cursorPaging?: CursorPaging;
2890
3106
  /**
2891
- * Filter object in the following format:
2892
- * `"filter" : {
2893
- * "fieldName1": "value1",
2894
- * "fieldName2":{"$operator":"value2"}
2895
- * }`
2896
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2897
- * Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
3107
+ * 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.
3108
+ *
3109
+ * Supported properties:
3110
+ * `id`, `buyerInfo.contactId`
2898
3111
  */
2899
3112
  filter?: Record<string, any> | null;
2900
3113
  /**
2901
3114
  * Sort object in the following format:
2902
3115
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2903
- * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3116
+ *
3117
+ * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
2904
3118
  * @maxSize 5
2905
3119
  */
2906
3120
  sort?: Sorting[];
@@ -2912,11 +3126,18 @@ interface CursorQueryPagingMethodOneOf {
2912
3126
  }
2913
3127
  interface Sorting {
2914
3128
  /**
2915
- * Name of the field to sort by.
3129
+ * Field to sort by.
3130
+ *
3131
+ * Supported properties:
3132
+ * `id`, `buyerInfo.contactId`
2916
3133
  * @maxLength 512
2917
3134
  */
2918
3135
  fieldName?: string;
2919
- /** Sort order. */
3136
+ /**
3137
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
3138
+ *
3139
+ * Default: `ASC`
3140
+ */
2920
3141
  order?: SortOrderWithLiterals;
2921
3142
  }
2922
3143
  declare enum SortOrder {
@@ -2941,9 +3162,9 @@ interface CursorPaging {
2941
3162
  cursor?: string | null;
2942
3163
  }
2943
3164
  interface QuerySubscriptionContractsResponse {
2944
- /** List of SubscriptionContracts. */
3165
+ /** Retrieved subscription contracts. */
2945
3166
  subscriptionContracts?: SubscriptionContract[];
2946
- /** Paging metadata */
3167
+ /** Paging metadata. */
2947
3168
  pagingMetadata?: CursorPagingMetadata;
2948
3169
  }
2949
3170
  interface CursorPagingMetadata {
@@ -3293,6 +3514,12 @@ interface AccountInfo {
3293
3514
  */
3294
3515
  siteId?: string | null;
3295
3516
  }
3517
+ /** @docsIgnore */
3518
+ type GetSubscriptionContractApplicationErrors = {
3519
+ code?: 'NOT_FOUND';
3520
+ description?: string;
3521
+ data?: Record<string, any>;
3522
+ };
3296
3523
 
3297
3524
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
3298
3525
  getUrl: (context: any) => string;
@@ -3309,4 +3536,4 @@ declare function getSubscriptionContract(): __PublicMethodMetaInfo<'GET', {
3309
3536
  }, GetSubscriptionContractRequest$1, GetSubscriptionContractRequest, GetSubscriptionContractResponse$1, GetSubscriptionContractResponse>;
3310
3537
  declare function querySubscriptionContracts(): __PublicMethodMetaInfo<'GET', {}, QuerySubscriptionContractsRequest$1, QuerySubscriptionContractsRequest, QuerySubscriptionContractsResponse$1, QuerySubscriptionContractsResponse>;
3311
3538
 
3312
- 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 };
3539
+ 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 };