Sign in

v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Customers

Get a customer

Retrieves the customer with the given id. Only customers created in the live or test mode of the API key used are visible. Requesting a customer from the other mode returns a 404 Not Found error.

get/customers/{id}

Path parameters

idstring required

The unique identifier of the customer (for example cus_0ujsswThIGTUYm2K8FjOOfXtY1K).

Response

The customer with the given id.

idstring required

Unique identifier of the customer.

object'customer' required

Type of the object. Always customer.

created_atstring date-time required

ISO 8601 datetime, in UTC, of when the customer was created.

emailstring nullable required

Customer's email, stored in lowercase. null if not provided.

metadataobject required

Set of key-value pairs that you can attach to an object. Useful for storing additional information about the object in a structured format.

mode'live' | 'test' required

Mode of the customer, matching the mode of the API key used to create it. One of live or test.

namestring nullable required

Customer's full name or business name. null if not provided.

phonestring nullable required

Customer's phone number in E.164 format, including the country code (for example +56911111111). null if not provided.

Example response

{
  "id": "cus_0ujsswThIGTUYm2K8FjOOfXtY1K",
  "address": {
    "city": "Santiago",
    "country": "cl",
    "line1": "Av. Providencia 123",
    "line2": "Depto 45",
    "postal_code": "7500000",
    "state": "RM"
  },
  "created_at": "2026-01-15T14:30:00Z",
  "email": "jared@piedpiper.com",
  "metadata": {
    "order_id": "12345"
  },
  "mode": "live",
  "name": "Test Customer 1",
  "phone": "+56911111111",
  "tax_id": {
    "type": "cl_rut",
    "value": "111111111"
  }
}