Tools do Recharge
As 12 operações do Recharge que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar assinaturasGETLista as assinaturas da loja com cliente, endereço, produto, quantidade, preço, frequência, status e next_charge_scheduled_at. Até 250 por página: envie o next_cursor da resposta como cursor para ler a próxima página.
- Consultar assinaturaGETRetorna uma assinatura com produto, quantidade, preço, frequência, status, motivo do cancelamento e next_charge_scheduled_at.
- Criar assinaturaPOSTCria uma assinatura em um endereço de um cliente e a retorna. O produto precisa de ao menos um plano no Recharge. Os campos de frequência, a data da primeira cobrança, a variante, a quantidade e o endereço são obrigatórios.
- Atualizar assinaturaPUTAltera uma assinatura ativa e a retorna. Mudar order_interval_unit, order_interval_frequency ou charge_interval_frequency exige os três, recalcula a data da próxima cobrança e remove cobranças puladas e alteradas manualmente. Para mover só a próxima cobrança, use Set subscription next charge date.
- Cancelar assinaturaPOSTCancela 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.
- Reativar assinaturaPOSTReativa uma assinatura cancelada e a retorna, limpando a data e o motivo do cancelamento.
- Definir data da próxima cobrançaPOSTMove a próxima cobrança de uma assinatura para outra data e retorna a assinatura. Quando duas assinaturas ativas do mesmo endereço ficam na mesma data, suas cobranças são unidas em uma nova cobrança com um novo id.
- Listar clientesGETLista os clientes da loja com e-mail, nome, a quantidade de assinaturas ativas e se o meio de pagamento é válido ou está em cobrança de recuperação (dunning). Filtre por e-mail para achar um cliente. Até 250 por página: envie o next_cursor da resposta como cursor.
- Consultar clienteGETRetorna um cliente. Com include, a resposta também traz os endereços, assinaturas ou meios de pagamento do cliente; o id de cada endereço é o address_id que Create subscription recebe.
- Listar cobrançasGETLista as cobranças da loja, passadas e futuras, com status, scheduled_at, processed_at, totais, cliente e itens. Cobranças processadas há mais de 90 dias não são retornadas. Ordenadas por id crescente por padrão; até 250 por página: envie o next_cursor da resposta como cursor para ler a próxima página.
- Consultar cobrançaGETRetorna uma cobrança com status, datas, totais, descontos, frete e os itens, cujo purchase_item_id é a assinatura. Uma cobrança processada há mais de 90 dias retorna erro.
- Pular cobrançaPOSTPula uma cobrança na fila para as assinaturas informadas e retorna a cobrança.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
