Pular para o conteúdo

Ferramentas · Assinaturas

Ferramentas MCP para assinaturas: listar quem assina o quê, exportar o CSV, ver uma assinatura, cortesias, descontos, extensões e cancelamentos, com confirmação; e, para qualquer membro, as próprias assinaturas e compras, com cancelar, pausar, retomar, reativar e mudar de plano.

As assinaturas da comunidade, como em Membros › Assinaturas: quem assina, quanto paga, quem está em atraso, e as ações da equipe sobre cada assinatura, sempre com a sua confirmação. E o lado de quem assina: qualquer membro vê as próprias assinaturas e compras, cuida da própria assinatura e muda de plano pela conversa.

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_subscriptionsAssinaturas com status, valor e próxima cobrançaAdministrador ou financeiroSó consulta
cancel_subscriptionCancela a assinatura de um membro, com confirmaçãoAdministrador ou financeiroPede confirmação
get_subscriptionUma assinatura, com cobranças e próxima cobrançaAdministrador ou financeiroSó consulta
create_manual_subscriptionCortesia ou cobrança futura, sem checkoutAdministrador ou financeiroPede confirmação
update_subscriptionDesconto, estender, adicionais, reativar, link de pagamentoAdministrador ou financeiroPede confirmação
export_subscriptions_csvAs assinaturas em CSV, com os mesmos filtrosAdministrador ou financeiroSó consulta
list_my_subscriptionsAs suas assinaturasQualquerSó consulta
list_my_purchasesAs suas compras avulsasQualquerSó consulta
manage_my_subscriptionCancela, pausa, retoma ou reativa a sua assinaturaQualquerPede confirmação
quote_plan_changeQuanto custa e o que muda ao passar para outro planoQualquer, na própria assinaturaSó consulta
change_my_planMuda o seu plano, agora ou no fim do períodoQualquer, na própria assinaturaPede confirmação
get_scheduled_plan_changeA mudança de plano agendadaQualquerSó consulta
cancel_scheduled_plan_changeDesfaz a mudança agendadaQualquer, na própria assinaturaPede confirmação

list_subscriptions

Só consulta

Listar assinaturas. As assinaturas, como em Membros › Assinaturas. Papel mínimo: administrador ou financeiro.

ParâmetroTipoObrigatórioDescrição
statusACTIVE, TRIALING, PAST_DUE, PAUSED, CANCELING, CANCELED, EXPIRED, COMPLIMENTARYNãoSó um status
plan_ididNãoSó um plano
option_ididNãoSó uma opção de cobrança
from, todata ISO 8601NãoData de início da assinatura
searchtextoNãoNome ou e-mail do membro
page, limitnúmeroNãoPaginação

Devolve: cada assinatura com id (que cancel_subscription pede), membro, plano, opção, status, valor, desconto, adicionais, forma de pagamento e próxima cobrança.

Peça assim: "Quem está com a assinatura em atraso?" · "Quantos assinantes o plano Growth tem?"

cancel_subscription

Pede confirmação

Cancelar assinatura de um membro. Cancela a assinatura de um membro, no fim do período pago (o padrão) ou agora. Papel mínimo: administrador ou financeiro.

ParâmetroTipoObrigatórioDescrição
subscription_ididSimDe list_subscriptions
immediatesim ou nãoNãoPadrão: não (cancela no fim do período pago)
reasontexto, até 500NãoFica na linha do tempo da assinatura

O resumo: a ação (Cancelar no fim do período pago ou Cancelar a assinatura agora), o membro, o plano, a opção, o status, o valor e o fim do período.

Peça assim: "Cancele a assinatura da Ana Souza no fim do período, motivo: pediu por e-mail."

Notas: a ação aparece na linha do tempo da assinatura, em Gestão de assinaturas, como feita por você. Nada já pago é estornado.

get_subscription

Só consulta

Ver assinatura. Uma assinatura com membro, plano, valor, adicionais, cobranças e próxima cobrança. Papel mínimo: financeiro.

