Skip to main content
Um cliente é seu usuário final, aquele que você vai cobrar e pagar o seu produto.

​
Estrutura

Um cliente é representado em nossa API pela seguinte estrutura: 
{
  "id": "cus_ahwDXrgYvur89iPs",
  "livemode": false,
  "name": "John Doe",
  "email": "[email protected]",
  "phone": "+5511999999999",
  "taxId": "12345678900",
  "line1": "Rua Example, 123",
  "line2": "Apto 45",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "zipCode": "01234567",
  "createdAt": 1731622178441,
  "updatedAt": 1731622178441
}

​
Atributos

{
  "id": "cus_ahwDXrgYvur89iPs",
}
id : string.
Identificador único do cliente, começando com cus_
{
  "livemode": false,
}
livemode : boolean.
Indica se o cliente está em modo de produção (true) ou teste (false)
{
  "name": "John Doe",
}
name : string.
Nome completo do cliente (obrigatório)
{
  "email": "[email protected]",
}
email : string.
E-mail válido do cliente (obrigatório)
{
  "phone": "+5511999999999",
}
phone : string | null.
Telefone do cliente (opcional)
{
  "taxId": "12345678900",
}
taxId : string | null.
CPF/CNPJ do cliente (opcional)
{
  "line1": "Rua Example, 123",
}
line1 : string | null.
Primeira linha do endereço (opcional)
{
  "line2": "Apto 45",
}
line2 : string | null.
Segunda linha do endereço/complemento (opcional)
{
  "city": "São Paulo",
}
city : string | null.
Cidade do endereço (opcional)
{
  "state": "SP",
}
state : string | null.
Estado do endereço (opcional)
{
  "country": "BR",
}
country : string | null.
País do endereço (opcional)
{
  "zipCode": "01234567",
}
zipCode : string | null.
CEP do endereço (opcional)
{
  "createdAt": 1731622178441,
}
createdAt : number.
Timestamp Unix indicando quando o cliente foi criado
{
  "updatedAt": 1731622178441,
}
updatedAt : number.
Timestamp Unix indicando quando o cliente foi atualizado pela última vez