@wix/auto_sdk_subscription_subscriptions 1.0.0 → 1.0.2

package/build/internal/es/src/billing-v1-subscription-subscriptions.universal.js

@@ -115,52 +115,6 @@ export var ItemCategory;
     ItemCategory["PHYSICAL"] = "PHYSICAL";
     ItemCategory["DIGITAL"] = "DIGITAL";
 })(ItemCategory || (ItemCategory = {}));
-export var HistoryViewMode;
-(function (HistoryViewMode) {
-    HistoryViewMode["UNKNOWN"] = "UNKNOWN";
-    /** Comprehensive view including all history events. */
-    HistoryViewMode["BACKOFFICE"] = "BACKOFFICE";
-    /** User-centric view of the history. */
-    HistoryViewMode["USER"] = "USER";
-})(HistoryViewMode || (HistoryViewMode = {}));
-export var UpdateAction;
-(function (UpdateAction) {
-    UpdateAction["NONE"] = "NONE";
-    /** Update subscription immediately, please note proration for updates changing price are not yet supported */
-    UpdateAction["IMMEDIATELY"] = "IMMEDIATELY";
-    /** Request updates that will take affect only at the start of the next billing cycle. */
-    UpdateAction["NEXT_BILLING_CYCLE"] = "NEXT_BILLING_CYCLE";
-    /** Reset all pending updates */
-    UpdateAction["RESET_PENDING_UPDATES"] = "RESET_PENDING_UPDATES";
-    /** Request updates that will take affect only at a specific date. */
-    UpdateAction["SPECIFIC_DATE"] = "SPECIFIC_DATE";
-})(UpdateAction || (UpdateAction = {}));
-export var PaymentSettlementMethod;
-(function (PaymentSettlementMethod) {
-    PaymentSettlementMethod["UNKNOWN"] = "UNKNOWN";
-    /** System-defined payment settlement. */
-    PaymentSettlementMethod["SYSTEM"] = "SYSTEM";
-    /** Manually mark the payment as paid. */
-    PaymentSettlementMethod["MARK_AS_PAID"] = "MARK_AS_PAID";
-    /** Require the customer to pay immediately, by insert a new payment method. */
-    PaymentSettlementMethod["CUSTOMER_PAY_NOW"] = "CUSTOMER_PAY_NOW";
-})(PaymentSettlementMethod || (PaymentSettlementMethod = {}));
-export var PaymentMode;
-(function (PaymentMode) {
-    PaymentMode["NONE"] = "NONE";
-    /** The latest invoice of the subscription will be charged. */
-    PaymentMode["CHARGE"] = "CHARGE";
-    /** An authorization invoice with zero amount will be created. */
-    PaymentMode["AUTHORIZATION"] = "AUTHORIZATION";
-})(PaymentMode || (PaymentMode = {}));
-export var WebhookIdentityType;
-(function (WebhookIdentityType) {
-    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
-    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
-    WebhookIdentityType["MEMBER"] = "MEMBER";
-    WebhookIdentityType["WIX_USER"] = "WIX_USER";
-    WebhookIdentityType["APP"] = "APP";
-})(WebhookIdentityType || (WebhookIdentityType = {}));
 export var SortOrder;
 (function (SortOrder) {
     SortOrder["ASC"] = "ASC";
@@ -194,12 +148,40 @@ export var ExtendPolicyType;
     ExtendPolicyType["PERIOD"] = "PERIOD";
     ExtendPolicyType["BILLING_CYCLE"] = "BILLING_CYCLE";
 })(ExtendPolicyType || (ExtendPolicyType = {}));
+export var PaymentMode;
+(function (PaymentMode) {
+    PaymentMode["NONE"] = "NONE";
+    /** The latest invoice of the subscription will be charged. */
+    PaymentMode["CHARGE"] = "CHARGE";
+    /** An authorization invoice with zero amount will be created. */
+    PaymentMode["AUTHORIZATION"] = "AUTHORIZATION";
+})(PaymentMode || (PaymentMode = {}));
 export var OrderMethod;
 (function (OrderMethod) {
     OrderMethod["UNKNOWN"] = "UNKNOWN";
     OrderMethod["MOTO"] = "MOTO";
     OrderMethod["NOT_MOTO"] = "NOT_MOTO";
 })(OrderMethod || (OrderMethod = {}));
