> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vertracloud.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter dados de cobrança

> Retorna os dados de cobrança da conta. Exige o escopo billing:read.

Um pedido precisa de dados de cobrança completos. Verifique `complete` antes de criar um.

### Resposta

`response` é `null` até que os dados de cobrança sejam salvos. A resposta nunca é armazenada em cache.

**response** `object | null`

**Mostrar objeto**

**name** `string | null`

O nome que aparece nos recibos e nas faturas.

**address** `object | null`

**Mostrar objeto**

**line1** `string`

Nome da rua.

**number** `string | null`

Número do endereço, ou `S/N`.

**line2** `string | null`

Complemento, por exemplo `Apt 2`.

**district** `string | null`

Bairro.

**city** `string`

Cidade.

**city\_code** `string | null`

Código IBGE de sete dígitos da cidade.

**state** `string | null`

Sigla do estado com duas letras, no Brasil.

**postal\_code** `string | null`

CEP, no Brasil.

**country** `string`

Código ISO do país com duas letras.

**phone** `string | null`

Número de telefone opcional, no formato E.164.

**tax\_id** `object | null`

**Mostrar objeto**

**type** `string`

`cpf` ou `cnpj`.

**masked** `string`

O documento, mascarado. O número completo nunca é retornado.

**complete** `boolean`

`true` quando os dados são suficientes para criar um pedido (no Brasil, incluindo o CPF/CNPJ).

```json Response theme={null}
{
  "response": {
    "name": "Ana Souza",
    "address": {
      "line1": "Rua das Flores",
      "number": "120",
      "line2": null,
      "district": "Centro",
      "city": "Fortaleza",
      "city_code": "2304400",
      "state": "CE",
      "postal_code": "60000000",
      "country": "BR"
    },
    "phone": "+5585999990000",
    "tax_id": { "type": "cpf", "masked": "CPF ••• 47" },
    "complete": true
  }
}
```

### Respostas de erro

**code** `string`

O código de erro que indica o motivo da falha. Valores possíveis:

* `AUTH_TOKEN_MISSING`, `API_KEY_INVALID`, `SESSION_REVOKED`: o header `Authorization` está ausente, a chave de API é inválida ou a sessão do painel foi revogada (`401`).
* `API_KEY_IP_DENIED`, `API_KEY_SCOPE_DENIED`: a chave de API é usada a partir de um IP fora da sua allowlist, ou não tem o escopo que a rota exige (`403`).
* `USER_NOT_FOUND`: o usuário autenticado não foi encontrado.
* `INTERNAL_SERVER_ERROR`: ocorreu um erro inesperado no servidor.

```json Error Response (401) theme={null}
{
  "code": "AUTH_TOKEN_MISSING"
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.