@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 * as _wix_sdk_types from '@wix/sdk-types';
2
2
  import { QuerySpec, Query, NonNullablePaths } from '@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
  /**
@@ -1326,6 +1354,76 @@ interface ServiceProperties {
1326
1354
  */
1327
1355
  endDate?: Date | null;
1328
1356
  }
1357
+ /**
1358
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1359
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1360
+ *
1361
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1362
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1363
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1364
+ */
1365
+ interface CrossBorderPriceAdjustment {
1366
+ /**
1367
+ * ID of the tax region whose tax is built into the catalog prices.
1368
+ * @format GUID
1369
+ */
1370
+ baseTaxRegionId?: string;
1371
+ /**
1372
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1373
+ * @format GUID
1374
+ */
1375
+ destinationTaxRegionId?: string | null;
1376
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1377
+ catalogPrice?: Price;
1378
+ /** 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. */
1379
+ baseTaxAmount?: Price;
1380
+ /** Outcome of the repricing for this line. */
1381
+ status?: RepriceStatusWithLiterals;
1382
+ /** 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`. */
1383
+ baseRateSource?: BaseRateSourceWithLiterals;
1384
+ /**
1385
+ * 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.
1386
+ * @format DECIMAL_VALUE
1387
+ * @decimalValue options { gte:0, maxScale:6 }
1388
+ */
1389
+ baseRate?: string | null;
1390
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1391
+ baseRateCapturedDate?: Date | null;
1392
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1393
+ destinationTaxIncluded?: boolean | null;
1394
+ }
1395
+ /** Outcome of the repricing for one line. */
1396
+ declare enum RepriceStatus {
1397
+ /** Base tax removed and the destination's tax applied. */
1398
+ APPLIED = "APPLIED",
1399
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1400
+ KEPT = "KEPT",
1401
+ /** 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`. */
1402
+ STRIP_ONLY = "STRIP_ONLY",
1403
+ /** The destination is the base region. Nothing was removed. */
1404
+ SAME_REGION = "SAME_REGION",
1405
+ /** 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. */
1406
+ SAME_COUNTRY = "SAME_COUNTRY",
1407
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1408
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1409
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1410
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1411
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1412
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1413
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1414
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1415
+ }
1416
+ /** @enumType */
1417
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1418
+ /** Where the base region's rate came from. */
1419
+ declare enum BaseRateSource {
1420
+ /** The manual tax calculator computed the base tax for this calculation. */
1421
+ MANUAL_SPI = "MANUAL_SPI",
1422
+ /** The rate captured from Avalara by the embedded-rate probe. */
1423
+ AVALARA_PROBE = "AVALARA_PROBE"
1424
+ }
1425
+ /** @enumType */
1426
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1329
1427
  /** Buyer information. */
1330
1428
  interface BuyerInfo extends BuyerInfoIdOneOf {
1331
1429
  /**
@@ -1744,6 +1842,12 @@ interface ShippingPrice {
1744
1842
  * @readonly
1745
1843
  */
1746
1844
  discount?: Price;
1845
+ /**
1846
+ * Cross-border repricing record of the shipping cost on a site whose catalog prices include tax.
1847
+ * @internal
1848
+ * @readonly
1849
+ */
1850
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
1747
1851
  }
1748
1852
  interface ShippingRegion {
1749
1853
  /**
@@ -1780,6 +1884,12 @@ interface OrderTaxInfo {
1780
1884
  * @readonly
1781
1885
  */
1782
1886
  totalExempt?: Price;
1887
+ /**
1888
+ * 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.
1889
+ * @internal
1890
+ * @readonly
1891
+ */
1892
+ crossBorderCalculation?: CrossBorderCalculation;
1783
1893
  }
1784
1894
  /**
1785
1895
  * 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.
@@ -1822,6 +1932,56 @@ interface OrderTaxBreakdown {
1822
1932
  */
1823
1933
  aggregatedExemptAmount?: Price;
1824
1934
  }
1935
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1936
+ interface CrossBorderCalculation {
1937
+ /** Whether the calculation repriced the lines for the destination's tax. */
1938
+ applied?: boolean;
1939
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
1940
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
1941
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
1942
+ mode?: CrossBorderRepricingModeWithLiterals;
1943
+ /**
1944
+ * Request ID of the calculation, for log correlation.
1945
+ * @maxLength 100
1946
+ */
1947
+ requestId?: string | null;
1948
+ }
1949
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
1950
+ declare enum CrossBorderNotApplicableReason {
1951
+ /** The repricing feature toggle is off. */
1952
+ FEATURE_DISABLED = "FEATURE_DISABLED",
1953
+ /** The site hasn't opted in to cross-border repricing. */
1954
+ NOT_OPTED_IN = "NOT_OPTED_IN",
1955
+ /** The site's prices no longer include tax. */
1956
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
1957
+ /** The base tax region doesn't exist on the site. */
1958
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
1959
+ /** The base region uses the manual calculator and has no tax mapping. */
1960
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
1961
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
1962
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
1963
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
1964
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
1965
+ /** The line items were repriced. Repricing the shipping option failed. */
1966
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
1967
+ /** The line items were repriced. Repricing the additional fees failed. */
1968
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
1969
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
1970
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
1971
+ }
1972
+ /** @enumType */
1973
+ 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';
1974
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
1975
+ declare enum CrossBorderRepricingMode {
1976
+ /** Nothing is repriced. */
1977
+ DISABLED = "DISABLED",
1978
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
1979
+ STRIP_ONLY = "STRIP_ONLY",
1980
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
1981
+ FULL = "FULL"
1982
+ }
1983
+ /** @enumType */
1984
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1825
1985
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1826
1986
  /** Coupon applied by the customer. */
1827
1987
  coupon?: Coupon;
@@ -2113,15 +2273,13 @@ interface CustomField {
2113
2273
  }
