> ## 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 status do pedido

> Retorna o status atual de um único pedido.

**orderId** `string` *required*

O ID do pedido.

### Resposta

**response** `object`

**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 aplicado qualquer desconto de cupom.

**expires\_at** `string | null`

Quando o pedido não pago expira, em ISO 8601 (72 horas após a criação do pedido). `null` quando
o pedido não tem expiração.

**allowed\_payment\_methods** `string[]`

Métodos de pagamento aceitos pelo pedido (`pix`, `card`). O plano Economy retorna `["pix"]`.

**related\_to** `object`

O plano ao qual o pedido se aplica.

**Mostrar objeto**

**plan** `object`

**Mostrar objeto**

**name** `string`

O nome do plano.

**months** `integer`

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

```json Response theme={null}
{
  "response": {
    "id": "order-abc123",
    "status": "unpaid",
    "price": 24.9,
    "expires_at": "2026-10-16T12:00:00.000Z",
    "allowed_payment_methods": ["pix"],
    "related_to": { "plan": { "name": "PRO", "months": 1 } }
  }
}
```

### 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 cabeçalho `Authorization` não foi enviado, a chave de API é inválida ou a sessão do dashboard foi revogada (`401`).
* `API_KEY_IP_DENIED`, `API_KEY_SCOPE_DENIED`: a chave de API foi usada a partir de um IP fora da sua lista de permissões, ou não tem o escopo que a rota exige (`403`).
* `USER_NOT_FOUND`: o usuário autenticado não foi encontrado.
* `ORDER_NOT_FOUND`: o pedido informado não existe.
* `FORBIDDEN`: o pedido não pertence ao usuário autenticado.
* `INTERNAL_SERVER_ERROR`: ocorreu um erro inesperado no servidor.

```json Error Response (404) theme={null}
{
  "code": "ORDER_NOT_FOUND"
}
```

```json Error Response (403) theme={null}
{
  "code": "FORBIDDEN"
}
```


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