+export var WebhookIdentityType;
+(function (WebhookIdentityType) {
+    WebhookIdentityType["UNKNOWN"] = "UNKNOWN";
+    WebhookIdentityType["ANONYMOUS_VISITOR"] = "ANONYMOUS_VISITOR";
+    WebhookIdentityType["MEMBER"] = "MEMBER";
+    WebhookIdentityType["WIX_USER"] = "WIX_USER";
+    WebhookIdentityType["APP"] = "APP";
+})(WebhookIdentityType || (WebhookIdentityType = {}));
+export var PaymentTestMode;
+(function (PaymentTestMode) {
+    PaymentTestMode["REGULAR"] = "REGULAR";
+    PaymentTestMode["FAIL_TECHNICAL"] = "FAIL_TECHNICAL";
+    PaymentTestMode["FAIL_DECLINE"] = "FAIL_DECLINE";
+    PaymentTestMode["FAIL_RETRYABLE_DECLINE"] = "FAIL_RETRYABLE_DECLINE";
+})(PaymentTestMode || (PaymentTestMode = {}));
+export var RevivePolicy;
+(function (RevivePolicy) {
+    RevivePolicy["SIMPLE"] = "SIMPLE";
+    RevivePolicy["RESUME"] = "RESUME";
+})(RevivePolicy || (RevivePolicy = {}));
 export var ActionInitiator;
 (function (ActionInitiator) {
     ActionInitiator["UNDEFINED"] = "UNDEFINED";
@@ -207,6 +189,18 @@ export var ActionInitiator;
     ActionInitiator["CUSTOMER"] = "CUSTOMER";
     ActionInitiator["SYSTEM"] = "SYSTEM";
 })(ActionInitiator || (ActionInitiator = {}));
+export var UpdateAction;
+(function (UpdateAction) {
+    UpdateAction["NONE"] = "NONE";
+    /** Update subscription immediately, please note proration for updates changing price are not yet supported */
+    UpdateAction["IMMEDIATELY"] = "IMMEDIATELY";
+    /** Request updates that will take affect only at the start of the next billing cycle. */
+    UpdateAction["NEXT_BILLING_CYCLE"] = "NEXT_BILLING_CYCLE";
+    /** Reset all pending updates */
+    UpdateAction["RESET_PENDING_UPDATES"] = "RESET_PENDING_UPDATES";
+    /** Request updates that will take affect only at a specific date. */
+    UpdateAction["SPECIFIC_DATE"] = "SPECIFIC_DATE";
+})(UpdateAction || (UpdateAction = {}));
 export var RequestedFields;
 (function (RequestedFields) {
     RequestedFields["UNKNOWN_REQUESTED_FIELD"] = "UNKNOWN_REQUESTED_FIELD";
@@ -325,260 +319,24 @@ export var Status;
     Status["ACTIVE"] = "ACTIVE";
     Status["ENDED"] = "ENDED";
 })(Status || (Status = {}));
