Uprails
Customers/Retrieve

Retrieve Customer

Retrieve the details of an existing customer.

GEThttps://api.uprails.com/customers/:customer_id

Retrieves a customer by their ID. Returns the customer object with all stored information.

Path Parameters

ParameterTypeDescription
customer_idstringRequired. The ID of the customer to retrieve.

Request Example

curl https://api.uprails.com/customers/cus_1234567890abcdef \
  -H "api-key: snd_YOUR_API_KEY"

Response

200OK
{
  "customer_id": "cus_1234567890abcdef",
  "merchant_id": "mer_xyz789",
  "email": "customer@example.com",
  "name": "John Doe",
  "phone": "+1234567890",
  "phone_country_code": "+1",
  "description": "Premium customer",
  "address": {
    "line1": "123 Main Street",
    "line2": "Apt 4B",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94102",
    "country": "US"
  },
  "metadata": {
    "user_id": "usr_12345"
  },
  "created": "2024-01-15T10:00:00Z",
  "updated": "2024-01-15T10:00:00Z"
}