@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.
@@ -770,10 +770,16 @@ interface DigitalFile {
770
770
  interface SubscriptionInfo {
771
771
  /**
772
772
  * Subscription ID.
773
+ *
774
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
775
+ * 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).
773
776
  * @format GUID
774
777
  */
775
778
  id?: string | null;
776
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
779
+ /**
780
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
781
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
782
+ */
777
783
  cycleNumber?: number;
778
784
  /**
779
785
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -828,7 +834,7 @@ interface SubscriptionDescription {
828
834
  translated?: string | null;
829
835
  }
830
836
  interface SubscriptionSettings {
831
- /** Frequency of recurring payment. */
837
+ /** Frequency unit of the billing cycle. */
832
838
  frequency?: SubscriptionFrequencyWithLiterals;
833
839
  /**
834
840
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -836,16 +842,20 @@ interface SubscriptionSettings {
836
842
  * @max 3650
837
843
  */
838
844
  interval?: number | null;
839
- /** Whether subscription is renewed automatically at the end of each period. */
845
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
840
846
  autoRenewal?: boolean;
841
847
  /**
842
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
848
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
843
849
  * @min 1
844
850
  */
845
851
  billingCycles?: number | null;
846
- /** Whether to allow the customer to cancel the subscription. */
852
+ /** Whether the buyer can cancel the subscription. */
847
853
  enableCustomerCancellation?: boolean;
848
- /** Period until first cycle starts. If None => no free trial */
854
+ /**
855
+ * Free trial period before the first billing cycle starts.
856
+ *
857
+ * Returned only when the subscription has a free trial.
858
+ */
849
859
  freeTrialPeriod?: FreeTrialPeriod;
850
860
  }
851
861
  /** Frequency unit of recurring payment */
@@ -859,7 +869,7 @@ declare enum SubscriptionFrequency {
859
869
  /** @enumType */
860
870
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
861
871
  interface FreeTrialPeriod {
862
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
872
+ /** Frequency unit of the free trial period. */
863
873
  frequency?: SubscriptionFrequencyWithLiterals;
864
874
  /**
865
875
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.