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

> ## Agent Instructions
> Documentação das APIs da DeliveryVip, em português. Regras que mais quebram integrações: (1) Merchant API: faça polling em GET /merchant/v3/events:polling no máximo a cada 30 s por token; confirme todo evento recebido com POST /merchant/v3/events/acknowledgment e corpo [{"id": "<eventId>"}] (o campo lido é id, não eventId), inclusive eventos repetidos ou que o sistema não trata; deduplique por eventId; o evento é só um aviso, busque o pedido na orderURL. (2) Tokens client_credentials valem 24 h e não têm refresh_token: peça outro ao receber 401. (3) Webhooks: valide a assinatura HMAC sobre o corpo bruto e responda 2xx rápido; o polling é a reconciliação. (4) Open Delivery: host od.deliveryvip.com.br, um client_secret por loja, datas em UTC. (5) Fidelidade: o operador implementa 5 rotas assinadas com HMAC e chama o config push; o estorno precisa ser idempotente. (6) Partner API: scope dv.partner. Não invente endpoints: use a referência gerada das specs OpenAPI.

# Definições de planos

> Campos do plano de cobrança, plano padrão, visibilidade, status e tipos de recurso.

O plano é o mesmo objeto em [Listar planos](/docs/guides/partner/plans/utilizando-a-api/listar-planos.md) e [Obter detalhes do plano](/docs/guides/partner/plans/utilizando-a-api/obter-detalhes-do-plano.md).

## Objeto

**id** `uuid`

ID do plano. É o `planId` usado nas assinaturas.

**name** `string`

Nome do plano.

**standard** `boolean`

Se é o plano padrão do parceiro. Veja [standard](#standard).

**code** `string`

Código do plano.

**status** `string`

`DRAFT`, `AVAILABLE` ou `UNAVAILABLE`. Veja [status](#status).

**visibility** `string`

`PUBLIC`, `RESALE` ou `DIRECT_MERCHANT`. Veja [visibility](#visibility).

**features** `object[]`

Recursos que fazem parte do plano.

**propriedades**

**featureType** `string`

Tipo do recurso. Veja [Tipos de recurso](#tipos-de-recurso).

**inclusionType** `string`

`INCLUDED` (incluso no preço do plano) ou `ADDITIONAL` (cobrado à parte).

### standard

Quando `true`, o plano é o **plano padrão do parceiro**:

* toda loja nova é criada nesse plano;
* cada parceiro tem no máximo um plano padrão, e ele precisa estar disponível.

### status

| status | Uso em assinaturas |
| - | - |
| `AVAILABLE` | Pode ser usado. |
| `DRAFT` | Em edição. Recusado. |
| `UNAVAILABLE` | Desativado para novas assinaturas. Recusado. |

### visibility

| Visibility | Quem pode usar |
| - | - |
| `PUBLIC` | Lojas das suas revendas **e** lojas atendidas diretamente por você. |
| `RESALE` | **Somente** lojas das suas revendas. |
| `DIRECT_MERCHANT` | **Apenas** lojas atendidas diretamente; não fica visível às revendas. |

Ao ativar ou atualizar uma assinatura, um plano com visibilidade incompatível com a loja é recusado. Um token de revenda só enxerga os planos `PUBLIC` e `RESALE` do parceiro.

### Tipos de recurso

| Código do Recurso | Descrição | Uso típico |
| - | - | - |
| `DELIVERY_TAKEOUT` | Ativa a **loja própria online**: catálogo, checkout, entrega e retirada. | Pedidos diretos, sem marketplace. |
| `DELIVERYBOT_NOTIFICATION` | **Notificações automáticas via WhatsApp** a cada mudança de status do pedido. | Manter o cliente informado. |
| `DELIVERYBOT_ASSISTANT` | **Assistente virtual por IA** no WhatsApp para pré-atendimento. | Reduzir o suporte humano. |
| `INDOOR_VIEWER` | Cardápio por **QR Code** só para visualização. | Consulta de cardápio em mesas e balcões. |
| `INDOOR_QRCODE` | Cardápio por **QR Code com pedido** pelo celular do cliente. | Autoatendimento na mesa. |
| `INDOOR_TABLET` | **Autoatendimento em tablets** nas mesas ou totens. | Tablets fixos para pedidos. |
| `DOMAIN_CUSTOM` | **Domínio personalizado** (ex.: `pedidos.minhaloja.com`). | Marca própria e SEO. |
| `SALES_REVENUE` | **Cobrança variável sobre faturamento**. | Preço baseado em receita. |
| `ORDERS_COUNT` | **Cobrança variável por número de pedidos**. | Franquia de pedidos ou pay-as-you-go. |
| `MULTI_STORE` | Operação em **estrutura multiloja** (rede compartilhando domínio ou app). | Franquias e grupos. |
| `GROWTH_DISCOUNT` | Módulo de **descontos**. | Campanhas de desconto. |
| `INTEGRATION_MARKETING` | **Integrações de marketing**. | Ferramentas de marketing de terceiros. |
| `INTEGRATION_LOGISTIC` | **Integrações de logística**. | Operadores logísticos de terceiros. |

Quando `inclusionType` é `ADDITIONAL`, o recurso não está no preço do plano e é cobrado à parte. Para habilitá-lo, [contrate o recurso](/docs/guides/partner/merchant/utilizando-a-api/gerenciar-recursos-dos-merchants.md) na loja.


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