Saltar para o conteúdo

Ferramentas · Vendas e planos

Ferramentas MCP para vender: listar planos, produtos e cupons, criar opções de cobrança e planos com adicionais em rascunho, publicar e despublicar, mudar preços, criar, editar e excluir cupons e ofertas de downsell, excluir produtos e planos e reordenar os planos, com confirmação no que mexe em dinheiro.

O que a comunidade vende: planos com as opções de cobrança e os adicionais, produtos avulsos, cupons. Tudo nasce em rascunho e só vai à venda quando você pede; mudar um preço, criar ou editar um cupom, criar ou editar uma oferta de última chance e excluir pedem o seu sim, com um resumo dos valores. Mudar um plano (update_plan) roda na primeira chamada.

Rascunho antes da aprovação

Dá para montar tudo antes de a informação comercial ser aprovada: produtos, opções, planos, adicionais, cupons e ofertas de downsell nascem em rascunho e podem ser editados à vontade. O que espera a aprovação é publicar e vender:

  • publish_product numa comunidade sem aprovação é recusado com a mensagem da Memberfy: "Para publicar e começar a vender, a comunidade precisa ter as informações comerciais aprovadas. Enquanto isso, você pode criar e configurar tudo como rascunho: preencha em Configurações › Informação Comercial e envie para análise."
  • Nas compostas (create_course, create_event e create_plan com publicar), a recusa não desfaz nada: o curso, o evento, o ingresso, o plano e as opções ficam em rascunho, a resposta traz o motivo em publish_blocked, e o próximo passo sugerido é preencher a informação comercial e depois publicar com publish_product.
  • O preço de um rascunho fica na moeda do país da informação comercial (em qualquer status) ou, sem ela, em reais. Se a moeda aprovada for outra, a publicação é recusada ("Este produto está em … mas a moeda das informações comerciais aprovadas é …"): ajuste a moeda e o preço antes.

Cada ferramenta traz um selo: Só consulta não muda nada, Altera cria ou muda algo na hora, e Pede confirmação só age depois do seu sim a um resumo. Ver Dinheiro e confirmação.

Em resumo

FerramentaO que fazPapel mínimoTipo
list_plansPlanos, opções e adicionaisAdministrador ou financeiroSó consulta
list_productsOpções de cobrança e produtos, com preço e statusAdministrador ou financeiroSó consulta
list_couponsCupons com status e usoAdministrador ou financeiroSó consulta
create_productCria um produto ou opção de cobrança, em rascunhoAdministradorAltera
create_planOpções, plano e adicionais, de uma vezAdministradorAltera
publish_productPõe um produto à vendaAdministradorAltera
unpublish_productTira um produto da vendaAdministradorAltera
update_priceMuda um preço, com confirmaçãoAdministradorPede confirmação
create_couponCria um cupom, com confirmaçãoAdministradorPede confirmação
update_planMuda nome, endereço, opções e adicionais de um planoAdministradorAltera
update_productMuda título, espaços, estoque, parcelas, teste e link diretoAdministradorAltera
update_coupon_statusPausa ou reativa um cupomAdministradorPede confirmação
update_couponMuda nome, desconto, duração, limites, validade e produtos de um cupomAdministradorPede confirmação
delete_couponExclui um cupomAdministradorPede confirmação
get_coupon_usageQuem usou um cupomAdministrador ou financeiroSó consulta
list_downsell_offersAs ofertas de última chance de um plano, com conversãoAdministradorSó consulta
create_downsell_offerCria uma oferta de última chanceAdministradorPede confirmação
update_downsell_offerMuda ou pausa uma oferta de última chanceAdministradorPede confirmação
delete_downsell_offerExclui uma oferta de última chanceAdministradorPede confirmação
delete_productExclui um produto ou opção de cobrançaAdministradorPede confirmação
delete_planExclui um planoAdministradorPede confirmação
reorder_plansPõe os planos numa nova ordem na página de preçosAdministradorAltera
get_storefrontO que um espaço de Loja mostraAdministradorSó consulta
update_storefrontEscolhe os produtos de uma LojaAdministradorAltera

list_plans

Só consulta

Listar planos. Os planos da comunidade, com as opções de cobrança e os adicionais de cada um. Papel mínimo: administrador ou financeiro.

