Skip to main content
GET
/
api
/
v1
/
customers
/
{id}
Consultar cliente
curl --request GET \
  --url https://besimplo.com/api/v1/customers/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "cus_01h455vb4pex5vsknk084sn02q",
  "object": "customer",
  "live_mode": true,
  "created": 1680893993,
  "name": "João Silva",
  "external_code": "01953808-3a3a-712f-99ce-f6943c8141db",
  "identifier": "123.456.789-00",
  "email": "joao.silva@exemplo.com",
  "phone": "+5511999998888",
  "description": "individual",
  "address": {
    "zip_code": "12345012",
    "street": "Alguma Rua",
    "number": "9934",
    "district": "D'algum Bairro",
    "city": "Campinas",
    "state": "SP",
    "complement": "Apt. 123"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.besimplo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

A chave de API usada para autenticar a requisição e identificar a sua conta.

Exemplo: Authorization: ApiKey my-secure-key

Path Parameters

​
id
string
required

ID do cliente.

Pattern: ^cus_[0-9a-z]{26}$
Example:

"cus_01h455vb4pex5vsknk084sn02p"

Response

Operação realizada com sucesso

​
id
string
required
read-only

ID único do cliente, no formato TypeID com prefixo cus_.

Pattern: ^cus_[0-9a-z]{26}$
Example:

"cus_01h455vb4pex5vsknk084sn02q"

​
object
enum<string>
required

Tipo do objeto. Sempre 'customer'.

Available options:
customer
Example:

"customer"

​
live_mode
boolean
required

Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente.

Example:

true

​
created
integer<int64>
required
read-only

Timestamp Unix de quando o cliente foi criado.

Example:

1680893993

​
name
string
required

Nome do cliente.

Required string length: 1 - 250
Example:

"João Silva"

​
external_code
string

Código externo para integração. Deve ser único por conta.

Maximum string length: 250
Example:

"01953808-3a3a-712f-99ce-f6943c8141db"

​
identifier
string | null

CPF ou CNPJ do cliente.

Example:

"123.456.789-00"

​
email
string | null

E-mail do cliente.

Example:

"joao.silva@exemplo.com"

​
phone
string | null

Telefone do cliente.

Example:

"+5511999998888"

​
description
string | null

Tipo de cliente baseado no documento: 'individual' para CPF, 'business' para CNPJ.

Available options:
individual,
business
Example:

"individual"

​
address
object