-export var PaymentTestMode;
-(function (PaymentTestMode) {
-    PaymentTestMode["REGULAR"] = "REGULAR";
-    PaymentTestMode["FAIL_TECHNICAL"] = "FAIL_TECHNICAL";
-    PaymentTestMode["FAIL_DECLINE"] = "FAIL_DECLINE";
-    PaymentTestMode["FAIL_RETRYABLE_DECLINE"] = "FAIL_RETRYABLE_DECLINE";
-})(PaymentTestMode || (PaymentTestMode = {}));
-export var RevivePolicy;
-(function (RevivePolicy) {
-    RevivePolicy["SIMPLE"] = "SIMPLE";
-    RevivePolicy["RESUME"] = "RESUME";
-})(RevivePolicy || (RevivePolicy = {}));
-/** @public
- * @documentationMaturity preview
- * @requiredField subscriptionId
- * @permissionId subscriptions.view
- * @permissionScope Manage Events
- * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
- * @applicableIdentity APP
- * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionHistoryService.ListSubscriptionHistory
- */
-export async function listSubscriptionHistory(subscriptionId, options) {
-    // @ts-ignore
-    const { httpClient, sideEffects } = arguments[2];
-    const payload = renameKeysFromSDKRequestToRESTRequest({
-        subscriptionId: subscriptionId,
-        mode: options?.mode,
-        cursor: options?.cursor,
-    });
-    const reqOpts = ambassadorWixBillingV1Subscription.listSubscriptionHistory(payload);
-    sideEffects?.onSiteCall?.();
-    try {
-        const result = await httpClient.request(reqOpts);
-        sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
-            {
-                transformFn: transformRESTAddressToSDKAddress,
-                paths: [
-                    {
-                        path: 'historyEntries.event.created.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.created.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.updated.current.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.updated.current.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.updated.previous.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.updated.previous.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.activated.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.activated.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.ended.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.ended.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.canceled.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.canceled.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.paused.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.paused.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.resumed.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.resumed.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.pauseRequested.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.pauseRequested.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.resumeRequested.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.resumeRequested.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.scheduledPauseCanceled.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.scheduledPauseCanceled.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.scheduledResumeCanceled.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.scheduledResumeCanceled.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.billingCycleStarted.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.billingCycleStarted.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.autoRenewalTurnedOn.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.autoRenewalTurnedOn.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.autoRenewalTurnedOff.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.autoRenewalTurnedOff.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.cycleReadyToPay.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.cycleReadyToPay.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.extended.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.extended.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.initialPurchaseCompleted.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.initialPurchaseCompleted.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.latestInvoiceMarkedAsPaid.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.latestInvoiceMarkedAsPaid.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.revived.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.revived.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.billingDateUpdated.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.billingDateUpdated.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.futureUpdatesRequested.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.futureUpdatesRequested.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.updatesApplied.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.updatesApplied.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.resetPendingUpdates.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.resetPendingUpdates.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.gracePeriodStarted.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.gracePeriodStarted.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.gracePeriodEnded.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.gracePeriodEnded.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.paymentMethodUpdated.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.paymentMethodUpdated.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.collectionMethodUpdated.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.collectionMethodUpdated.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.freeTrailStarted.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.freeTrailStarted.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.freeTrailEnded.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.freeTrailEnded.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.invoiceMarkedAsPaid.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.invoiceMarkedAsPaid.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.initiatePaymentMethodSetup.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.initiatePaymentMethodSetup.subscription.shippingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.subscriptionBoAction.subscription.billingSettings.billingAddress.address',
-                    },
-                    {
-                        path: 'historyEntries.event.subscriptionBoAction.subscription.shippingAddress.address',
-                    },
-                ],
-            },
-        ]));
-    }
-    catch (err) {
-        const transformedError = sdkTransformError(err, {
-            spreadPathsToArguments: {},
-            explicitPathsToArguments: {
-                subscriptionId: '$[0]',
-                mode: '$[1].mode',
-                cursor: '$[1].cursor',
-            },
-            singleArgumentUnchanged: false,
-        }, ['subscriptionId', 'options']);
-        sideEffects?.onError?.(err);
-        throw transformedError;
-    }
-}
+export var HistoryViewMode;
+(function (HistoryViewMode) {
+    HistoryViewMode["UNKNOWN"] = "UNKNOWN";
+    /** Comprehensive view including all history events. */
+    HistoryViewMode["BACKOFFICE"] = "BACKOFFICE";
+    /** User-centric view of the history. */
+    HistoryViewMode["USER"] = "USER";
+})(HistoryViewMode || (HistoryViewMode = {}));
+export var PaymentSettlementMethod;
+(function (PaymentSettlementMethod) {
+    PaymentSettlementMethod["UNKNOWN"] = "UNKNOWN";
+    /** System-defined payment settlement. */
+    PaymentSettlementMethod["SYSTEM"] = "SYSTEM";
+    /** Manually mark the payment as paid. */
+    PaymentSettlementMethod["MARK_AS_PAID"] = "MARK_AS_PAID";
+    /** Require the customer to pay immediately, by insert a new payment method. */
+    PaymentSettlementMethod["CUSTOMER_PAY_NOW"] = "CUSTOMER_PAY_NOW";
+})(PaymentSettlementMethod || (PaymentSettlementMethod = {}));
 /**
  * Identity must be a site member and customer subscription belongs to
  * @public
@@ -911,37 +669,82 @@ export async function customerListUpcomingCharges(_id) {
     }
 }
 /**
- * Creates auto-charge order that can be paid by customer
+ * Creates auto-charge order that can be paid by customer
+ * @public
+ * @documentationMaturity preview
+ * @requiredField _id
+ * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.InitiatePaymentMethodSetup
+ */
+export async function customerInitiatePaymentMethodSetup(_id, options) {
+    // @ts-ignore
+    const { httpClient, sideEffects } = arguments[2];
+    const payload = renameKeysFromSDKRequestToRESTRequest({
+        id: _id,
+        paymentMode: options?.paymentMode,
+        paymentSettings: options?.paymentSettings,
+    });
+    const reqOpts = ambassadorWixBillingV1Subscription.customerInitiatePaymentMethodSetup(payload);
+    sideEffects?.onSiteCall?.();
+    try {
+        const result = await httpClient.request(reqOpts);
+        sideEffects?.onSuccess?.(result);
+        return renameKeysFromRESTResponseToSDKResponse(result.data);
+    }
+    catch (err) {
+        const transformedError = sdkTransformError(err, {
+            spreadPathsToArguments: {},
+            explicitPathsToArguments: {
+                id: '$[0]',
+                paymentMode: '$[1].paymentMode',
+                paymentSettings: '$[1].paymentSettings',
+            },
+            singleArgumentUnchanged: false,
+        }, ['_id', 'options']);
+        sideEffects?.onError?.(err);
+        throw transformedError;
+    }
+}
+/**
+ * This used only for automation and permitted tenants (QA & testing)
  * @public
  * @documentationMaturity preview
- * @requiredField _id
- * @fqn com.wixpress.billing.subscriptions.api.v1.CustomerSubscriptionsService.InitiatePaymentMethodSetup
+ * @requiredField options.tenantId
+ * @requiredField subscriptionId
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsBackOfficeService.PayCycle
  */
