List customers
Paginated customers for an account. Set `include_payment_methods=true` to embed saved methods. DTOs are forward-compatible: unknown keys should be ignored by clients.
Authorization
bearerAuth Use Authorization: Bearer <token>. The same header supports: (1) JWT access token from the configured auth provider; (2) secret API key whose value contains sk_ within the first 32 characters (e.g. sk_live_…, sk_test_…); (3) publishable key containing pk_. Sandbox keys typically include _test_ in the string; the server resolves repositories from that.
In: header
Query Parameters
Target account; often inferred from auth when omitted.
0 < value0 < valueWhen true, the API may embed payment_methods on each customer. The documented schema is a minimum; extra fields on each item are allowed and must not error.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://api.hsrcpay.com/v1/customers/"{
"message": "success",
"success": true,
"data": [
{
"object": "customer",
"id": "string",
"account_id": "string",
"name": "string",
"email": "string",
"phone": "string",
"country": "string",
"alternate_emails": [
"user@example.com"
],
"is_guest": true,
"deleted": true,
"metadata": {
"property1": null,
"property2": null
},
"created_at": null,
"updated_at": null,
"addresses": [
{
"object": "customer_address",
"id": "string",
"customer_id": "string",
"type": "BILLING",
"is_default": true,
"label": "string",
"country": "string",
"city": "string",
"state": "string",
"line1": "string",
"line2": "string",
"zip": "string",
"created_at": null,
"updated_at": null,
"property1": null,
"property2": null
}
],
"payment_methods": [
{
"id": "string",
"property1": null,
"property2": null
}
],
"property1": null,
"property2": null
}
],
"total": 0,
"page": 9007199254740991,
"limit": 9007199254740991,
"pages": 0,
"property1": null,
"property2": null
}{
"message": "string",
"success": false,
"error": {
"code": 0,
"message": "string",
"details": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"message": "string",
"success": false,
"error": {
"code": 0,
"message": "string",
"details": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"message": "string",
"success": false,
"error": {
"code": 0,
"message": "string",
"details": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"message": "string",
"success": false,
"error": {
"code": 0,
"message": "string",
"details": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"message": "string",
"success": false,
"error": {
"code": 0,
"message": "string",
"details": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"message": "string",
"success": false,
"error": {
"code": 0,
"message": "string",
"details": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"message": "string",
"success": false,
"error": {
"code": 0,
"message": "string",
"details": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}{
"message": "string",
"success": false,
"error": {
"code": 0,
"message": "string",
"details": {
"property1": null,
"property2": null
},
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}