Tools de Recharge
Las 12 operaciones de Recharge que tu producto ejecuta en la cuenta de tu cliente con Connect. Todas usan el mismo endpoint, POST /api/tools/{tool}/execute.
- 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.
- Listar clientesGETLista 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.
- 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.
- Listar cargosGETLista los cargos de la tienda, pasados y futuros, con estado, scheduled_at, processed_at, totales, cliente y artículos. Los cargos procesados hace más de 90 días no se devuelven. Ordenados por id ascendente por defecto; hasta 250 por página: envía el next_cursor de la respuesta como cursor para leer la página siguiente.
- Consultar cargoGETDevuelve un cargo con estado, fechas, totales, descuentos, envío y los artículos, cuyo purchase_item_id es la suscripción. Un cargo procesado hace más de 90 días devuelve un error.
- Omitir cargoPOSTOmite un cargo en cola para las suscripciones indicadas y devuelve el cargo.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
