📘 Name Type Description Required id string Stripe customer ID (starting with "cus_") yes
Name Type Description Required include_subscriptions boolean Whether to include subscription data for the customer (default: false) no
Field Type Description id string Customer ID email string Customer email firstName string Customer first name lastName string Customer last name phone string Customer phone number stripeCustomerId string Stripe customer ID address object Customer address (optional) createdAt string Customer creation date (ISO 8601) updatedAt string Last update date (ISO 8601) subscriptions array Customer subscriptions (only when include_subscriptions=true)
Field Type Description street string Street address (optional) city string City (optional) state string State or province (optional) postalCode string Postal/ZIP code (optional)
Field Type Description id string Subscription ID status string Status (active, past_due, canceled, etc.) plan object Plan details currentPeriodStart string Current period start (ISO 8601) currentPeriodEnd string Current period end (ISO 8601) createdAt string Subscription creation date (ISO 8601)
Field Type Description stripePriceId string Stripe price ID name string Plan name amount number Plan amount in cents currency string Currency code interval string Billing interval productId number Product ID productName string Product name productDescription string Product description (nullable)
HTTP
GET /api/public/customers/cus_ExampleCustomerID123?include_subscriptions=true
Authorization: Bearer YOUR_API_KEYJSON
{
"id": "123",
"email": "[email protected] ",
"firstName": "John",
"lastName": "Doe",
"phone": "+1234567890",
"stripeCustomerId": "cus_ExampleCustomerID123",
"address": {
"street": "123 Main St",
"city": "New York",
"state": "NY",
"postalCode": "10001"
},
"createdAt": "2023-12-01T00:00:00.000Z",
"updatedAt": "2024-01-15T00:00:00.000Z",
"subscriptions": [
{
"id": "sub_ExampleSubscription123",
"status": "active",
"plan": {
"stripePriceId": "price_ExamplePriceID456",
"name": "Premium Plan",
"amount": 4999,
"currency": "usd",
"interval": "month",
"productId": 456,
"productName": "Auto Insurance",
"productDescription": "Comprehensive auto coverage"
},
"currentPeriodStart": "2024-01-01T00:00:00.000Z",
"currentPeriodEnd": "2024-02-01T00:00:00.000Z",
"createdAt": "2023-12-01T00:00:00.000Z"
}
]
}This endpoint retrieves detailed information about a specific customer including payment methods and optionally subscription history. The response includes comprehensive customer profile details, address information, and can include active and past subscriptions when requested.
400 Bad Request : Invalid customer ID format401 Unauthorized : Invalid or missing authorization token403 Forbidden : Insufficient permissions404 Not Found : Customer not found 