ParâmetroTipoObrigatórioDescrição
subscriptionid ou link (/billing?subscription=…)Sim

Peça assim: "Mostre a assinatura da Ana: quanto paga e quando é a próxima cobrança."

create_manual_subscription

Pede confirmação

Criar assinatura manual. Dá uma assinatura a um membro sem passar pelo checkout: cortesia ou cobrança a partir de uma data. Papel mínimo: proprietário, administrador ou financeiro.

ParâmetroTipoObrigatórioDescrição
memberid de perfilSimDe list_members
option_ididSimA opção de cobrança, de list_products
modeCOMPLIMENTARY, FUTURE_CHARGESimCortesia, sem cobrança, ou cobrança futura
complimentary_untildata ISO 8601NãoO fim da cortesia; vazio, sem fim
charge_starts_atdata ISO 8601NãoCom FUTURE_CHARGE
payment_methodPIX, BOLETO, CREDIT_CARDNãoCom FUTURE_CHARGE
notetextoNãoFica na linha do tempo

Peça assim: "Dê ao palestrante Bruno o plano Growth de cortesia até 31/12."

Notas: fica na auditoria de assinaturas. Ver Gestão de assinaturas.

update_subscription

Pede confirmação

Mudar uma assinatura. As ações da equipe numa assinatura. Papel mínimo: proprietário, administrador ou financeiro.

ParâmetroTipoObrigatórioDescrição
subscriptionid ou linkSim
actiondiscount, remove_discount, extend, add_add_on, remove_add_on, reactivate, send_payment_linkSim
percentnúmeroNãoPara discount
untildata ISO 8601NãoO fim do desconto, ou até quando estender
daysnúmero, de 1 a 3.650NãoPara extend
add_on_ididNãoO adicional (para incluir) ou a assinatura do adicional (para remover)

Peça assim: "Dê 20% de desconto na assinatura da Ana até o fim do ano." · "Mande para o Bruno o link de pagamento."

Notas: todas as ações pedem o seu sim e ficam na auditoria. Incluir um adicional ou estender não cobra agora. Para cancelar, use cancel_subscription.

export_subscriptions_csv

Só consulta

Exportar assinaturas (CSV). O mesmo arquivo do botão Exportar CSV de Membros › Assinaturas. Papel mínimo: administrador ou financeiro.

ParâmetroTipoObrigatórioDescrição
statusum dos statusNão
plan_id, option_ididNão
from, todata ISO 8601NãoData de início da assinatura

Devolve: quantas linhas e o conteúdo do CSV. Um arquivo muito grande vem cortado, com o aviso truncated; use os filtros.

Peça assim: "Exporte as assinaturas ativas do Growth para eu mandar ao financeiro."

list_my_subscriptions

Só consulta

Minhas assinaturas. As suas próprias assinaturas na comunidade: plano, opção, status, valor e próxima cobrança. Papel mínimo: qualquer.

Parâmetros: nenhum.

Peça assim: "Quando vence a minha próxima mensalidade?"

list_my_purchases

Só consulta

Minhas compras. As suas compras avulsas na comunidade (ingressos, cursos, produtos) e o status de cada uma. Papel mínimo: qualquer.

Parâmetros: nenhum.

manage_my_subscription

Pede confirmação

Gerenciar minha assinatura. Cancela, pausa, retoma ou reativa a sua própria assinatura, como no Faturamento. Papel mínimo: qualquer, na própria assinatura.

ParâmetroTipoObrigatórioDescrição
subscription_ididSimDe list_my_subscriptions
actioncancel, pause, resume, reactivateSimReativar só antes de o período acabar
immediatelysim ou nãoNãoSó em cancel: encerra agora em vez de no fim do período
reasontexto, até 500NãoSó em cancel

Devolve: na primeira chamada, a opção, o status, o valor e o que vai acontecer, e o código de confirmação.

Peça assim: "Cancele a minha assinatura no fim do período."

