List Customers

Get a list of all customers associated with your account.

GET /customers

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const customer of client.customers.list()) {
  console.log(customer.business_id);
}

200

{
  "items": [
    {
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "metadata": {},
      "phone_number": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_size · integer<int32>

Page size default is 10 max is 100

Required range: x >= 0

page_number · integer<int32>

Page number default is 0

Required range: x >= 0

email · string

Filter by customer email

name · string

Filter by customer name (partial match, case-insensitive)

created_at_gte · string<date-time>

Filter customers created on or after this timestamp

created_at_lte · string<date-time>

Filter customers created on or before this timestamp

Response

200

application/json

Customers List

items · object[] · required

Show child attributes