@wix/subscription 1.0.3 → 1.0.5

package/type-bundles/meta.bundle.d.ts

@@ -87,6 +87,8 @@ interface Subscription$1 {
      * @readonly
      */
     changesCounter?: string | null;
+    /** Billing order id. Optional. */
+    orderId?: string | null;
     /** items, minSize is 1, maxSize is 100 */
     items?: Item$1[];
 }
@@ -154,7 +156,7 @@ interface BillingSettings$1 {
     /** customer payment source to make recurring payments with */
     paymentMethod?: PaymentMethod$1;
     /** Instructs how payments will be collected. */
-    collectionMethod?: CollectionMethod$1;
+    collectionMethod?: CollectionMethodEnumCollectionMethod$1;
     /**
      * Duration of cycle. For example, 1 MONTH, 2 WEEKS, 7 DAYS, 1 YEAR etc.
      * Shortest supported cycle duration is 7 days.
@@ -168,7 +170,12 @@ interface BillingSettings$1 {
     customBillingSchedule?: CustomBillingSchedule$1;
     /** Definition of trial period */
     freeTrialDuration?: Duration$1;
-    /** Shipping costs collected each cycle */
+    /**
+     * Shipping costs collected each cycle
+     * @deprecated
+     * @replacedBy shipping_charges
+     * @targetRemovalDate 2024-10-31
+     */
     shippingFee?: string | null;
     /** Billing address associated with subscription to be used for payments. */
     billingAddress?: FullAddressDetails$1;
@@ -181,6 +188,8 @@ interface BillingSettings$1 {
      * Max: 5 additional fees
      */
     additionalFees?: AdditionalFee$1[];
+    /** Shipping fee charges */
+    shippingCharges?: ShippingCharges$1;
     /** General discount that applied to all items in the subscription */
     discounts?: Discount$1[];
     /**
@@ -193,7 +202,7 @@ interface PaymentMethod$1 {
     /** reference to payment source id stored in payments system */
     id?: string;
 }
-declare enum CollectionMethod$1 {
+declare enum CollectionMethodEnumCollectionMethod$1 {
     UNKNOWN = "UNKNOWN",
     /** Subscriber automatically charged */
     AUTO_CHARGE = "AUTO_CHARGE",
@@ -352,6 +361,17 @@ interface TaxValueOneOf$1 {
 interface DynamicTax$1 {
     taxGroupId?: string | null;
 }
+interface ShippingCharges$1 {
+    /**
+     * Amount of the shipping fee in `0.00` format.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /** Tax of the shipping fee */
+    tax?: Tax$1;
+    discounts?: Discount$1[];
+}
 interface Discount$1 extends DiscountValueOneOf$1 {
     /**
      * Discount amount.
@@ -1487,19 +1507,25 @@ interface DiscountNonNullableFields$1 {
     cycles?: DiscountCyclesNonNullableFields$1;
     origin?: DiscountOriginNonNullableFields$1;
 }
+interface ShippingChargesNonNullableFields$1 {
+    amount: string;
+    tax?: TaxNonNullableFields$1;
+    discounts: DiscountNonNullableFields$1[];
+}
 interface ExternalCollectionDetailsNonNullableFields$1 {
     collectorName: string;
 }
 interface BillingSettingsNonNullableFields$1 {
     currency: string;
     paymentMethod?: PaymentMethodNonNullableFields$1;
-    collectionMethod: CollectionMethod$1;
+    collectionMethod: CollectionMethodEnumCollectionMethod$1;
     cycleDuration?: DurationNonNullableFields$1;
     cycleAutoRenew: boolean;
     freeTrialDuration?: DurationNonNullableFields$1;
     billingAddress?: FullAddressDetailsNonNullableFields$1;
     taxSettings?: TaxSettingsNonNullableFields$1;
     additionalFees: AdditionalFeeNonNullableFields$1[];
+    shippingCharges?: ShippingChargesNonNullableFields$1;
     discounts: DiscountNonNullableFields$1[];
     externalCollectionDetails?: ExternalCollectionDetailsNonNullableFields$1;
 }
@@ -1828,6 +1854,8 @@ interface Subscription {
      * @readonly
      */
     changesCounter?: string | null;
+    /** Billing order id. Optional. */
+    orderId?: string | null;
     /** items, minSize is 1, maxSize is 100 */
     items?: Item[];
 }
@@ -1895,7 +1923,7 @@ interface BillingSettings {
     /** customer payment source to make recurring payments with */
     paymentMethod?: PaymentMethod;
     /** Instructs how payments will be collected. */
-    collectionMethod?: CollectionMethod;
+    collectionMethod?: CollectionMethodEnumCollectionMethod;
     /**
      * Duration of cycle. For example, 1 MONTH, 2 WEEKS, 7 DAYS, 1 YEAR etc.
      * Shortest supported cycle duration is 7 days.
@@ -1909,7 +1937,12 @@ interface BillingSettings {
     customBillingSchedule?: CustomBillingSchedule;
     /** Definition of trial period */
     freeTrialDuration?: Duration;
-    /** Shipping costs collected each cycle */
+    /**
+     * Shipping costs collected each cycle
+     * @deprecated
+     * @replacedBy shipping_charges
+     * @targetRemovalDate 2024-10-31
+     */
     shippingFee?: string | null;
     /** Billing address associated with subscription to be used for payments. */
     billingAddress?: FullAddressDetails;
@@ -1922,6 +1955,8 @@ interface BillingSettings {
      * Max: 5 additional fees
      */
     additionalFees?: AdditionalFee[];
+    /** Shipping fee charges */
+    shippingCharges?: ShippingCharges;
     /** General discount that applied to all items in the subscription */
     discounts?: Discount[];
     /**
@@ -1934,7 +1969,7 @@ interface PaymentMethod {
     /** reference to payment source id stored in payments system */
     _id?: string;
 }
-declare enum CollectionMethod {
+declare enum CollectionMethodEnumCollectionMethod {
     UNKNOWN = "UNKNOWN",
     /** Subscriber automatically charged */
     AUTO_CHARGE = "AUTO_CHARGE",
@@ -2093,6 +2128,17 @@ interface TaxValueOneOf {
 interface DynamicTax {
     taxGroupId?: string | null;
 }
+interface ShippingCharges {
+    /**
+     * Amount of the shipping fee in `0.00` format.
+     *
+     * Min: `0.01`
+     */
+    amount?: string;
+    /** Tax of the shipping fee */
+    tax?: Tax;
+    discounts?: Discount[];
+}
 interface Discount extends DiscountValueOneOf {
     /**
      * Discount amount.
@@ -3228,19 +3274,25 @@ interface DiscountNonNullableFields {
     cycles?: DiscountCyclesNonNullableFields;
     origin?: DiscountOriginNonNullableFields;
 }
+interface ShippingChargesNonNullableFields {
+    amount: string;
+    tax?: TaxNonNullableFields;
+    discounts: DiscountNonNullableFields[];
+}
 interface ExternalCollectionDetailsNonNullableFields {
     collectorName: string;
 }
 interface BillingSettingsNonNullableFields {
     currency: string;
     paymentMethod?: PaymentMethodNonNullableFields;
-    collectionMethod: CollectionMethod;
+    collectionMethod: CollectionMethodEnumCollectionMethod;
     cycleDuration?: DurationNonNullableFields;
     cycleAutoRenew: boolean;
     freeTrialDuration?: DurationNonNullableFields;
     billingAddress?: FullAddressDetailsNonNullableFields;
     taxSettings?: TaxSettingsNonNullableFields;
     additionalFees: AdditionalFeeNonNullableFields[];
+    shippingCharges?: ShippingChargesNonNullableFields;
     discounts: DiscountNonNullableFields[];
     externalCollectionDetails?: ExternalCollectionDetailsNonNullableFields;
 }