restore - Customer Module Reference

This documentation provides a reference to the restore method. This belongs to the Customer Module.

This method restores soft deleted customer by their IDs.

Example

await customerModuleService.restore(["cus_123"])

Parameters

customerIdsstring[]Required

The IDs of customers.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the customer. You can pass to its returnLinkableKeys property any of the customer's relation attribute names, such as groups.

sharedContextContext

A context used to share resources, such as transaction manager, between the application and the module.

Returns

PromisePromise<void | Record<TReturnableLinkableKeys, string[]>>Required

An object that includes the IDs of related records that were restored. If there are no related records restored, the promise resolves to void.