Listar clientes en Recharge, con una API

Lista los clientes de la tienda con email, nombre, la cantidad de suscripciones activas y si el método de pago es válido o está en cobro de recuperación (dunning). Filtra por email para encontrar un cliente. Hasta 250 por página: envía el next_cursor de la respuesta como cursor.

Identificador
recharge_list_customers

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
emailstringNoOnly the customer with this email address.
external_customer_idstringNoOnly the customer with this id in the store platform, the value of external_customer_id.ecommerce shown in Get customer.
idsstringNoComma-separated ids of customers from List customers.
created_at_minstringNoOnly customers created after this date, as YYYY-MM-DD.
created_at_maxstringNoOnly customers created before this date, as YYYY-MM-DD.
updated_at_minstringNoOnly customers updated after this date, as YYYY-MM-DD.
updated_at_maxstringNoOnly customers updated before this date, as YYYY-MM-DD.
limitintegerNoCustomers per page, up to 250. The default is 50.
cursorstringNoThe next_cursor or previous_cursor of the previous response.

Conexiones posibles

Tu cliente conecta su cuenta de Recharge una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/recharge_list_customers. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Recharge

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.