Cancelar assinatura no Recharge, por uma API

Cancela uma assinatura ativa e a retorna. O Recharge pode enviar e-mail ao cliente e ao dono da loja sobre isso, a menos que send_email seja false.

Identificador
recharge_cancel_subscription

A chamada

POST https://connect.reportei.com/api/tools/recharge_cancel_subscription/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": 1,
    "cancellation_reason": "<cancellation_reason>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
idintegerSimId of an active subscription from List subscriptions.
cancellation_reasonstringSimReason for the cancellation.
cancellation_reason_commentsstringNãoComment on the reason.
send_emailbooleanNãoFalse keeps Recharge from sending the cancellation email.

Conexões possíveis

O seu cliente conecta a conta do Recharge uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/recharge_cancel_subscription. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Recharge

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.