Notas: muda o que você paga, por isso pede o seu sim. Ver Cancelamento. Para passar para outro plano ou outra opção de cobrança, use quote_plan_change e change_my_plan.

Mudar o seu plano

As quatro ferramentas abaixo fazem pela conversa o que Faturamento › Mudar de plano faz na tela, com as mesmas regras. Ver Mudar de plano. Só quem assina muda o próprio plano: a equipe não tem ferramenta para trocar o plano de um membro.

O plano de destino pode ser dito de três jeitos, no parâmetro target:

JeitoExemplo
O nome do plano e a periodicidade"o Growth anual" (target: "Growth", billing: "YEARLY")
O link copiado da página de preços…/pricing/growth/anual
O id da opçãoquando você já o tem (a equipe acha em list_plans)

Se o plano tem mais de uma opção e o pedido não diz qual, o assistente pergunta, listando as opções.

O prompt Trocar meu plano (change_plan) conduz a conversa inteira: compara os planos, mostra quanto custa e só troca depois do seu sim.

quote_plan_change

Só consulta

Simular mudança de plano. O que acontece se você passar para outra opção, sem mudar nada. Papel mínimo: qualquer, na própria assinatura.

ParâmetroTipoObrigatórioDescrição
targetid, link da página de preços ou nome do planoSimA opção para onde ir
billingMONTHLY, YEARLY, ou o nome da opçãoNãoQual opção do plano, quando ele tem mais de uma
subscription_ididNãoDe list_my_subscriptions. Padrão: a sua assinatura de plano nesta comunidade
immediatesim ou nãoNãoSó para uma opção mais cara. Padrão: sim (vale agora); não deixa para o fim do período

Devolve: se a mudança vale agora ou fica agendada (e por quê), quanto é cobrado agora e em até quantas parcelas, a próxima cobrança e o total, o que acontece com cada extensão, o contrato, se o cupom deixa de valer e se substitui uma mudança já agendada.

Peça assim: "Quanto custa passar para o Growth anual?"

change_my_plan

Pede confirmação

Mudar meu plano. Passa a sua assinatura para outra opção. Uma opção mais cara, na mesma periodicidade, vale agora e cobra na hora a diferença proporcional no seu cartão padrão; uma mais barata, de mesmo valor, de outra periodicidade ou que deixaria uma extensão de fora fica para o fim do período. Papel mínimo: qualquer, na própria assinatura.

ParâmetroTipoObrigatórioDescrição
target, billing, subscription_id, immediateOs mesmos de quote_plan_change
installmentsnúmero, de 1 a 12NãoParcelas da cobrança de agora, até o máximo que a simulação mostrou. Padrão: 1

O resumo: é a simulação: o valor agora e o cartão, quando a mudança vale, a próxima cobrança, as extensões, o contrato e o cupom.

Peça assim: "Muda meu plano para o Growth mensal."

Notas: mexe em dinheiro, por isso pede o seu sim. Sem cartão salvo, uma mudança que vale agora é recusada; cadastre um no Faturamento. Se o cartão é recusado, nada muda e nada é cobrado.

get_scheduled_plan_change

Só consulta

Ver mudança agendada. A mudança de plano que espera o fim do período: de qual opção para qual, o tipo e a data. Papel mínimo: qualquer, na própria assinatura; proprietário e administrador também leem a de um membro.

ParâmetroTipoObrigatórioDescrição
subscription_ididNãoPadrão: a sua assinatura de plano

Peça assim: "Tenho troca agendada?"

cancel_scheduled_plan_change

Pede confirmação

Desfazer mudança agendada. Cancela a mudança de plano agendada; a assinatura renova na opção atual. Papel mínimo: qualquer, só na própria assinatura.

ParâmetroTipoObrigatórioDescrição
subscription_ididNãoPadrão: a sua assinatura de plano

Peça assim: "Desfaz a troca."

Notas: recusada quando o PIX ou o boleto da renovação já foi gerado no preço do plano novo; a troca vale quando ele for pago.

Relacionados