curl -X GET "https://api.chariow.com/v1/customers/cus_abc123xyz" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/customers/cus_abc123xyz', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/customers/cus_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/customers/cus_abc123xyz',
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()['data']
{
"data": {
"id": "cus_abc123xyz",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
"phone": {
"number": "+1 234 567 890",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "🇺🇸"
}
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
"url": "https://mystore.chariow.link"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-20T14:45:00+00:00"
}
}
{
"message": "No query results for model [App\\Models\\Customer] cus_unknown",
"errors": []
}
Customers
Get Customer
Retrieve details of a specific customer
curl -X GET "https://api.chariow.com/v1/customers/cus_abc123xyz" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/customers/cus_abc123xyz', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/customers/cus_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/customers/cus_abc123xyz',
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()['data']
{
"data": {
"id": "cus_abc123xyz",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
"phone": {
"number": "+1 234 567 890",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "🇺🇸"
}
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
"url": "https://mystore.chariow.link"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-20T14:45:00+00:00"
}
}
{
"message": "No query results for model [App\\Models\\Customer] cus_unknown",
"errors": []
}
Retrieves detailed information about a specific customer by their public ID. Returns the complete customer profile including contact information and store details.
Each store has one customer per email address (compared case-insensitively). Customers that had been duplicated in the past were merged into the oldest record: the ID of a merged duplicate now returns
404, and its sales belong to the surviving customer.Required scopes:
customers.read and customers.pii.read. Granting customers.pii.read alone is enough, as it includes customers.read. A key without them receives a 403 error. See Authentication.Path Parameters
string
required
The unique customer identifier (e.g.,
cus_abc123xyz)Response
object
Show properties
Show properties
string
Unique customer identifier (e.g.,
cus_abc123xyz)string
Customer full name (combination of first and last name)
string
Customer first name
string
Customer last name
string
Customer email address
string
URL to the customer’s avatar image
object
Customer phone number
Show phone object
Show phone object
object
string
ISO 8601 timestamp of when the customer was created
string
ISO 8601 timestamp of when the customer was last updated
curl -X GET "https://api.chariow.com/v1/customers/cus_abc123xyz" \
-H "Authorization: Bearer sk_live_your_api_key"
const response = await fetch('https://api.chariow.com/v1/customers/cus_abc123xyz', {
headers: {
'Authorization': 'Bearer sk_live_your_api_key'
}
});
const { data } = await response.json();
$ch = curl_init('https://api.chariow.com/v1/customers/cus_abc123xyz');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer sk_live_your_api_key'
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
$data = json_decode($response, true);
import requests
response = requests.get(
'https://api.chariow.com/v1/customers/cus_abc123xyz',
headers={'Authorization': 'Bearer sk_live_your_api_key'}
)
data = response.json()['data']
{
"data": {
"id": "cus_abc123xyz",
"name": "John Doe",
"first_name": "John",
"last_name": "Doe",
"email": "john@example.com",
"avatar_url": "https://cdn.chariow.com/avatars/abc123.jpg",
"phone": {
"number": "+1 234 567 890",
"country": {
"name": "United States",
"code": "US",
"alpha_3_code": "USA",
"dial_code": "+1",
"currency": "USD",
"flag": "🇺🇸"
}
},
"store": {
"id": "str_xyz789",
"name": "My Digital Store",
"logo_url": "https://cdn.chariow.com/stores/xyz789/logo.png",
"url": "https://mystore.chariow.link"
},
"created_at": "2025-01-15T10:30:00+00:00",
"updated_at": "2025-01-20T14:45:00+00:00"
}
}
{
"message": "No query results for model [App\\Models\\Customer] cus_unknown",
"errors": []
}
Was this page helpful?