@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.
@@ -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
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
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 recurring payment. */
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 is renewed automatically at the end of each period. */
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 if `autoRenewal: true`.
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 to allow the customer to cancel the subscription. */
829
+ /** Whether the buyer can cancel the subscription. */
824
830
  enableCustomerCancellation?: boolean;
825
- /** Period until first cycle starts. If None => no free trial */
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 period. Values: DAY, WEEK, MONTH, YEAR */
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.