2114
2274
  interface V1SubscriptionTitle {
2115
2275
  /**
2116
- * 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).
2276
+ * Subscription title in the site's default language.
2117
2277
  * @minLength 1
2118
2278
  * @maxLength 150
2119
2279
  */
2120
2280
  original?: string;
2121
2281
  /**
2122
- * Subscription option name translated into the buyer's language.
2123
- *
2124
- * Default: Same as `original`.
2282
+ * Subscription title translated into the buyer's language.
2125
2283
  * @minLength 1
2126
2284
  * @maxLength 150
2127
2285
  */
@@ -2184,6 +2342,12 @@ interface AdditionalFee {
2184
2342
  source?: AdditionalFeeSourceWithLiterals;
2185
2343
  /** Address type tax was calculated against for this fee. */
2186
2344
  taxableAddress?: TaxableAddress;
2345
+ /**
2346
+ * Cross-border repricing record of the fee on a site whose catalog prices include tax.
2347
+ * @internal
2348
+ * @readonly
2349
+ */
2350
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
2187
2351
  }
2188
2352
  declare enum AdditionalFeeSource {
2189
2353
  /** The additional fee was added by an additional fee service plugin. */
@@ -2232,7 +2396,7 @@ declare enum SpecificItemsCouponBehavior {
2232
2396
  /** @enumType */
2233
2397
  type SpecificItemsCouponBehaviorWithLiterals = SpecificItemsCouponBehavior | 'UNDEFINED_COUPON_BEHAVIOR' | 'ITEM_SUBTOTAL_INCLUDES_DISCOUNT' | 'LEGACY_ITEM_SUBTOTAL_DOES_NOT_INCLUDE_DISCOUNT';
2234
2398
  interface SubscriptionContractActivity extends SubscriptionContractActivityTargetOneOf, SubscriptionContractActivityContentOneOf {
2235
- /** Scopes the draft to the contract level, applying to all future cycles. */
2399
+ /** The activity applies to all future billing cycles of the subscription contract. */
2236
2400
  contractTarget?: ContractTarget;
2237
2401
  /** Changes committed from a DraftSubscriptionContract. */
2238
2402
  changesApplied?: ChangesAppliedActivity;
@@ -2243,12 +2407,12 @@ interface SubscriptionContractActivity extends SubscriptionContractActivityTarge
2243
2407
  */
2244
2408
  _id?: string;
2245
2409
  /**
2246
- * When the activity occurred.
2410
+ * Date and time the activity occurred.
2247
2411
  * @readonly
2248
2412
  */
2249
2413
  _createdDate?: Date | null;
2250
2414
  /**
2251
- * Identity of the draft order's initiator.
2415
+ * Wix user or app that made the change.
2252
2416
  * @readonly
2253
2417
  */
2254
2418
  author?: ActivityAuthor;
@@ -2257,7 +2421,7 @@ interface SubscriptionContractActivity extends SubscriptionContractActivityTarge
2257
2421
  }
2258
2422
  /** @oneof */
2259
2423
  interface SubscriptionContractActivityTargetOneOf {
2260
- /** Scopes the draft to the contract level, applying to all future cycles. */
2424
+ /** The activity applies to all future billing cycles of the subscription contract. */
2261
2425
  contractTarget?: ContractTarget;
2262
2426
  }
2263
2427
  /** @oneof */
@@ -2265,19 +2429,19 @@ interface SubscriptionContractActivityContentOneOf {
2265
2429
  /** Changes committed from a DraftSubscriptionContract. */
2266
2430
  changesApplied?: ChangesAppliedActivity;
2267
2431
  }
2268
- /** Scopes the draft to the contract level, applying to all future cycles. */
2432
+ /** Target that applies changes to all future billing cycles of the subscription contract. */
2269
2433
  interface ContractTarget {
2270
- /** Cycle number of the next billing cycle (1-based). Set by the caller; returned by the server on read. */
2434
+ /** Number of the first billing cycle the changes apply to. Billing cycles are numbered from `1`. */
2271
2435
  nextCycleNumber?: number | null;
2272
2436
  }
2273
2437
  interface ActivityAuthor extends ActivityAuthorValueOneOf {
2274
2438
  /**
2275
- * User ID. When the draft order was created by a Wix user.
2439
+ * Wix user ID. Returned when a Wix user made the change.
2276
2440
  * @format GUID
2277
2441
  */
2278
2442
  userId?: string;
2279
2443
  /**
2280
- * App ID. When the draft order was created by an app.
2444
+ * App ID. Returned when an app made the change.
2281
2445
  * @format GUID
2282
2446
  */
2283
2447
  appId?: string;
@@ -2285,74 +2449,76 @@ interface ActivityAuthor extends ActivityAuthorValueOneOf {
2285
2449
  /** @oneof */
2286
2450
  interface ActivityAuthorValueOneOf {
2287
2451
  /**
2288
- * User ID. When the draft order was created by a Wix user.
2452
+ * Wix user ID. Returned when a Wix user made the change.
2289
2453
  * @format GUID
2290
2454
  */
2291
2455
  userId?: string;
2292
2456
  /**
2293
- * App ID. When the draft order was created by an app.
2457
+ * App ID. Returned when an app made the change.
2294
2458
  * @format GUID
2295
2459
  */
2296
2460
  appId?: string;
2297
2461
  }
2298
2462
  interface ChangesAppliedActivity extends ChangesAppliedActivityTargetOneOf {
2299
- /** Scopes the draft to the contract level, applying to all future cycles. */
2463
+ /** The changes apply to all future billing cycles of the subscription contract. */
2300
2464
  contractTarget?: ContractTarget;
2301
2465
  /**
2302
- * ID of the DraftSubscriptionContract that was committed.
2466
+ * ID of the draft subscription contract whose changes were committed.
2303
2467
  * @format GUID
2304
2468
  */
2305
2469
  draftSubscriptionContractId?: string;
2306
2470
  /**
2307
- * Individual typed changes applied.
2471
+ * Changes that were applied to the subscription contract.
2308
2472
  * @maxSize 100
2309
2473
  */
2310
2474
  changes?: ContractChange[];
2311
2475
  /**
2312
- * Reason for the edit, provided by the merchant (optional).
2476
+ * Reason for the change, provided by the business.
2313
2477
  * @maxLength 200
2314
2478
  */
2315
2479
  reason?: string | null;
2316
2480
  }
2317
2481
  /** @oneof */
2318
2482
  interface ChangesAppliedActivityTargetOneOf {
2319
- /** Scopes the draft to the contract level, applying to all future cycles. */
2483
+ /** The changes apply to all future billing cycles of the subscription contract. */
2320
2484
  contractTarget?: ContractTarget;
2321
2485
  }
2322
- interface ContractChange extends ContractChangeValueOneOf {
2486
+ interface ContractChange extends ContractChangeChangeDetailsOneOf {
2323
2487
  /** Line item was modified. */
2324
2488
  lineItemChanged?: LineItemChanges;
2325
2489
  /** Line item was added to the contract. */
2326
- lineItemAdded?: ManagedLineItem;
2490
+ lineItemAdded?: LineItemSummary;
2327
2491
  /** Line item was removed from the contract. */
2328
- lineItemRemoved?: ManagedLineItem;
2492
+ lineItemRemoved?: LineItemSummary;
2329
2493
  /** Discount was added to the contract. */
2330
- discountAdded?: ManagedDiscount;
2494
+ discountAdded?: DiscountSummary;
2331
2495
  /** Discount was removed from the contract. */
2332
- discountRemoved?: ManagedDiscount;
2496
+ discountRemoved?: DiscountSummary;
2333
2497
  /** Additional fee was added to the contract. */
2334
- additionalFeeAdded?: ManagedAdditionalFee;
2498
+ additionalFeeAdded?: AdditionalFeeSummary;
2335
2499
  /** Additional fee was removed from the contract. */
2336
- additionalFeeRemoved?: ManagedAdditionalFee;
2500
+ additionalFeeRemoved?: AdditionalFeeSummary;
2337
2501
  /** Total price changed. */
2338
2502
  totalPriceChanged?: TotalPriceChange;
2503
+ /** Type of change. */
2504
+ changeType?: ContractChangeTypeWithLiterals;
2339
2505
  }
2340
2506
  /** @oneof */
2341
- interface ContractChangeValueOneOf {
2507
+ interface ContractChangeChangeDetailsOneOf {
2342
2508
  /** Line item was modified. */
2343
2509
  lineItemChanged?: LineItemChanges;
2344
2510
  /** Line item was added to the contract. */
2345
- lineItemAdded?: ManagedLineItem;
2511
+ lineItemAdded?: LineItemSummary;
2346
2512
  /** Line item was removed from the contract. */
2347
- lineItemRemoved?: ManagedLineItem;
2513
+ lineItemRemoved?: LineItemSummary;
2348
2514
  /** Discount was added to the contract. */
2349
- discountAdded?: ManagedDiscount;
2515
+ discountAdded?: DiscountSummary;
2350
2516
  /** Discount was removed from the contract. */
2351
- discountRemoved?: ManagedDiscount;
2517
+ discountRemoved?: DiscountSummary;
2352
2518
  /** Additional fee was added to the contract. */
2353
- additionalFeeAdded?: ManagedAdditionalFee;
2519
+ additionalFeeAdded?: AdditionalFeeSummary;
2354
2520
  /** Additional fee was removed from the contract. */
2355
- additionalFeeRemoved?: ManagedAdditionalFee;
2521
+ additionalFeeRemoved?: AdditionalFeeSummary;
2356
2522
  /** Total price changed. */
2357
2523
  totalPriceChanged?: TotalPriceChange;
2358
2524
  }
@@ -2368,11 +2534,15 @@ interface LineItemChanges {
2368
2534
  quantity?: LineItemQuantityChange;
2369
2535
  }
2370
2536
  declare enum LineItemQuantityChangeType {
2537
+ /** Unknown quantity change type. */
2538
+ UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE = "UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE",
2539
+ /** Quantity increased. */
2371
2540
  QUANTITY_INCREASED = "QUANTITY_INCREASED",
2541
+ /** Quantity decreased. */
2372
2542
  QUANTITY_DECREASED = "QUANTITY_DECREASED"
2373
2543
  }
2374
2544
  /** @enumType */
2375
- type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
2545
+ type LineItemQuantityChangeTypeWithLiterals = LineItemQuantityChangeType | 'UNKNOWN_LINE_ITEM_QUANTITY_CHANGE_TYPE' | 'QUANTITY_INCREASED' | 'QUANTITY_DECREASED';
2376
2546
  interface LineItemQuantityChange {
2377
2547
  /**
2378
2548
  * Original item quantity before the change.
@@ -2389,11 +2559,11 @@ interface LineItemQuantityChange {
2389
2559
  * @min 1
2390
2560
  * @max 1000000
2391
2561
  */
2392
- diff?: number;
2562
+ quantityDifference?: number;
2393
2563
  /** Direction of the quantity change. */
2394
2564
  deltaType?: LineItemQuantityChangeTypeWithLiterals;
2395
2565
  }
2396
- interface ManagedLineItem {
2566
+ interface LineItemSummary {
2397
2567
  /**
2398
2568
  * Line item ID.
2399
2569
  * @format GUID
@@ -2408,7 +2578,7 @@ interface ManagedLineItem {
2408
2578
  */
2409
2579
  quantity?: number;
2410
2580
  }
2411
- interface ManagedDiscount {
2581
+ interface DiscountSummary {
2412
2582
  /**
2413
2583
  * Discount ID.
2414
2584
  * @format GUID
@@ -2431,7 +2601,7 @@ interface TranslatedValue {
2431
2601
  */
2432
2602
  translated?: string | null;
2433
2603
  }
2434
- interface ManagedAdditionalFee {
2604
+ interface AdditionalFeeSummary {
2435
2605
  /**
2436
2606
  * Additional fee ID.
2437
2607
  * @format GUID
@@ -2448,8 +2618,32 @@ interface TotalPriceChange {
2448
2618
  /** Total price after the commit. */
2449
2619
  newTotal?: Price;
2450
2620
  }
2621
+ declare enum ContractChangeType {
2622
+ /** Unknown change type. */
2623
+ UNKNOWN_CONTRACT_CHANGE_TYPE = "UNKNOWN_CONTRACT_CHANGE_TYPE",
2624
+ /** Line item was modified. */
2625
+ LINE_ITEM_CHANGED = "LINE_ITEM_CHANGED",
2626
+ /** Line item was added to the contract. */
2627
+ LINE_ITEM_ADDED = "LINE_ITEM_ADDED",
2628
+ /** Line item was removed from the contract. */
2629
+ LINE_ITEM_REMOVED = "LINE_ITEM_REMOVED",
2630
+ /** Discount was added to the contract. */
2631
+ DISCOUNT_ADDED = "DISCOUNT_ADDED",
2632
+ /** Discount was removed from the contract. */
2633
+ DISCOUNT_REMOVED = "DISCOUNT_REMOVED",
2634
+ /** Additional fee was added to the contract. */
2635
+ ADDITIONAL_FEE_ADDED = "ADDITIONAL_FEE_ADDED",
2636
+ /** Additional fee was removed from the contract. */
2637
+ ADDITIONAL_FEE_REMOVED = "ADDITIONAL_FEE_REMOVED",
2638
+ /** Total price changed. */
2639
+ TOTAL_PRICE_CHANGED = "TOTAL_PRICE_CHANGED"
2640
+ }
2641
+ /** @enumType */
2642
+ 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';
2451
2643
  declare enum ActivityType {
2644
+ /** Unknown activity type. */
2452
2645
  UNKNOWN_ACTIVITY_TYPE = "UNKNOWN_ACTIVITY_TYPE",
2646
+ /** Changes from a draft subscription contract were committed. */
2453
2647
  CHANGES_APPLIED = "CHANGES_APPLIED"
2454
2648
  }
2455
2649
  /** @enumType */
@@ -2480,30 +2674,26 @@ interface SubscriptionContractExpired {
2480
2674
  /** The subscription contract that expired. */
2481
2675
  subscriptionContract?: SubscriptionContract;
2482
2676
  }
2483
- /**
2484
- * ACTION event payload emitted after a successful commit.
2485
- * Carries the full delta — downstream consumers (email notifications, activity feed)
2486
- * subscribe to this event and have all details inline without fetching the draft.
2487
- */
2677
+ /** Triggered when changes from a draft subscription contract are committed to a subscription contract. */
2488
2678
  interface SubscriptionContractChangesCommitted {
2489
- /** Updated SubscriptionContract after commit. */
2679
+ /** Subscription contract after the changes were committed. */
2490
2680
  subscriptionContract?: SubscriptionContract;
2491
2681
  /**
2492
- * ID of the DraftSubscriptionContract that triggered this commit.
2682
+ * ID of the draft subscription contract whose changes were committed.
2493
2683
  * @format GUID
2494
2684
  */
2495
2685
  draftSubscriptionContractId?: string;
2496
- /** The actual delta applied. */
2686
+ /** Changes that were applied to the subscription contract. */
2497
2687
  changes?: SubscriptionContractDiffs;
2498
2688
  /**
2499
2689
  * Date and time the changes were committed.
2500
2690
  * @readonly
2501
2691
  */
2502
2692
  commitDate?: Date | null;
2503
- /** Side-effects requested by the caller when the changes were committed. */
2693
+ /** Notification settings specified when the changes were committed. */
2504
2694
  commitSettings?: SubscriptionCommitSettings;
2505
2695
  /**
2506
- * Reason for the edit, provided by the merchant.
2696
+ * Reason for the change, provided by the business.
2507
2697
  * @maxLength 200
2508
2698
  */
2509
2699
  reason?: string | null;
@@ -2512,209 +2702,224 @@ interface SubscriptionContractChangesCommitted {
2512
2702
  }
2513
2703
  interface SubscriptionContractDiffs {
2514
2704
  /**
2515
- * Per-item deltas: added, changed, or removed line items.
2705
+ * Line items that were added, changed, or removed.
2706
+ *
2707
+ * A line item is `CHANGED` when a field listed in `ItemChangedDetails` changed. Line items with no change aren't included.
2516
2708
  * @maxSize 100
2517
2709
  */
2518
2710
  lineItems?: LineItemDelta[];
2519
2711
  /**
2520
- * Per-discount deltas.
2712
+ * Discounts that were added, changed, or removed.
2713
+ *
2714
+ * 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.
2521
2715
  * @maxSize 100
2522
2716
  */
2523
2717
  appliedDiscounts?: AppliedDiscountDelta[];
2524
2718
  /**
2525
- * Per-fee deltas.
2719
+ * Additional fees that were added, changed, or removed.
2720
+ *
2721
+ * An additional fee is `CHANGED` when its price or the line items it applies to changed. Fees with no change aren't included.
2526
2722
  * @maxSize 100
2527
2723
  */
2528
2724
  additionalFees?: AdditionalFeeDelta[];
2529
- /** Updated price summary (overwrites existing). */
2725
+ /** Price summary after the changes. Replaces the subscription contract's previous price summary. */
2530
2726
  priceSummary?: PriceSummary;
2531
- /** Updated tax info (overwrites existing). */
2727
+ /** Tax information after the changes. Replaces the subscription contract's previous tax information. */
2532
2728
  taxInfo?: OrderTaxInfo;
2729
+ /** Shipping information after the changes. Replaces the subscription contract's previous shipping information. */
2730
+ shippingInfo?: ShippingInformation;
2533
2731
  }
2534
2732
  interface LineItemDelta extends LineItemDeltaDeltaDetailsOneOf {
2733
+ /** Values the line item had before the change. */
2535
2734
  changed?: ItemChangedDetails;
2536
2735
  /**
2537
2736
  * Line item ID.
2538
2737
  * @format GUID
2539
2738
  */
2540
2739
  lineItemId?: string;
2541
- /** Full line item content (absent for removed items). */
2740
+ /** Line item content. For a removed line item, the line item that was removed. */
2542
2741
  lineItem?: OrderLineItem;
2543
2742
  /** Type of change applied to this line item. */
2544
2743
  changeType?: ChangeTypeWithLiterals;
2545
2744
  }
2546
2745
  /** @oneof */
2547
2746
  interface LineItemDeltaDeltaDetailsOneOf {
2747
+ /** Values the line item had before the change. */
2548
2748
  changed?: ItemChangedDetails;
2549
2749
  }
2550
- /** the catalog reference options before the change. */
2750
+ /** The catalog reference options before the change. */
2551
2751
  interface CatalogReferenceOptionsBeforeChange {
2552
- /** the catalog reference options. Absent when the line item had no options. */
2752
+ /** The catalog reference options. Absent when the line item had no options. */
2553
2753
  options?: Record<string, any> | null;
2554
2754
  }
2555
- /** the product name before the change. */
2755
+ /** The product name before the change. */
2556
2756
  interface ProductNameBeforeChange {
2557
- /** the product name. Absent when the line item had no product name. */
2757
+ /** The product name. Absent when the line item had no product name. */
2558
2758
  productName?: ProductName;
2559
2759
  }
2560
- /** the description lines before the change. */
2760
+ /** The description lines before the change. */
2561
2761
  interface DescriptionLinesBeforeChange {
2562
2762
  /**
2563
- * the description lines. Empty when the line item had no description lines.
2763
+ * The description lines. Empty when the line item had no description lines.
2564
2764
  * @maxSize 20
2565
2765
  */
2566
2766
  descriptionLines?: DescriptionLine[];
2567
2767
  }
2568
- /** the image before the change. */
2768
+ /** The image before the change. */
2569
2769
  interface ImageBeforeChange {
2570
- /** the image. Absent when the line item had no image. */
2770
+ /** The image. Absent when the line item had no image. */
2571
2771
  image?: string;
2572
2772
  }
2573
- /** the physical properties before the change. */
2773
+ /** The physical properties before the change. */
2574
2774
  interface PhysicalPropertiesBeforeChange {
2575
- /** the physical properties. Absent when the line item had no physical properties. */
2775
+ /** The physical properties. Absent when the line item had no physical properties. */
2576
2776
  physicalProperties?: PhysicalProperties;
2577
2777
  }
2578
- /** the item type before the change. */
2778
+ /** The item type before the change. */
2579
2779
  interface ItemTypeBeforeChange {
2580
- /** the item type. Absent when the line item had no item type. */
2780
+ /** The item type. Absent when the line item had no item type. */
2581
2781
  itemType?: ItemType;
2582
2782
  }
2583
- /** the fulfiller ID before the change. */
2783
+ /** The fulfiller ID before the change. */
2584
2784
  interface FulfillerIdBeforeChange {
2585
2785
  /**
2586
- * the fulfiller ID. Absent when the line item had no fulfiller.
2786
+ * The fulfiller ID. Absent when the line item had no fulfiller.
2587
2787
  * @format GUID
2588
2788
  */
2589
2789
  fulfillerId?: string | null;
2590
2790
  }
2591
- /** the digital file before the change. */
2791
+ /** The digital file before the change. */
2592
2792
  interface DigitalFileBeforeChange {
2593
- /** the digital file. Absent when the line item had no digital file. */
2793
+ /** The digital file. Absent when the line item had no digital file. */
2594
2794
  digitalFile?: DigitalFile;
2595
2795
  }
2596
- /** the price description before the change. */
2796
+ /** The price description before the change. */
2597
2797
  interface PriceDescriptionBeforeChange {
2598
- /** the price description. Absent when the line item had no price description. */
2798
+ /** The price description. Absent when the line item had no price description. */
2599
2799
  priceDescription?: PriceDescription;
2600
2800
  }
2601
- /** the delivery profile ID before the change. */
2801
+ /** The delivery profile ID before the change. */
2602
2802
  interface DeliveryProfileIdBeforeChange {
2603
2803
  /**
2604
- * the delivery profile ID. Absent when the line item had no delivery profile.
2804
+ * The delivery profile ID. Absent when the line item had no delivery profile.
2605
2805
  * @format GUID
2606
2806
  */
2607
2807
  deliveryProfileId?: string | null;
2608
2808
  }
2609
- /** the shipping group ID before the change. */
2809
+ /** The shipping group ID before the change. */
2610
2810
  interface ShippingGroupIdBeforeChange {
2611
2811
  /**
2612
- * the shipping group ID. Absent when the line item had no shipping group.
2812
+ * The shipping group ID. Absent when the line item had no shipping group.
2613
2813
  * @format GUID
2614
2814
  */
2615
2815
  shippingGroupId?: string | null;
2616
2816
  }
2617
- /** the tax info before the change. */
2817
+ /** The tax info before the change. */
2618
2818
  interface TaxInfoBeforeChange {
2619
- /** the tax info. Absent when the line item had no tax info. */
2819
+ /** The tax info. Absent when the line item had no tax info. */
2620
2820
  taxInfo?: LineItemTaxInfo;
2621
2821
  }
2622
- /** the inventory app ID before the change. */
2822
+ /** The inventory app ID before the change. */
2623
2823
  interface InventoryAppIdBeforeChange {
2624
2824
  /**
2625
- * the inventory app ID. Absent when the line item had no inventory app.
2825
+ * The inventory app ID. Absent when the line item had no inventory app.
2626
2826
  * @format GUID
2627
2827
  */
2628
2828
  inventoryAppId?: string | null;
2629
2829
  }
2630
- /** the root catalog item ID before the change. */
2830
+ /** The root catalog item ID before the change. */
2631
2831
  interface RootCatalogItemIdBeforeChange {
2632
2832
  /**
2633
- * the root catalog item ID. Absent when the line item had no root catalog item.
2833
+ * The root catalog item ID. Absent when the line item had no root catalog item.
2634
2834
  * @minLength 1
2635
2835
  * @maxLength 36
2636
2836
  */
2637
2837
  rootCatalogItemId?: string | null;
2638
2838
  }
2639
- /** the modifier groups before the change. */
2839
+ /** The modifier groups before the change. */
2640
2840
  interface ModifierGroupsBeforeChange {
2641
2841
  /**
2642
- * the modifier groups. Empty when the line item had no modifier groups.
2842
+ * The modifier groups. Empty when the line item had no modifier groups.
2643
2843
  * @maxSize 10
2644
2844
  */
2645
2845
  modifierGroups?: ModifierGroup[];
2646
2846
  }
2647
- /** the price undetermined flag before the change. */
2847
+ /** The price undetermined flag before the change. */
2648
2848
  interface PriceUndeterminedBeforeChange {
2649
- /** whether the price of the line item was undetermined. */
2849
+ /** Whether the price of the line item was undetermined. */
2650
2850
  priceUndetermined?: boolean;
2651
2851
  }
2652
- /** Describes the type of change applied to an element. */
2852
+ /** Type of change to a line item, discount, or additional fee. */
2653
2853
  declare enum ChangeType {
2854
+ /** Unknown change type. */
2654
2855
  UNKNOWN_CHANGE_TYPE = "UNKNOWN_CHANGE_TYPE",
2655
- /** Element was added (absent in the original contract). */
2856
+ /** The line item, discount, or additional fee was added to the subscription contract. */
2656
2857
  ADDED = "ADDED",
2657
- /** Element was modified from the original contract. */
2858
+ /** The line item, discount, or additional fee was changed. */
2658
2859
  CHANGED = "CHANGED",
2659
- /** Element was removed from the contract. */
2860
+ /** The line item, discount, or additional fee was removed from the subscription contract. */
2660
2861
  REMOVED = "REMOVED"
2661
2862
  }
2662
2863
  /** @enumType */
2663
2864
  type ChangeTypeWithLiterals = ChangeType | 'UNKNOWN_CHANGE_TYPE' | 'ADDED' | 'CHANGED' | 'REMOVED';
2664
2865
  interface ItemChangedDetails {
2665
2866
  /**
2666
- * The quantity before the change.
2867
+ * The quantity before the change. Set only when the quantity changed.
2667
2868
  * @min 1
2668
2869
  * @max 1000000
2669
2870
  */
2670
2871
  quantityBeforeChange?: number | null;
2671
- /** The price before the change. */
2872
+ /** The price before the change. Set only when the price changed. */
2672
2873
  priceBeforeChange?: Price;
2673
- /** the catalog reference options before the change. Set only when the catalog reference options changed. */
2874
+ /** The catalog reference options before the change. Set only when the catalog reference options changed. */
2674
2875
  catalogReferenceOptionsBeforeChange?: CatalogReferenceOptionsBeforeChange;
2675
- /** the product name before the change. Set only when the product name changed. */
2876
+ /** The product name before the change. Set only when the product name changed. */
2676
2877
  productNameBeforeChange?: ProductNameBeforeChange;
2677
- /** the description lines before the change. Set only when the description lines changed. */
2878
+ /** The description lines before the change. Set only when the description lines changed. */
2678
2879
  descriptionLinesBeforeChange?: DescriptionLinesBeforeChange;
2679
- /** the image before the change. Set only when the image changed. */
2880
+ /** The image before the change. Set only when the image changed. */
2680
2881
  imageBeforeChange?: ImageBeforeChange;
2681
- /** the physical properties before the change. Set only when the physical properties changed. */
2882
+ /** The physical properties before the change. Set only when the physical properties changed. */
2682
2883
  physicalPropertiesBeforeChange?: PhysicalPropertiesBeforeChange;
2683
- /** the item type before the change. Set only when the item type changed. */
2884
+ /** The item type before the change. Set only when the item type changed. */
2684
2885
  itemTypeBeforeChange?: ItemTypeBeforeChange;
2685
- /** the fulfiller ID before the change. Set only when the fulfiller ID changed. */
2886
+ /** The fulfiller ID before the change. Set only when the fulfiller ID changed. */
2686
2887
  fulfillerIdBeforeChange?: FulfillerIdBeforeChange;
2687
- /** the digital file before the change. Set only when the digital file changed. */
2888
+ /** The digital file before the change. Set only when the digital file changed. */
2688
2889
  digitalFileBeforeChange?: DigitalFileBeforeChange;
2689
- /** the price description before the change. Set only when the price description changed. */
2890
+ /** The price description before the change. Set only when the price description changed. */
2690
2891
  priceDescriptionBeforeChange?: PriceDescriptionBeforeChange;
2691
2892
  /**
2692
- * the delivery profile ID before the change. Set only when the delivery profile ID changed.
2893
+ * The delivery profile ID before the change. Set only when the delivery profile ID changed.
2693
2894
  * @internal
2694
2895
  */
2695
2896
  deliveryProfileIdBeforeChange?: DeliveryProfileIdBeforeChange;
2696
2897
  /**
2697
- * the shipping group ID before the change. Set only when the shipping group ID changed.
2898
+ * The shipping group ID before the change. Set only when the shipping group ID changed.
2698
2899
  * @internal
2699
2900
  */
2700
2901
  shippingGroupIdBeforeChange?: ShippingGroupIdBeforeChange;
2701
- /** the tax info before the change. Set only when the tax group changed. */
2902
+ /** The tax info before the change. Set only when the line item's tax group changed because its catalog options changed. */
2702
2903
  taxInfoBeforeChange?: TaxInfoBeforeChange;
2703
- /** the inventory app ID before the change. Set only when the inventory app ID changed. */
2904
+ /**
2905
+ * The inventory app ID before the change. Set only when the inventory app ID changed.
2906
+ * @internal
2907
+ */
2704
2908
  inventoryAppIdBeforeChange?: InventoryAppIdBeforeChange;
2705
2909
  /**
2706
- * the root catalog item ID before the change. Set only when the root catalog item ID changed.
2910
+ * The root catalog item ID before the change. Set only when the root catalog item ID changed.
2707
2911
  * @internal
2708
2912
  */
2709
2913
  rootCatalogItemIdBeforeChange?: RootCatalogItemIdBeforeChange;
2710
- /** the modifier groups before the change. Set only when the modifier groups changed. */
2914
+ /** The modifier groups before the change. Set only when the modifier groups changed. */
2711
2915
  modifierGroupsBeforeChange?: ModifierGroupsBeforeChange;
2712
- /** the price undetermined flag before the change. Set only when the price undetermined flag changed. */
2916
+ /** The price undetermined flag before the change. Set only when the price undetermined flag changed. */
2713
2917
  priceUndeterminedBeforeChange?: PriceUndeterminedBeforeChange;
2714
2918
  }
2715
2919
  interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2716
2920
  /** Discount content after the change. */
2717
2921
  changed?: AppliedDiscount;
2922
+ /** Discount that was added. */
2718
2923
  added?: AppliedDiscount;
2719
2924
  /**
2720
2925
  * Discount ID.
@@ -2728,11 +2933,13 @@ interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaDetailsOneOf {
2728
2933
  interface AppliedDiscountDeltaDeltaDetailsOneOf {
2729
2934
  /** Discount content after the change. */
2730
2935
  changed?: AppliedDiscount;
2936
+ /** Discount that was added. */
2731
2937
  added?: AppliedDiscount;
2732
2938
  }
2733
2939
  interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
2734
2940
  /** Additional fee content after the change. */
2735
2941
  changed?: AdditionalFee;
2942
+ /** Additional fee that was added. */
2736
2943
  added?: AdditionalFee;
2737
2944
  /**
2738
2945
  * Additional fee ID.
@@ -2746,12 +2953,21 @@ interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaDetailsOneOf {
2746
2953
  interface AdditionalFeeDeltaDeltaDetailsOneOf {
2747
2954
  /** Additional fee content after the change. */
2748
2955
  changed?: AdditionalFee;
2956
+ /** Additional fee that was added. */
2749
2957
  added?: AdditionalFee;
2750
2958
  }
2751
2959
  interface SubscriptionCommitSettings {
2752
- /** If false, do not send notifications to buyer. Default is true. */
2960
+ /**
2961
+ * Whether to send the buyer a notification about the committed changes.
2962
+ *
2963
+ * Default: `true`
2964
+ */
2753
2965
  sendNotificationsToBuyer?: boolean | null;
2754
- /** If false, do not send notifications to business. Default is true. */
2966
+ /**
2967
+ * Whether to send the business a notification about the committed changes.
2968
+ *
2969
+ * Default: `true`
2970
+ */
2755
2971
  sendNotificationsToBusiness?: boolean | null;
2756
2972
  }
2757
2973
  /** Triggered when a subscription contract's next charge is coming up. */
@@ -2782,13 +2998,13 @@ interface CreateSubscriptionContractResponse {
2782
2998
  }
2783
2999
  interface GetSubscriptionContractRequest {
2784
3000
  /**
2785
- * ID of the SubscriptionContract to retrieve.
3001
+ * ID of the subscription contract to retrieve.
2786
3002
  * @format GUID
2787
3003
  */
2788
3004
  subscriptionContractId: string;
2789
3005
  }
2790
3006
  interface GetSubscriptionContractResponse {
2791
- /** The requested SubscriptionContract. */
3007
+ /** Retrieved subscription contract. */
2792
3008
  subscriptionContract?: SubscriptionContract;
2793
3009
  }
2794
3010
  interface UpdateSubscriptionContractRequest {
@@ -2807,26 +3023,24 @@ interface UpdateSubscriptionContractResponse {
2807
3023
  subscriptionContract?: SubscriptionContract;
2808
3024
  }
2809
3025
  interface QuerySubscriptionContractsRequest {
2810
- /** WQL expression. */
3026
+ /** Filter, sort, and paging options for the query. */
2811
3027
  query?: CursorQuery;
2812
3028
  }
2813
3029
  interface CursorQuery extends CursorQueryPagingMethodOneOf {
2814
3030
  /** 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`. */
2815
3031
  cursorPaging?: CursorPaging;
2816
3032
  /**
2817
- * Filter object in the following format:
2818
- * `"filter" : {
2819
- * "fieldName1": "value1",
2820
- * "fieldName2":{"$operator":"value2"}
2821
- * }`
2822
- * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
2823
- * Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
3033
+ * 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.
3034
+ *
3035
+ * Supported properties:
3036
+ * `id`, `buyerInfo.contactId`
2824
3037
  */
2825
3038
  filter?: Record<string, any> | null;
2826
3039
  /**
2827
3040
  * Sort object in the following format:
2828
3041
  * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2829
- * Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3042
+ *
3043
+ * Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
2830
3044
  * @maxSize 5
2831
3045
  */
2832
3046
  sort?: Sorting[];
@@ -2838,11 +3052,18 @@ interface CursorQueryPagingMethodOneOf {
2838
3052
  }
2839
3053
  interface Sorting {
2840
3054
  /**
2841
- * Name of the field to sort by.
3055
+ * Field to sort by.
3056
+ *
3057
+ * Supported properties:
3058
+ * `id`, `buyerInfo.contactId`
2842
3059
  * @maxLength 512
2843
3060
  */
2844
3061
  fieldName?: string;
2845
- /** Sort order. */
3062
+ /**
3063
+ * Sort order. Use `ASC` for ascending order or `DESC` for descending order.
3064
+ *
3065
+ * Default: `ASC`
3066
+ */
2846
3067
  order?: SortOrderWithLiterals;
2847
3068
  }
2848
3069
  declare enum SortOrder {
@@ -2867,9 +3088,9 @@ interface CursorPaging {
2867
3088
  cursor?: string | null;
2868
3089
  }
2869
3090
  interface QuerySubscriptionContractsResponse {
2870
- /** List of SubscriptionContracts. */
3091
+ /** Retrieved subscription contracts. */
2871
3092
  subscriptionContracts?: SubscriptionContract[];
2872
- /** Paging metadata */
3093
+ /** Paging metadata. */
2873
3094
  pagingMetadata?: CursorPagingMetadata;
2874
3095
  }
2875
3096
  interface CursorPagingMetadata {
@@ -3175,6 +3396,12 @@ interface AccountInfo {
3175
3396
  */
3176
3397
  siteId?: string | null;
3177
3398
  }
3399
+ /** @docsIgnore */
3400
+ type GetSubscriptionContractApplicationErrors = {
3401
+ code?: 'NOT_FOUND';
3402
+ description?: string;
3403
+ data?: Record<string, any>;
3404
+ };
3178
3405
  interface BaseEventMetadata {
3179
3406
  /**
3180
3407
  * App instance ID.
@@ -3230,11 +3457,35 @@ interface AccountInfoMetadata {
3230
3457
  /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
3231
3458
  parentAccountId?: string;
3232
3459
  }
3460
+ interface SubscriptionContractCommittedEnvelope {
3461
+ data: SubscriptionContractChangesCommitted;
3462
+ metadata: EventMetadata;
3463
+ }
3464
+ /**
3465
+ * Triggered when changes from a draft subscription contract are committed to a subscription contract.
3466
+ * The event holds the updated contract and every change that was applied.
3467
+ * @permissionScope Manage Stores - all permissions
3468
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3469
+ * @permissionScope Read eCommerce - all read permissions
3470
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
3471
+ * @permissionScope Manage Restaurants - all permissions
3472
+ * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
3473
+ * @permissionScope Manage eCommerce - all permissions
3474
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
3475
+ * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
3476
+ * @webhook
3477
+ * @eventType wix.ecom.subscription_contracts.v1.subscription_contract_committed
3478
+ * @slug committed
3479
+ * @documentationMaturity preview
3480
+ */
3481
+ declare function onSubscriptionContractCommitted(handler: (event: SubscriptionContractCommittedEnvelope) => void | Promise<void>): void;
3233
3482
  interface SubscriptionContractCreatedEnvelope {
3234
3483
  entity: SubscriptionContract;
3235
3484
  metadata: EventMetadata;
3236
3485
  }
3237
- /** @permissionScope Manage Stores - all permissions
3486
+ /**
3487
+ * Triggered when a subscription contract is created. A subscription contract is created when a buyer checks out with a subscription item.
3488
+ * @permissionScope Manage Stores - all permissions
3238
3489
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3239
3490
  * @permissionScope Read eCommerce - all read permissions
3240
3491
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
@@ -3252,7 +3503,9 @@ declare function onSubscriptionContractCreated(handler: (event: SubscriptionCont
3252
3503
  interface SubscriptionContractDeletedEnvelope {
3253
3504
  metadata: EventMetadata;
3254
3505
  }
3255
- /** @permissionScope Manage Stores - all permissions
3506
+ /**
3507
+ * Triggered when a subscription contract is deleted. A subscription contract is deleted when the buyer's personal data is erased. It isn't deleted when the subscription ends.
3508
+ * @permissionScope Manage Stores - all permissions
3256
3509
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3257
3510
  * @permissionScope Read eCommerce - all read permissions
3258
3511
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
@@ -3273,7 +3526,11 @@ interface SubscriptionContractUpdatedEnvelope {
3273
3526
  /** @hidden */
3274
3527
  modifiedFields: Record<string, any>;
3275
3528
  }
3276
- /** @permissionScope Manage Stores - all permissions
3529
+ /**
3530
+ * Triggered when a subscription contract is updated.
3531
+ * Fires when changes from a draft subscription contract are committed, and when the contract's `priceSummary` is set to the billed totals at the start of the first billing cycle.
3532
+ * Also fires right after a subscription contract is created, while billing for the subscription is set up. These updates can leave every documented field unchanged.
3533
+ * @permissionScope Manage Stores - all permissions
3277
3534
  * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
3278
3535
  * @permissionScope Read eCommerce - all read permissions
3279
3536
  * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
@@ -3289,26 +3546,36 @@ interface SubscriptionContractUpdatedEnvelope {
3289
3546
  */
3290
3547
  declare function onSubscriptionContractUpdated(handler: (event: SubscriptionContractUpdatedEnvelope) => void | Promise<void>): void;
3291
3548
  /**
3292
- * Retrieves a SubscriptionContract.
3293
- * @param subscriptionContractId - ID of the SubscriptionContract to retrieve.
3549
+ * Retrieves a subscription contract.
3550
+ *
3551
+ *
3552
+ * To retrieve the subscription contract an order was created from, specify the order's `lineItems.subscriptionInfo.id` as `subscriptionContractId`. You can retrieve the order with [Get Order](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/get-order).
3553
+ *
3554
+ * To retrieve the orders created from a subscription contract, call [Search Orders](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/orders/search-orders) with a filter on `lineItems.subscriptionInfo.id`.
3555
+ * @param subscriptionContractId - ID of the subscription contract to retrieve.
3294
3556
  * @public
3295
3557
  * @documentationMaturity preview
3296
3558
  * @requiredField subscriptionContractId
3297
3559
  * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
3298
3560
  * @applicableIdentity APP
3299
- * @returns The requested SubscriptionContract.
3561
+ * @returns Retrieved subscription contract.
3300
3562
  * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.GetSubscriptionContract
3301
3563
  */
3302
- declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source` | `activities` | `activities.${number}.changesApplied.draftSubscriptionContractId` | `activities.${number}._id` | `activities.${number}.author.userId` | `activities.${number}.author.appId` | `activities.${number}.activityType`, 4>>;
3564
+ declare function getSubscriptionContract(subscriptionContractId: string): Promise<NonNullablePaths<SubscriptionContract, `subscriptionDescription.original` | `subscriptionSettings.frequency` | `subscriptionSettings.autoRenewal` | `subscriptionSettings.enableCustomerCancellation` | `subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionSettings.freeTrialPeriod.interval` | `lineItems` | `lineItems.${number}._id` | `lineItems.${number}.productName.original` | `lineItems.${number}.catalogReference.catalogItemId` | `lineItems.${number}.catalogReference.appId` | `lineItems.${number}.quantity` | `lineItems.${number}.totalDiscount.amount` | `lineItems.${number}.totalDiscount.formattedAmount` | `lineItems.${number}.physicalProperties.shippable` | `lineItems.${number}.itemType.preset` | `lineItems.${number}.itemType.custom` | `lineItems.${number}.paymentOption` | `lineItems.${number}.taxDetails.taxRate` | `lineItems.${number}.taxInfo.taxIncludedInPrice` | `lineItems.${number}.digitalFile.fileId` | `lineItems.${number}.subscriptionInfo.cycleNumber` | `lineItems.${number}.subscriptionInfo.subscriptionOptionTitle` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.frequency` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.autoRenewal` | `lineItems.${number}.subscriptionInfo.subscriptionSettings.enableCustomerCancellation` | `lineItems.${number}.priceDescription.original` | `lineItems.${number}.taxableAddress.addressType` | `lineItems.${number}.priceUndetermined` | `lineItems.${number}.fixedQuantity` | `lineItems.${number}.decimalQuantity.measurementUnit` | `lineItems.${number}.decimalQuantity.otherUnit` | `lineItems.${number}.decimalQuantity.value` | `lineItems.${number}.decimalQuantity.description.original` | `buyerInfo.visitorId` | `buyerInfo.memberId` | `weightUnit` | `taxIncludedInPrices` | `platformFeeSummary.fees` | `platformFeeSummary.fees.${number}.lineItemId` | `platformFeeSummary.fees.${number}.chargeType` | `platformFeeSummary.fees.${number}.percentageRate` | `billingInfo.address.streetAddress.number` | `billingInfo.address.streetAddress.name` | `billingInfo.contactDetails.vatId._id` | `billingInfo.contactDetails.vatId.type` | `shippingInfo.title` | `shippingInfo.logistics.pickupDetails.pickupMethod` | `appliedDiscounts` | `appliedDiscounts.${number}.coupon._id` | `appliedDiscounts.${number}.coupon.code` | `appliedDiscounts.${number}.coupon.name` | `appliedDiscounts.${number}.merchantDiscount.discountReason` | `appliedDiscounts.${number}.discountRule._id` | `appliedDiscounts.${number}.discountRule.name.original` | `appliedDiscounts.${number}.discountType` | `channelInfo.type` | `customFields` | `customFields.${number}.title` | `subscriptionTitle.original` | `additionalFees` | `additionalFees.${number}.name` | `additionalFees.${number}._id` | `additionalFees.${number}.source`, 4> & {
3565
+ __applicationErrorsType?: GetSubscriptionContractApplicationErrors;
3566
+ }>;
3303
3567
  /**
3304
- * Retrieves a list of SubscriptionContracts, given the provided [paging, filtering, and sorting][1].
3568
+ * Retrieves a list of up to 100 subscription contracts, given the provided paging, filtering, and sorting.
3305
3569
  *
3306
- * Up to 300 SubscriptionContracts can be returned per request.
3307
3570
  *
3308
- * To learn how to query SubscriptionContracts, see [API Query Language][2].
3571
+ * Query Subscription Contracts runs with these defaults, which you can override:
3309
3572
  *
3310
- * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
3311
- * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
3573
+ * - `id` is sorted in `ASC` order
3574
+ * - `cursorPaging.limit` is `50`
3575
+ *
3576
+ * You can filter and sort by `id` and `buyerInfo.contactId`. For example, to retrieve all of a buyer's subscription contracts, filter by `buyerInfo.contactId`.
3577
+ *
3578
+ * To learn about working with Query methods, see [API Query Language](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-the-wix-api-query-language) and [Sorting and Paging](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
3312
3579
  * @public
3313
3580
  * @documentationMaturity preview
3314
3581
  * @permissionId ECOM.SUBSCRIPTION_CONTRACT_READ
@@ -3393,7 +3660,7 @@ interface SubscriptionContractsQueryBuilder {
3393
3660
  * @fqn wix.ecom.subscription_contracts.v1.SubscriptionContracts.QuerySubscriptionContracts
3394
3661
  * @requiredField query
3395
3662
  */
3396
- declare function typedQuerySubscriptionContracts(query: SubscriptionContractQuery): Promise<NonNullablePaths<QuerySubscriptionContractsResponse, `subscriptionContracts` | `subscriptionContracts.${number}.subscriptionSettings.frequency` | `subscriptionContracts.${number}.subscriptionSettings.autoRenewal` | `subscriptionContracts.${number}.subscriptionSettings.enableCustomerCancellation` | `subscriptionContracts.${number}.subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionContracts.${number}.subscriptionSettings.freeTrialPeriod.interval` | `subscriptionContracts.${number}.buyerInfo.visitorId` | `subscriptionContracts.${number}.buyerInfo.memberId` | `subscriptionContracts.${number}.weightUnit` | `subscriptionContracts.${number}.taxIncludedInPrices` | `subscriptionContracts.${number}.shippingInfo.title` | `subscriptionContracts.${number}.channelInfo.type`, 4>>;
3663
+ declare function typedQuerySubscriptionContracts(query: SubscriptionContractQuery): Promise<NonNullablePaths<QuerySubscriptionContractsResponse, `subscriptionContracts` | `subscriptionContracts.${number}.subscriptionDescription.original` | `subscriptionContracts.${number}.subscriptionSettings.frequency` | `subscriptionContracts.${number}.subscriptionSettings.autoRenewal` | `subscriptionContracts.${number}.subscriptionSettings.enableCustomerCancellation` | `subscriptionContracts.${number}.subscriptionSettings.freeTrialPeriod.frequency` | `subscriptionContracts.${number}.subscriptionSettings.freeTrialPeriod.interval` | `subscriptionContracts.${number}.buyerInfo.visitorId` | `subscriptionContracts.${number}.buyerInfo.memberId` | `subscriptionContracts.${number}.weightUnit` | `subscriptionContracts.${number}.taxIncludedInPrices` | `subscriptionContracts.${number}.shippingInfo.title` | `subscriptionContracts.${number}.channelInfo.type` | `subscriptionContracts.${number}.subscriptionTitle.original`, 4>>;
3397
3664
  interface SubscriptionContractQuerySpec extends QuerySpec {
3398
3665
  paging: 'cursor';
3399
3666
  wql: [
@@ -3425,29 +3692,32 @@ type SubscriptionContractQuery = {
3425
3692
  cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
3426
3693
  };
3427
3694
  /**
3428
- Filter object in the following format:
3429
- `"filter" : {
3430
- "fieldName1": "value1",
3431
- "fieldName2":{"$operator":"value2"}
3432
- }`
3433
- Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
3434
- Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
3695
+ 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.
3696
+
3697
+ Supported properties:
3698
+ `id`, `buyerInfo.contactId`
3435
3699
  */
3436
3700
  filter?: CommonQueryWithEntityContext['filter'] | null;
3437
3701
  /**
3438
3702
  Sort object in the following format:
3439
3703
  `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
3440
- Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
3704
+
3705
+ Learn more about [sorting](https://dev.wix.com/docs/api-reference/articles/work-with-wix-apis/data-retrieval/about-sorting-and-paging).
3441
3706
  @maxSize: 5
3442
3707
  */
3443
3708
  sort?: {
3444
3709
  /**
3445
- Name of the field to sort by.
3710
+ Field to sort by.
3711
+
3712
+ Supported properties:
3713
+ `id`, `buyerInfo.contactId`
3446
3714
  @maxLength: 512
3447
3715
  */
3448
3716
  fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
3449
3717
  /**
3450
- Sort order.
3718
+ Sort order. Use `ASC` for ascending order or `DESC` for descending order.
3719
+
3720
+ Default: `ASC`
3451
3721
  */
3452
3722
  order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
3453
3723
  }[];
@@ -3456,4 +3726,4 @@ declare const utils: {
3456
3726
  query: _wix_sdk_types.QueryHelpers<SubscriptionContract, SubscriptionContractQuerySpec, SubscriptionContractQuery>;
3457
3727
  };
3458
3728
 
3459
- export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, type ActivityAuthor, type ActivityAuthorValueOneOf, ActivityType, type ActivityTypeWithLiterals, type AdditionalFee, type AdditionalFeeDelta, type AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, type CatalogReferenceOptionsBeforeChange, ChangeType, type ChangeTypeWithLiterals, type ChangesAppliedActivity, type ChangesAppliedActivityTargetOneOf, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommitSubscriptionContractChangesRequest, type CommitSubscriptionContractChangesResponse, type CommonQueryWithEntityContext, type ContractChange, type ContractChangeValueOneOf, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type CyclePriceOverride, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryProfileIdBeforeChange, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DescriptionLinesBeforeChange, type DigitalFile, type DigitalFileBeforeChange, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FulfillerIdBeforeChange, type FullAddressContactDetails, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImageBeforeChange, type InventoryAppIdBeforeChange, type ItemChangedDetails, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeBeforeChange, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemCyclePriceOverrides, type LineItemDelta, type LineItemDeltaDeltaDetailsOneOf, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type ManagedAdditionalFee, type ManagedDiscount, type ManagedLineItem, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type ModifierGroupsBeforeChange, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PhysicalPropertiesBeforeChange, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceDescriptionBeforeChange, type PriceSummary, type PriceUndeterminedBeforeChange, type ProductName, type ProductNameBeforeChange, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, type RestockLocation, type RestoreInfo, type RootCatalogItemIdBeforeChange, type ServiceProperties, type ShippingGroupIdBeforeChange, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SpecificItemsCouponBehavior, type SpecificItemsCouponBehaviorWithLiterals, type StreetAddress, type SubscriptionCommitSettings, type SubscriptionContract, type SubscriptionContractActivity, type SubscriptionContractActivityContentOneOf, type SubscriptionContractActivityTargetOneOf, type SubscriptionContractCanceled, type SubscriptionContractChangesCommitted, type SubscriptionContractChargeUpcoming, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractDiffs, type SubscriptionContractExpired, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractSettings, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, type SubscriptionSettingsProductPeriodAlignmentWithLiterals, type SubscriptionTitle, type TaxInfoBeforeChange, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1CyclePriceOverride, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };
3729
+ export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, ActionInitiator, type ActionInitiatorWithLiterals, type ActivityAuthor, type ActivityAuthorValueOneOf, ActivityType, type ActivityTypeWithLiterals, type AdditionalFee, type AdditionalFeeDelta, type AdditionalFeeDeltaDeltaDetailsOneOf, AdditionalFeeSource, type AdditionalFeeSourceWithLiterals, type AdditionalFeeSummary, type Address, type AddressLocation, type AddressWithContact, AdjustmentType, type AdjustmentTypeWithLiterals, type ApplicationError, type AppliedDiscount, type AppliedDiscountDelta, type AppliedDiscountDeltaDeltaDetailsOneOf, type AppliedDiscountDiscountSourceOneOf, type BaseEventMetadata, BaseRateSource, type BaseRateSourceWithLiterals, type BillingAdjustment, type BillingAdjustmentPriceSummary, type BillingSettings, type BulkActionMetadata, type BulkCreateSubscriptionContractsRequest, type BulkCreateSubscriptionContractsResponse, type BulkSubscriptionContractResult, type BulkUpdateSubscriptionContractsRequest, type BulkUpdateSubscriptionContractsResponse, type BuyerInfo, type BuyerInfoIdOneOf, type CatalogReference, type CatalogReferenceOptionsBeforeChange, ChangeType, type ChangeTypeWithLiterals, type ChangesAppliedActivity, type ChangesAppliedActivityTargetOneOf, type ChannelInfo, ChannelType, type ChannelTypeWithLiterals, ChargeType, type ChargeTypeWithLiterals, type Color, type CommitSubscriptionContractChangesRequest, type CommitSubscriptionContractChangesResponse, type CommonQueryWithEntityContext, type ContractChange, type ContractChangeChangeDetailsOneOf, ContractChangeType, type ContractChangeTypeWithLiterals, type ContractTarget, type Coupon, type CreateSubscriptionContractRequest, type CreateSubscriptionContractResponse, type CrossBorderCalculation, CrossBorderNotApplicableReason, type CrossBorderNotApplicableReasonWithLiterals, type CrossBorderPriceAdjustment, CrossBorderRepricingMode, type CrossBorderRepricingModeWithLiterals, type CurrencyConversionDetails, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type CustomField, type CyclePriceOverride, type DecimalQuantity, type DecimalQuantityUnitOneOf, type DeliveryLogistics, type DeliveryLogisticsAddressOneOf, type DeliveryProfileIdBeforeChange, type DeliveryTimeSlot, type DescriptionLine, type DescriptionLineDescriptionLineValueOneOf, type DescriptionLineName, DescriptionLineType, type DescriptionLineTypeWithLiterals, type DescriptionLineValueOneOf, type DescriptionLinesBeforeChange, type DigitalFile, type DigitalFileBeforeChange, type Dimensions, DimensionsUnit, type DimensionsUnitWithLiterals, DiscountReason, type DiscountReasonWithLiterals, type DiscountRule, type DiscountRuleName, type DiscountSummary, DiscountType, type DiscountTypeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type FocalPoint, type FreeTrialPeriod, type FulfillerIdBeforeChange, type FullAddressContactDetails, type GetSubscriptionContractApplicationErrors, type GetSubscriptionContractRequest, type GetSubscriptionContractResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImageBeforeChange, type InventoryAppIdBeforeChange, type ItemChangedDetails, type ItemCombination, type ItemCombinationLineItem, type ItemMetadata, type ItemModifier, type ItemTaxFullDetails, type ItemType, type ItemTypeBeforeChange, type ItemTypeItemTypeDataOneOf, ItemTypePreset, type ItemTypePresetWithLiterals, JurisdictionType, type JurisdictionTypeWithLiterals, type LineItemChanges, type LineItemCyclePriceOverrides, type LineItemDelta, type LineItemDeltaDeltaDetailsOneOf, type LineItemDiscount, type LineItemQuantityChange, LineItemQuantityChangeType, type LineItemQuantityChangeTypeWithLiterals, type LineItemSummary, type LineItemTaxBreakdown, type LineItemTaxInfo, type Location, type LocationAndQuantity, type MaskedSubscriptionContract, MeasurementUnit, type MeasurementUnitWithLiterals, type MerchantDiscount, type MerchantDiscountMerchantDiscountReasonOneOf, type MessageEnvelope, type ModifierGroup, type ModifierGroupsBeforeChange, type OrderLineItem, type OrderTaxBreakdown, type OrderTaxInfo, PaymentOptionType, type PaymentOptionTypeWithLiterals, type PhysicalProperties, type PhysicalPropertiesBeforeChange, type PickupAddress, type PickupDetails, PickupMethod, type PickupMethodWithLiterals, type PlainTextValue, type PlatformFee, type PlatformFeeSummary, type Price, type PriceDescription, type PriceDescriptionBeforeChange, type PriceSummary, type PriceUndeterminedBeforeChange, type ProductName, type ProductNameBeforeChange, ProductPeriodAlignment, type ProductPeriodAlignmentWithLiterals, type QuerySubscriptionContractsRequest, type QuerySubscriptionContractsResponse, RepriceStatus, type RepriceStatusWithLiterals, type RestockLocation, type RestoreInfo, type RootCatalogItemIdBeforeChange, type ServiceProperties, type ShippingGroupIdBeforeChange, type ShippingInformation, type ShippingPrice, type ShippingRegion, SortOrder, type SortOrderWithLiterals, type Sorting, SpecificItemsCouponBehavior, type SpecificItemsCouponBehaviorWithLiterals, type StreetAddress, type SubscriptionCommitSettings, type SubscriptionContract, type SubscriptionContractActivity, type SubscriptionContractActivityContentOneOf, type SubscriptionContractActivityTargetOneOf, type SubscriptionContractCanceled, type SubscriptionContractChangesCommitted, type SubscriptionContractChargeUpcoming, type SubscriptionContractCommittedEnvelope, type SubscriptionContractCreatedEnvelope, type SubscriptionContractDeletedEnvelope, type SubscriptionContractDiffs, type SubscriptionContractExpired, type SubscriptionContractQuery, type SubscriptionContractQuerySpec, type SubscriptionContractSettings, type SubscriptionContractUpdatedEnvelope, type SubscriptionContractsQueryBuilder, type SubscriptionContractsQueryResult, type SubscriptionDescription, SubscriptionFrequency, type SubscriptionFrequencyWithLiterals, type SubscriptionInfo, type SubscriptionSettings, SubscriptionSettingsProductPeriodAlignment, type SubscriptionSettingsProductPeriodAlignmentWithLiterals, type SubscriptionTitle, type TaxInfoBeforeChange, type TaxableAddress, type TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, type TaxableAddressTypeWithLiterals, type TotalPriceChange, type TranslatableString, type TranslatedValue, type UpdateSubscriptionContractRequest, type UpdateSubscriptionContractResponse, type V1BillingSettings, type V1CyclePriceOverride, type V1FreeTrialPeriod, type V1SubscriptionDescription, type V1SubscriptionSettings, type V1SubscriptionTitle, V2SubscriptionFrequency, type V2SubscriptionFrequencyWithLiterals, type VatId, VatType, type VatTypeWithLiterals, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, WeightUnit, type WeightUnitWithLiterals, getSubscriptionContract, onSubscriptionContractCommitted, onSubscriptionContractCreated, onSubscriptionContractDeleted, onSubscriptionContractUpdated, querySubscriptionContracts, typedQuerySubscriptionContracts, utils };