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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| string | No | Only the customer with this email address. | |
| external_customer_id | string | No | Only the customer with this id in the store platform, the value of external_customer_id.ecommerce shown in Get customer. |
| ids | string | No | Comma-separated ids of customers from List customers. |
| created_at_min | string | No | Only customers created after this date, as YYYY-MM-DD. |
| created_at_max | string | No | Only customers created before this date, as YYYY-MM-DD. |
| updated_at_min | string | No | Only customers updated after this date, as YYYY-MM-DD. |
| updated_at_max | string | No | Only customers updated before this date, as YYYY-MM-DD. |
| limit | integer | No | Customers per page, up to 250. The default is 50. |
| cursor | string | No | The 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
- Listar suscripcionesGETLista las suscripciones de la tienda con cliente, dirección, producto, cantidad, precio, frecuencia, estado y next_charge_scheduled_at. Hasta 250 por página: envía el next_cursor de la respuesta como cursor para leer la página siguiente.
- Consultar suscripciónGETDevuelve una suscripción con producto, cantidad, precio, frecuencia, estado, motivo de cancelación y next_charge_scheduled_at.
- Crear suscripciónPOSTCrea una suscripción en una dirección de un cliente y la devuelve. El producto necesita al menos un plan en Recharge. Los campos de frecuencia, la fecha del primer cargo, la variante, la cantidad y la dirección son obligatorios.
- Actualizar suscripciónPUTCambia una suscripción activa y la devuelve. Cambiar order_interval_unit, order_interval_frequency o charge_interval_frequency exige los tres, recalcula la fecha del próximo cargo y elimina los cargos omitidos y los cambiados manualmente. Para mover solo el próximo cargo, usa Set subscription next charge date.
- Cancelar suscripciónPOSTCancela una suscripción activa y la devuelve. Recharge puede enviar un email al cliente y al dueño de la tienda al respecto, salvo que send_email sea false.
- Reactivar suscripciónPOSTReactiva una suscripción cancelada y la devuelve, borrando la fecha y el motivo de la cancelación.
- Definir fecha del próximo cargoPOSTMueve el próximo cargo de una suscripción a otra fecha y devuelve la suscripción. Cuando dos suscripciones activas de la misma dirección quedan en la misma fecha, sus cargos se fusionan en un nuevo cargo con un nuevo id.
- Consultar clienteGETDevuelve un cliente. Con include, la respuesta también trae las direcciones, suscripciones o métodos de pago del cliente; el id de cada dirección es el address_id que recibe Create subscription.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