Parâmetros: nenhum.

Devolve: os planos (id, nome, endereço), as opções de cada um (id, título, preço, intervalo, status) e os adicionais.

Peça assim: "Quais planos temos, e quanto custa cada opção?"

list_products

Só consulta

Listar opções de cobrança e produtos. Todos os produtos: opções de assinatura, avulsos, parcelados e adicionais. Papel mínimo: administrador ou financeiro.

Parâmetros: nenhum.

Devolve: cada produto com id, título, tipo, preço, intervalo, status (rascunho ou publicado) e os espaços que libera. O id é o que create_plan (em add_on_ids), update_price, publish_product e create_coupon pedem.

Peça assim: "Quais produtos estão em rascunho?"

list_coupons

Só consulta

Listar cupons. Os cupons, com status e uso. Papel mínimo: administrador ou financeiro.

ParâmetroTipoObrigatórioDescrição
statusACTIVE, INACTIVE, EXPIREDNãoSó um status
searchtextoNãoParte do código ou do nome
page, limitnúmeroNãoPaginação

Devolve: os cupons, com código, tipo, valor, duração, validade, limite e usos.

Peça assim: "Quais cupons estão ativos e quantas vezes cada um foi usado?"

create_product

Altera

Criar opção de cobrança ou produto. Cria um produto em rascunho: uma opção de assinatura, um avulso (ingresso, curso) ou um parcelado. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
titletexto, de 3 a 255Sim
typeSUBSCRIPTION, ONE_TIME, INSTALLMENTSimOpção de assinatura, avulso ou parcelado
pricenúmero, na moeda da comunidadeSimNa assinatura, o valor de cada ciclo; no anual parcelado, o valor do ano
intervalMONTHLY, YEARLYNãoSó em SUBSCRIPTION: mensal ou anual
max_installments1 a 12NãoAté quantas vezes no cartão (avulso, ou anual)
commitment_months1 a 36NãoDuração do contrato; só no mensal
trial_days0 a 365NãoTeste grátis
descriptiontexto simples, até 5.000NãoSem formatação: marcas de Markdown são tiradas
space_idslista de idsNãoOs espaços que a compra libera
stocknúmeroNãoQuantidade à venda (ingressos). Vazio: sem limite
direct_linksim ou nãoNãoUm avulso vendável por link direto, fora da Loja

Devolve: o produto criado, em rascunho, com o id.

Peça assim: "Crie o produto Mentoria avulsa, R$ 450, em até 3×, que libera o espaço Mentorias. Deixe em rascunho."

Notas: nada é vendido até publish_product, e criar não depende da informação comercial aprovada (ver Rascunho antes da aprovação). Para um plano com várias opções, create_plan faz tudo de uma vez. As regras de cada campo são as do painel: ver Produtos e Opções de cobrança.

create_plan

Altera

Criar plano com opções e adicionais. Opções de cobrança → plano com as opções → adicionais ligados. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
nametexto, até 120SimO nome do plano
descriptiontexto simplesNãoSem formatação: marcas de Markdown são tiradas
slugtexto, até 60NãoO endereço do plano, para o link /pricing/<endereço>
optionslista, de 1 a 6SimAs opções de cobrança (veja abaixo)
add_on_idslista de idsNãoProdutos mensais que já existem e não são opção de plano, de list_products
publishsim ou nãoNãoPublica todas as opções. Padrão: rascunho
idempotency_keytexto, até 100Não

Cada opção:

CampoTipoDescrição
titletexto, de 3 a 255Obrigatório. Ex.: Mentoria · Mensal
pricenúmero, na moeda da comunidadeObrigatório. No anual, o valor do ano
intervalMONTHLY, YEARLYPadrão: MONTHLY
max_installments1 a 12No anual, até quantas vezes no cartão
commitment_months1 a 36Contrato mínimo, no mensal
trial_days0 a 365Teste grátis
descriptiontexto simplesSem formatação: marcas de Markdown são tiradas
space_idslista de idsOs espaços que a opção libera

Devolve: o plano (id, nome, endereço), as opções (id, título, preço, intervalo, status) e os adicionais ligados.