-export async function customerInitiatePaymentMethodSetup(_id, options) {
+export async function payCycle(subscriptionId, options) {
     // @ts-ignore
     const { httpClient, sideEffects } = arguments[2];
     const payload = renameKeysFromSDKRequestToRESTRequest({
-        id: _id,
-        paymentMode: options?.paymentMode,
-        paymentSettings: options?.paymentSettings,
+        subscriptionId: subscriptionId,
+        paymentTestMode: options?.paymentTestMode,
+        tenantId: options?.tenantId,
     });
-    const reqOpts = ambassadorWixBillingV1Subscription.customerInitiatePaymentMethodSetup(payload);
+    const reqOpts = ambassadorWixBillingV1Subscription.payCycle(payload);
     sideEffects?.onSiteCall?.();
     try {
         const result = await httpClient.request(reqOpts);
         sideEffects?.onSuccess?.(result);
-        return renameKeysFromRESTResponseToSDKResponse(result.data);
+        return renameKeysFromRESTResponseToSDKResponse(transformPaths(result.data, [
+            {
+                transformFn: transformRESTAddressToSDKAddress,
+                paths: [
+                    { path: 'subscription.billingSettings.billingAddress.address' },
+                    { path: 'subscription.shippingAddress.address' },
+                ],
+            },
+        ]));
     }
     catch (err) {
         const transformedError = sdkTransformError(err, {
             spreadPathsToArguments: {},
             explicitPathsToArguments: {
-                id: '$[0]',
-                paymentMode: '$[1].paymentMode',
-                paymentSettings: '$[1].paymentSettings',
+                subscriptionId: '$[0]',
+                paymentTestMode: '$[1].paymentTestMode',
+                tenantId: '$[1].tenantId',
             },
             singleArgumentUnchanged: false,
-        }, ['_id', 'options']);
+        }, ['subscriptionId', 'options']);
         sideEffects?.onError?.(err);
         throw transformedError;
     }
