GET
/
customers
import DodoPayments from 'dodopayments';

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

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

main();
{
  "items": [
    {
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "customer_id": "<string>",
      "email": "<string>",
      "name": "<string>",
      "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 | null

Page size default is 10 max is 100

Required range: x >= 0
page_number
integer | null

Page number default is 0

Required range: x >= 0

Response

200 - application/json
Customers List
items
object[]
required