Peça assim: "Crie o plano Mentoria com mensal de R$ 390 com contrato de 6 meses e anual de R$ 3.900 em até 12×, os dois liberando o espaço Mentoria, e ligue a Sessão individual como adicional."

Notas: se um passo falha, o plano é desfeito por último, porque a Memberfy não apaga um plano que ainda tem opções. Ver Planos, Adicionais e Anual parcelado.

publish_product

Altera

Publicar produto (pôr à venda). Põe à venda um produto em rascunho. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
product_ididSimDe list_products ou de uma criação

Devolve: o produto, publicado.

Peça assim: "Pode publicar o produto Excel do Zero."

Notas: publicar exige a informação comercial aprovada, e o produto na moeda do país aprovado. Sem isso, a Memberfy recusa e o produto continua em rascunho, editável. Ver Rascunho antes da aprovação.

unpublish_product

Altera

Tirar produto da venda. Tira um produto da venda. Quem já comprou continua com o acesso. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
product_ididSim

Devolve: o produto, fora da venda.

Peça assim: "Tire o ingresso do encontro de outubro da venda."

update_price

Pede confirmação

Alterar preço de um produto. Muda o preço de um produto ou de uma opção de cobrança. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
product_ididSimDe list_products
new_pricenúmero, em reaisSim

O resumo: o produto, o preço atual, o preço novo e o status (rascunho ou publicado).

Peça assim: "Aumente o Growth Mensal de R$ 129 para R$ 149."

Notas: assinaturas que já existem seguem as regras da Memberfy para mudança de preço, as mesmas da edição pelo painel. Ver Opções de cobrança.

create_coupon

Pede confirmação

Criar cupom. Cria um cupom de desconto, percentual ou de valor fixo, para todos os produtos ou só para alguns. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
codetexto, de 2 a 50SimEx.: PRO20. Fica em maiúsculas
nametexto, até 120SimO nome interno
typePERCENTAGE, FIXEDSimPercentual ou valor fixo
valuenúmeroSim20 = 20%, ou o valor em reais
durationONCE, FOREVER, REPEATINGNãoEm assinaturas: só a 1ª cobrança (padrão), sempre, ou por alguns meses
months1 a 36NãoCom REPEATING
max_usesnúmeroNãoVazio: sem limite
start_datedata ISO 8601NãoPadrão: agora
end_datedata ISO 8601NãoVazio: sem fim
product_idslista de idsNãoSó estes produtos. Vazio: todos

O resumo: a ação, o código, o desconto (20% ou R$ 50,00), a duração, o limite de usos, a validade e os produtos.

Peça assim: "Crie o cupom BLACK30, 30% só na primeira cobrança, para os planos Growth, até 100 usos, válido até 30/11."

Ver Cupons.

update_plan

Altera

Editar plano. Muda nome, descrição, endereço, se está ativo, as opções de cobrança e os adicionais de um plano. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
planid ou link (/pricing/…)Sim
name, description, slugtextoNão
activesim ou nãoNão
option_idslista de idsNãoA lista inteira de opções do plano
add_on_idslista de idsNãoA lista inteira de adicionais

Peça assim: "Tire o anual do plano Growth e deixe só o mensal."

Notas: muda o que se vende na hora, sem confirmação. Preço se muda com update_price, que pede o seu sim.

update_product

Altera

Editar produto. Muda título, descrições, espaços que libera, estoque, parcelas, teste grátis ou link direto. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
productid ou slugSim
title, description, short_descriptiontextoNão
space_idslista de idsNãoOs espaços que a compra libera
stocknúmeroNão
max_installmentsnúmeroNão
trial_daysnúmeroNão
direct_linksim ou nãoNão

Peça assim: "Aumente o estoque do ingresso para 120."

Notas: o preço é com update_price, que pede confirmação.

update_coupon_status

Pede confirmação

Pausar ou reativar cupom. Pausa ou reativa um cupom. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
couponid ou códigoSim
statusACTIVE, INACTIVESimReativar ou pausar

Peça assim: "Pause o cupom BLACK30."

update_coupon

Pede confirmação