@@ -1521,7 +1324,7 @@ export async function markLatestInvoiceAsPaid(subscriptionId) {
     }
 }
 /**
- * Marks the invoice associated with the subscription in the specified cycle as paid.
+ * Marks the invoice associated with given subscription cycle as paid for the following scenarios:
  * If `paid_cycle` is left empty, the most recent invoice will be marked as paid.
  * If the invoice contains items other than subscription items, an error will be thrown.
  *
@@ -1541,16 +1344,16 @@ export async function markLatestInvoiceAsPaid(subscriptionId) {
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
  * @applicableIdentity APP
- * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.MarkInvoiceAsPaid
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsService.MarkBillingCycleAsPaid
  */
-export async function markInvoiceAsPaid(subscriptionId, options) {
+export async function markBillingCycleAsPaid(subscriptionId, options) {
     // @ts-ignore
     const { httpClient, sideEffects } = arguments[2];
     const payload = renameKeysFromSDKRequestToRESTRequest({
         subscriptionId: subscriptionId,
         paidCycle: options?.paidCycle,
     });
-    const reqOpts = ambassadorWixBillingV1Subscription.markInvoiceAsPaid(payload);
+    const reqOpts = ambassadorWixBillingV1Subscription.markBillingCycleAsPaid(payload);
     sideEffects?.onSiteCall?.();
     try {
         const result = await httpClient.request(reqOpts);
@@ -1616,6 +1419,7 @@ export async function getSubscriptionsStats() {
  * @documentationMaturity preview
  * @requiredField _id
  * @requiredField actionContext
+ * @requiredField extendPolicy
  * @permissionId subscriptions.manage
  * @permissionScope Manage Orders
  * @permissionScopeId SCOPE.DC-PAIDPLANS.MANAGE-ORDERS
@@ -1740,11 +1544,10 @@ export async function listUpcomingCharges(subscriptionId, options) {
  * Returns all the charges applicable to a subscription based on the provided subscription information.
  * @public
  * @documentationMaturity preview
- * @requiredField options
- * @requiredField options.subscriptionInfo
- * @requiredField options.subscriptionInfo.billingSettings
- * @requiredField options.subscriptionInfo.items
- * @requiredField options.subscriptionInfo.items.pricingModel
+ * @requiredField subscription.subscriptionInfo
+ * @requiredField subscription.subscriptionInfo.billingSettings
+ * @requiredField subscription.subscriptionInfo.items
+ * @requiredField subscription.subscriptionInfo.items.pricingModel
  * @permissionId subscriptions.view
  * @permissionScope Manage Events
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
@@ -1790,11 +1593,12 @@ export async function previewSubscriptionCharges(options) {
  * @public
  * @documentationMaturity preview
  * @requiredField options.subscriptionsBillingDetails.billingSettings
- * @requiredField options.subscriptionsBillingDetails.billingSettings.shippingCharges.tax
+ * @requiredField options.subscriptionsBillingDetails.billingSettings.shippingCharges.tax.value
  * @requiredField options.subscriptionsBillingDetails.externalId
  * @requiredField options.subscriptionsBillingDetails.items
  * @requiredField options.subscriptionsBillingDetails.items.pricingModel
- * @requiredField options.subscriptionsBillingDetails.items.tax
+ * @requiredField options.subscriptionsBillingDetails.items.pricingModel.model
+ * @requiredField options.subscriptionsBillingDetails.items.tax.value
  * @permissionId subscriptions.view
  * @permissionScope Manage Events
  * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
@@ -1878,23 +1682,24 @@ export async function initiatePaymentMethodSetup(_id, options) {
         throw transformedError;
     }
 }
-/**
- * This used only for automation and permitted tenants (QA & testing)
- * @public
+/** @public
  * @documentationMaturity preview
- * @requiredField options.tenantId
  * @requiredField subscriptionId
- * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionsBackOfficeService.PayCycle
+ * @permissionId subscriptions.view
+ * @permissionScope Manage Events
+ * @permissionScopeId SCOPE.EVENTS.MANAGE-EVENTS
+ * @applicableIdentity APP
+ * @fqn com.wixpress.billing.subscriptions.api.v1.SubscriptionHistoryService.ListSubscriptionHistory
  */
-export async function payCycle(subscriptionId, options) {
+export async function listSubscriptionHistory(subscriptionId, options) {
     // @ts-ignore
     const { httpClient, sideEffects } = arguments[2];
     const payload = renameKeysFromSDKRequestToRESTRequest({
         subscriptionId: subscriptionId,
-        paymentTestMode: options?.paymentTestMode,
-        tenantId: options?.tenantId,
+        mode: options?.mode,
+        cursor: options?.cursor,
     });
-    const reqOpts = ambassadorWixBillingV1Subscription.payCycle(payload);
+    const reqOpts = ambassadorWixBillingV1Subscription.listSubscriptionHistory(payload);
     sideEffects?.onSiteCall?.();
     try {
         const result = await httpClient.request(reqOpts);
@@ -1903,8 +1708,204 @@ export async function payCycle(subscriptionId, options) {
             {
                 transformFn: transformRESTAddressToSDKAddress,
                 paths: [
-                    { path: 'subscription.billingSettings.billingAddress.address' },
-                    { path: 'subscription.shippingAddress.address' },
+                    {
+                        path: 'historyEntries.event.created.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.created.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.updated.current.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.updated.current.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.updated.previous.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.updated.previous.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.activated.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.activated.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.ended.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.ended.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.canceled.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.canceled.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.paused.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.paused.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.resumed.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.resumed.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.pauseRequested.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.pauseRequested.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.resumeRequested.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.resumeRequested.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.scheduledPauseCanceled.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.scheduledPauseCanceled.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.scheduledResumeCanceled.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.scheduledResumeCanceled.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.billingCycleStarted.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.billingCycleStarted.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.autoRenewalTurnedOn.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.autoRenewalTurnedOn.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.autoRenewalTurnedOff.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.autoRenewalTurnedOff.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.cycleReadyToPay.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.cycleReadyToPay.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.extended.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.extended.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.initialPurchaseCompleted.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.initialPurchaseCompleted.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.latestInvoiceMarkedAsPaid.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.latestInvoiceMarkedAsPaid.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.revived.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.revived.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.billingDateUpdated.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.billingDateUpdated.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.futureUpdatesRequested.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.futureUpdatesRequested.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.updatesApplied.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.updatesApplied.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.resetPendingUpdates.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.resetPendingUpdates.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.gracePeriodStarted.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.gracePeriodStarted.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.gracePeriodEnded.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.gracePeriodEnded.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.paymentMethodUpdated.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.paymentMethodUpdated.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.collectionMethodUpdated.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.collectionMethodUpdated.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.freeTrailStarted.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.freeTrailStarted.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.freeTrailEnded.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.freeTrailEnded.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.billingCyclePaid.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.billingCyclePaid.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.initiatePaymentMethodSetup.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.initiatePaymentMethodSetup.subscription.shippingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.subscriptionBoAction.subscription.billingSettings.billingAddress.address',
+                    },
+                    {
+                        path: 'historyEntries.event.subscriptionBoAction.subscription.shippingAddress.address',
+                    },
                 ],
             },
         ]));
@@ -1914,8 +1915,8 @@ export async function payCycle(subscriptionId, options) {
             spreadPathsToArguments: {},
             explicitPathsToArguments: {
                 subscriptionId: '$[0]',
-                paymentTestMode: '$[1].paymentTestMode',
-                tenantId: '$[1].tenantId',
+                mode: '$[1].mode',
+                cursor: '$[1].cursor',
             },
             singleArgumentUnchanged: false,
         }, ['subscriptionId', 'options']);