> ## 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.

# Listar pedidos

> Lista os pedidos do usuário autenticado (compras, renovações e upgrades de plano).

**provider** `string`

Filtra pelo meio de pagamento. Valores possíveis: `pix`, `card`, `redeem_code`.

### Resposta

**response** `array`

Um array de pedidos, do mais recente para o mais antigo.

**Mostrar objeto**

**id** `string`

O ID do pedido.

**status** `string`

Status do pedido. Valores possíveis: `unpaid`, `paid`, `cancelled`, `expired`.

**price** `number`

O preço final cobrado, depois de qualquer desconto de cupom.

**provider** `string`

Como o pedido foi ou será pago. Valores possíveis: `pix`, `card`, `redeem_code`.

**type** `string`

Para que serve o pedido. Valores possíveis: `purchase`, `renew`, `upgrade`.

**related\_to** `object`

O plano ao qual o pedido se aplica.

**Mostrar objeto**

**plan** `object`

**Mostrar objeto**

**name** `string`

O nome do plano.

**duration** `integer`

Duração em meses (1, 3 ou 12).

**months** `integer`

Duração em meses (mesmo valor de `duration`).

**created\_at** `string`

Quando o pedido foi criado.

**paid\_at** `string | null`

Quando o pedido foi pago, ou `null` se ainda não foi pago.

**has\_receipt** `boolean`

Se existe um recibo de pagamento para este pedido. Os recibos ficam disponíveis no histórico de cobrança do painel.

```json Response theme={null}
{
  "response": [
    {
      "id": "order-abc123",
      "status": "paid",
      "price": 24.9,
      "provider": "pix",
      "type": "purchase",
      "related_to": { "plan": { "name": "PRO", "duration": 1, "months": 1 } },
      "created_at": "2026-08-01T12:00:00.000Z",
      "paid_at": "2026-08-01T12:05:00.000Z",
      "has_receipt": 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.