Listar cobranças no Recharge, por uma API
Lista 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.
- Identificador
- recharge_list_charges
A chamada
POST https://connect.reportei.com/api/tools/recharge_list_charges/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"status": "<status>"
}
}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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| status | string | Não | Only charges in these statuses, comma-separated: success, queued, error, refunded, partially_refunded, skipped, pending_manual_payment or pending. |
| customer_id | integer | Não | Only charges of this customer, the id from List customers. |
| address_id | integer | Não | Only charges of this address, from the addresses of Get customer. |
| purchase_item_id | integer | Não | Only charges of this subscription, the id from List subscriptions. |
| external_order_id | string | Não | Only the charge of this order of the store platform, the value of external_order_id.ecommerce shown in Get charge. |
| discount_code | string | Não | Only charges with this discount code. |
| ids | string | Não | Comma-separated ids of charges from List charges. |
| scheduled_at_min | string | Não | Only charges scheduled after this date, as YYYY-MM-DD. |
| scheduled_at_max | string | Não | Only charges scheduled before this date, as YYYY-MM-DD. |
| processed_at_min | string | Não | Only charges processed on or after this date, as YYYY-MM-DD, within the last 90 days. |
| processed_at_max | string | Não | Only charges processed on or before this date, as YYYY-MM-DD. |
| sort_by | string | Não | Order of the results. The default is id-asc.Valores: id-asc, id-desc, updated_at-asc, updated_at-desc, scheduled_at-asc, scheduled_at-desc |
| limit | integer | Não | Charges per page, up to 250. The default is 50. |
| cursor | string | Não | The next_cursor or previous_cursor of the previous response. |
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_list_charges. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Recharge
- 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
