API atual/Referência completa/Dados da loja: CEP, CNPJ, moedas e planos

Planos para sellers

Lista os planos de assinatura que um novo seller pode contratar.

Uma rota única e pública para a página de cadastro de sellers. A contratação do plano acontece no cadastro do seller, que não faz parte desta seção.

Em um marketplace, os sellers (lojistas) pagam à plataforma por um plano: mensalidade, comissão sobre vendas e limites. Esta rota lista os planos ativos, para montar a página "Seja um vendedor". É pública.

GET/api/v1/storefront/vendor-plansPública

Planos de assinatura que um seller pode contratar

Parâmetros de consulta

lang_codestringpadrão: pt-BR

Idioma do nome e da descrição dos planos (pt-BR, en...).

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/storefront/vendor-plans?lang_code=pt-BR"

Resposta

200Planos

json

{
  "plans": [
    {
      "id": 6,
      "status": "A",
      "position": 0,
      "is_default": false,
      "price_cents": 7770,
      "periodicity": "month",
      "commission_bps": 1000,
      "fixed_commission_cents": 0,
      "products_limit": 0,
      "revenue_limit_cents": 1234567,
      "vendor_store": false,
      "categories": "",
      "include_shipping": false,
      "include_taxes": false,
      "price_on_request": false,
      "ministore_enabled": false,
      "ministore_whatsapp_payment": false,
      "ministore_pix_auto": false,
      "ministore_orders_included": 0,
      "ministore_excess_per_order_cents": 0,
      "ministore_excess_percentage_bps": 0,
      "created_at": "2026-07-11T18:37:36Z",
      "updated_at": "2026-07-20T14:55:59Z",
      "descriptions": [
        {
          "plan_id": 6,
          "lang_code": "pt-BR",
          "name": "Plano Essencial",
          "description": "Para começar a vender."
        }
      ],
      "vendors_count": 0
    }
  ],
  "total": 1
}

Campos da resposta

totalinteger

Quantidade de planos.

plansarray

Planos ativos, por posição.

idinteger

Id numérico do plano.

statusstring

Sempre A (ativo) aqui.

positioninteger

Ordem de exibição.

is_defaultboolean

Plano pré-selecionado no cadastro.

price_centsinteger

Preço por período, em centavos.

periodicitystring

monthyearonetime

Periodicidade do preço.

commission_bpsinteger

Comissão sobre as vendas, em pontos-base (1000 = 10%).

fixed_commission_centsinteger

Comissão fixa por pedido, em centavos.

products_limitinteger

Máximo de produtos. 0 = ilimitado.

revenue_limit_centsinteger

Teto de faturamento, em centavos. 0 = ilimitado.

vendor_storeboolean

O seller pode ter página de loja própria.

categoriesstring

Ids de categorias permitidas, separados por vírgula. Vazio = todas.

include_shipping, include_taxesboolean

Se frete e impostos entram na base de cálculo da comissão.

price_on_requestboolean

Plano "sob consulta": não exiba price_cents.

ministore_*mixed

Recursos da mini-loja do seller (venda por WhatsApp): ministore_enabled, ministore_whatsapp_payment, ministore_pix_auto, ministore_search_*, ministore_dashboard_*, ministore_cart_recovery, ministore_crm, ministore_human_transfer, ministore_integrations (booleanos), ministore_orders_included (0 = ilimitado), ministore_excess_per_order_cents e ministore_excess_percentage_bps (excedente por pedido, em centavos e em pontos-base).

descriptionsarray

Nome e descrição no idioma pedido (plan_id, lang_code, name, description). null se o plano não tem texto nesse idioma.

vendors_countinteger

Não é preenchido nesta rota (vem 0). Ignore.

created_at, updated_atstring

Datas (RFC 3339).

Erros

Status	Quando	Corpo de exemplo
500	Falha ao ler os planos.	`{"error":"failed to list plans","detail":"..."}`

Veja também