list - Customer Module Reference

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

This method retrieves a paginated list of customers based on optional filters and configuration.

Example

To retrieve a list of customers using their IDs:

const customers = await customerModuleService.list({
  id: ["cus_123", "cus_321"],
})

To specify relations that should be retrieved within the customers:

const customers = await customerModuleService.list(
  {
    id: ["cus_123", "cus_321"],
  },
  {
    relations: ["groups"],
  }
)

By default, only the first 15 records are retrieved. You can control pagination by specifying the skip and take properties of the config parameter:

const customers = await customerModuleService.list(
  {
    id: ["cus_123", "cus_321"],
  },
  {
    relations: ["groups"],
    take: 20,
    skip: 2,
  }
)

Parameters

filtersFilterableCustomerProps

The filters to apply on the retrieved customers.

configFindConfig<CustomerDTO>

The configurations determining how the customer is retrieved. Its properties, such as select or relations, accept the attributes or relations associated with a customer.

sharedContextContext

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

Returns

PromisePromise<CustomerDTO[]>Required

The list of customers.