Buscar clientes no Stripe, por uma API

Busca clientes com a linguagem de consulta de busca do Stripe, por email, nome, telefone, data de criação ou metadata. A resposta traz data, has_more e next_page; envie next_page como page para a próxima página. Um cliente criado ou atualizado no último minuto pode ainda não aparecer.

Identificador
stripe_search_customers

A chamada

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

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

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
querystringSimUp to 10 clauses joined by AND or by OR, never both, for example email:"ana@example.com" or name~"silva". Fields: email, name and phone (a colon matches exactly, a tilde matches part of the text, with at least 3 characters), metadata["key"]:"value", and created (Unix seconds), which also takes a greater-than or less-than sign, optionally followed by an equals sign, in place of the colon. Text values go in double quotes, and a leading - negates a clause.
limitintegerNãoCustomers per page, from 1 to 100. The default is 10.
pagestringNãoThe next_page value of the previous response, to get the next page.

Conexões possíveis

O seu cliente conecta a conta do Stripe 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/stripe_search_customers. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Stripe

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.