@wix/auto_sdk_ecom_draft-orders 1.0.187 → 1.0.188
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.
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +17 -7
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +17 -7
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +17 -7
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +17 -7
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +17 -7
- package/build/internal/cjs/meta.d.ts +17 -7
- package/build/internal/es/index.typings.d.mts +17 -7
- package/build/internal/es/meta.d.mts +17 -7
- package/package.json +2 -2
|
@@ -747,10 +747,16 @@ interface DigitalFile {
|
|
|
747
747
|
interface SubscriptionInfo {
|
|
748
748
|
/**
|
|
749
749
|
* Subscription ID.
|
|
750
|
+
*
|
|
751
|
+
* For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
|
|
752
|
+
* To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
|
|
750
753
|
* @format GUID
|
|
751
754
|
*/
|
|
752
755
|
_id?: string | null;
|
|
753
|
-
/**
|
|
756
|
+
/**
|
|
757
|
+
* Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
|
|
758
|
+
* When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
|
|
759
|
+
*/
|
|
754
760
|
cycleNumber?: number;
|
|
755
761
|
/**
|
|
756
762
|
* Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
@@ -805,7 +811,7 @@ interface SubscriptionDescription {
|
|
|
805
811
|
translated?: string | null;
|
|
806
812
|
}
|
|
807
813
|
interface SubscriptionSettings {
|
|
808
|
-
/** Frequency of
|
|
814
|
+
/** Frequency unit of the billing cycle. */
|
|
809
815
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
810
816
|
/**
|
|
811
817
|
* Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
|
|
@@ -813,16 +819,20 @@ interface SubscriptionSettings {
|
|
|
813
819
|
* @max 3650
|
|
814
820
|
*/
|
|
815
821
|
interval?: number | null;
|
|
816
|
-
/** Whether subscription
|
|
822
|
+
/** Whether the subscription renews automatically at the end of each billing cycle. */
|
|
817
823
|
autoRenewal?: boolean;
|
|
818
824
|
/**
|
|
819
|
-
* Number of billing cycles before subscription ends. Ignored
|
|
825
|
+
* Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
|
|
820
826
|
* @min 1
|
|
821
827
|
*/
|
|
822
828
|
billingCycles?: number | null;
|
|
823
|
-
/** Whether
|
|
829
|
+
/** Whether the buyer can cancel the subscription. */
|
|
824
830
|
enableCustomerCancellation?: boolean;
|
|
825
|
-
/**
|
|
831
|
+
/**
|
|
832
|
+
* Free trial period before the first billing cycle starts.
|
|
833
|
+
*
|
|
834
|
+
* Returned only when the subscription has a free trial.
|
|
835
|
+
*/
|
|
826
836
|
freeTrialPeriod?: FreeTrialPeriod;
|
|
827
837
|
}
|
|
828
838
|
/** Frequency unit of recurring payment */
|
|
@@ -836,7 +846,7 @@ declare enum SubscriptionFrequency {
|
|
|
836
846
|
/** @enumType */
|
|
837
847
|
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
838
848
|
interface FreeTrialPeriod {
|
|
839
|
-
/** Frequency of
|
|
849
|
+
/** Frequency unit of the free trial period. */
|
|
840
850
|
frequency?: SubscriptionFrequencyWithLiterals;
|
|
841
851
|
/**
|
|
842
852
|
* Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
|