API atual/Referência completa/Cupons, vales, pagamentos e NF-e

GETPlanos disponíveis

Lista os planos comerciais que o seller pode escolher.

O plano define quanto o seller paga, qual comissão a loja retém e quantos produtos ele pode ter. Esta rota alimenta a tela de escolha.

Planos disponíveis

Lista os planos comerciais com status A (ativo e visível), do menor para o maior position. Planos ocultos (H) ou desativados (D) não aparecem. Serve para montar a tela de escolha de plano; a troca em si é PUT /vendor/plan. Exige o módulo vendor-plans.

GET/api/v1/vendor/plans/availableSeller

Planos que o seller pode escolher

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso de um usuário seller (veja Tokens).

Parâmetros de consulta

lang_codestringpadrão: pt-BR

Idioma do nome e da descrição.

Exemplo de requisição

bash

curl "$BASE_URL/api/v1/vendor/plans/available?lang_code=pt-BR" \
  -H "Authorization: Bearer $TOKEN"

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,
      "include_shipping": false,
      "include_taxes": false,
      "price_on_request": false,
      "ministore_enabled": false,
      "created_at": "2026-07-11T18:37:36Z",
      "updated_at": "2026-07-11T18:37:36Z",
      "descriptions": [
        {
          "plan_id": 6,
          "lang_code": "pt-BR",
          "name": "Plano Pro",
          "description": "Sem limite de produtos"
        }
      ]
    }
  ],
  "total": 1
}

Campos da resposta

plansobject[]

Planos.

idinteger

Id do plano (inteiro).

statusstring

Sempre A aqui.

positioninteger

Ordem de exibição.

is_defaultboolean

Plano padrão de novos sellers.

price_centsinteger

Preço por período, em centavos.

periodicitystring

monthyearonetime

Período da cobrança.

commission_bpsinteger

Comissão da loja, em pontos-base (1000 = 10%).

fixed_commission_centsinteger

Comissão fixa por pedido, em centavos.

products_limitinteger

Máximo de produtos. 0 = sem limite.

revenue_limit_centsinteger

Teto de receita acumulada, em centavos. 0 = sem limite.

include_shippingboolean

Frete entra na base da comissão.

include_taxesboolean

Impostos entram na base da comissão.

price_on_requestboolean

Preço sob consulta.

ministore_*mixed

Recursos da mini-loja do plano (vários booleanos e três valores numéricos), como ministore_enabled.

descriptionsobject[]

Nome e descrição no idioma pedido: plan_id, lang_code, name, description. Omitido se não houver tradução.

created_atstring

Criação, RFC 3339.

updated_atstring

Última alteração, RFC 3339.

totalinteger

Quantidade de planos.

Erros

Status	Quando	Corpo de exemplo
401	Token ausente, inválido, expirado ou revogado.	`{"error":"missing authorization header"}`
403	O token não é de um usuário seller (por exemplo, é de administrador), ou o usuário não está vinculado a nenhum seller.	`{"error":"insufficient permissions"}`
403	O módulo `vendor-plans` está desligado nesta loja.	`{"error":"module_disabled","module":"vendor-plans"}`

Veja também

Visão geral