softDelete - Customer Module Reference

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

This method soft deletes customers by their IDs.

Example

await customerModuleService.softDelete(["cus_123"])

Parameters

customerIdsstring[]Required

The IDs of customers.

configSoftDeleteReturn<TReturnableLinkableKeys>

An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.

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 also soft deleted, such as the ID of the associated address. The object's keys are the ID attribute names of the customer entity's relations, such as address_id, and its value is an array of strings, each being the ID of a record associated with the customer through this relation, such as the IDs of associated address. If there are no related records, the promise resolves to void.