Get list of customers

📘
API Refs

Staging: Get list of customers

Request parameters

Name	Type	Description	Required
limit	number	Maximum number of customers to return (default: 50, max: 100)	no
offset	number	Number of customers to skip for pagination	no
include_subscriptions	boolean	Whether to include subscription data for each customer (default: false)	no

Response body

Returns a paginated response with:

data: Array of customer objects, each containing:
- id: StripeCustomerID
- email: Customer email
- firstName: Customer first name
- lastName: Customer last name
- phone: Customer phone number
- stripeCustomerId: Stripe StripeCustomerID
- hasActiveSubscription: Whether customer has active subscriptions
- subscriptions: Array of subscription details (only when include_subscriptions=true)
- createdAt: Creation timestamp
- updatedAt: Last update timestamp
pagination: Pagination details
- total: Total number of customers
- limit: Number of items returned
- offset: Number of items skipped
- hasMore: Whether more items exist

Description

This endpoint retrieves a paginated list of all customers in your merchant account. The response includes basic customer information and optionally their subscription details when include_subscriptions=true. The pagination uses offset-based navigation to browse through large customer lists.