Listar clientes no Recharge, por uma API

Lista 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.

Identificador
recharge_list_customers

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "email": "<email>"
  }
}

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
emailstringNãoOnly the customer with this email address.
external_customer_idstringNãoOnly the customer with this id in the store platform, the value of external_customer_id.ecommerce shown in Get customer.
idsstringNãoComma-separated ids of customers from List customers.
created_at_minstringNãoOnly customers created after this date, as YYYY-MM-DD.
created_at_maxstringNãoOnly customers created before this date, as YYYY-MM-DD.
updated_at_minstringNãoOnly customers updated after this date, as YYYY-MM-DD.
updated_at_maxstringNãoOnly customers updated before this date, as YYYY-MM-DD.
limitintegerNãoCustomers per page, up to 250. The default is 50.
cursorstringNãoThe 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_customers. 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.