Editar cupom. Muda um cupom que já existe. Só o que for enviado muda; pausar é com update_coupon_status. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
couponid ou códigoSim
name, descriptiontextoNão
valuenúmeroNãoPorcentagem (20 = 20%) ou valor, conforme o tipo do cupom
durationONCE, FOREVER, REPEATINGNãoUma vez, para sempre ou por alguns meses
months1 a 36NãoCom REPEATING
max_uses, max_uses_per_personnúmeroNãoLimites de uso
start_date, end_datedataNãoA validade
product_idslista de idsNãoOs produtos em que o cupom vale

Devolve: na primeira chamada, o código e o que muda, e o código de confirmação.

Peça assim: "Aumente o BLACK30 para 40% e estenda até domingo."

Ver Cupons.

delete_coupon

Pede confirmação

Excluir cupom. Os descontos já dados continuam valendo. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
couponid ou códigoSim

Devolve: na primeira chamada, o código e quantas vezes foi usado, e o código de confirmação.

get_coupon_usage

Só consulta

Ver uso de um cupom. Quem usou, quando e quanto de desconto. Papel mínimo: administrador ou financeiro.

ParâmetroTipoObrigatórioDescrição
couponid ou códigoSim
pagenúmeroNão

Peça assim: "Quem usou o cupom BLACK30?"

list_downsell_offers

Só consulta

Ofertas de downsell de um plano. As ofertas de desconto em adicionais depois da compra de um plano, com quantas vezes foram mostradas e convertidas. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
planid ou linkSim

Peça assim: "Quanto a oferta de última chance da Extensão Coworking converte?"

create_downsell_offer

Pede confirmação

Criar oferta de downsell. Cria uma oferta de desconto num adicional, mostrada depois do pagamento do plano. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
planid ou linkSim
add_on_ididSimO adicional do plano
discount_percentnúmeroNão
timingIMMEDIATE, DELAYEDNãoNa hora (padrão) ou depois de um tempo
delay_minutesnúmeroNãoCom DELAYED
price_durationFOREVER, FIRST_CHARGE, CYCLESNãoDesconto para sempre, só na primeira cobrança ou por alguns ciclos
cyclesnúmeroNãoCom CYCLES
ttl_minutesnúmeroNãoPor quanto tempo a oferta vale

Peça assim: "Ofereça 30% na Extensão Coworking para quem assinar o Growth sem ela, nas 3 primeiras cobranças."

Ver Downsell.

update_downsell_offer

Pede confirmação

Editar oferta de downsell. Muda uma oferta de última chance de um plano, ou a pausa. Só o que for enviado muda. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
planid ou linkSim
offer_ididSimDe list_downsell_offers
discount_percent, timing, delay_minutes, price_duration, cycles, ttl_minutesNãoOs mesmos de create_downsell_offer
activesim ou nãoNãoCom não, pausa a oferta

Peça assim: "Pause a oferta da Extensão Coworking até o fim do mês."

delete_downsell_offer

Pede confirmação

Excluir oferta de downsell. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
planid ou linkSim
offer_ididSimDe list_downsell_offers

delete_product

Pede confirmação

Excluir produto. Exclui um produto ou uma opção de cobrança. Quem comprou continua com o acesso. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
productid ou slugSimDe list_products

Devolve: na primeira chamada, o título, o preço e o status, e o código de confirmação.

Notas: para só parar de vender, prefira unpublish_product. Ver Produtos.

delete_plan

Pede confirmação

Excluir plano. Quem já assina não é cancelado. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
planid ou link (/pricing/…)Sim

Devolve: na primeira chamada, o nome do plano e as opções dele, e o código de confirmação.

reorder_plans

Altera

Reordenar planos. Põe os planos numa nova ordem na página de preços, do primeiro ao último. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
plan_idslista de idsSimDe list_plans, na ordem nova

Peça assim: "Na página de preços, ponha o Growth antes do Starter."

get_storefront

Só consulta

Ver loja. O que um espaço de Loja mostra: todos os produtos ou só os escolhidos. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
spaceid ou linkSimO espaço de Loja

update_storefront

Altera

Escolher produtos da loja. Define o que um espaço de Loja vende. Papel mínimo: administrador.

ParâmetroTipoObrigatórioDescrição
spaceid ou linkSim
modeall, selectedSimTodos os produtos publicados, ou só os escolhidos
product_idslista de idsNãoCom selected, de list_products

Peça assim: "Deixe na loja só os cursos avulsos."

Ver Loja.

Relacionados