Saltar al contenido principal
Un complemento es un extra de pago que activas en una tienda y desactivas cuando quieras. Los complementos están disponibles para los partners con el precio de autoservicio de Listo, en las tiendas que operas tú. Los cambias con PATCH /v1/stores/{id} o desde la página de la tienda en el panel de socios; las dos formas hacen lo mismo, y cada tienda tiene sus propios interruptores.

Los complementos

Puedes activar tres. El precio es por tienda, antes de IVA, y a cada cobro se le suma el IVA. add_ons también lista wallet (Saldo del restaurante) y full_console (Consola completa) con available: false. No se pueden activar: una petición que pida cualquiera de los dos se rechaza y no se cobra nada. Hay dos tipos de cobro:
  • Mensual (ratings): se cobra cuando activas el complemento y otra vez el mismo día de cada mes.
  • Por uso (customer_whatsapp, card_payments): nada por adelantado. Cada viaje entregado o cada pago con tarjeta realizado se cobra cuando ocurre.

Cómo leer los complementos en una tienda

Cada objeto de tienda trae add_ons: la respuesta de la creación, GET /v1/stores/{id}, cada fila de GET /v1/stores, la respuesta de la actualización y la tienda que trae un evento store.updated. Viene en null en una tienda a la que no le aplican los complementos. En las demás trae una entrada por cada una de las cinco claves, siempre presentes:
El status del esquema también lista scheduled y past_due. Aparecen solo en wallet y full_console, que hoy no se pueden activar, así que los tres complementos que sí puedes activar muestran solo off, on y ending.

Activar y desactivar complementos

Manda en add_ons los complementos que quieras cambiar, cada uno como true o false. Una clave que no mandes se queda como está.
La respuesta es 200 con la tienda completa, add_ons incluido, en el estado en que quedó. Cada clave se revisa antes de cambiar nada, así que una petición con una clave incorrecta no cambia nada. Algunas reglas:
  • wallet y full_console no se pueden activar. Una petición que ponga cualquiera de los dos en true se rechaza con 422 validation_failed y param: "add_ons.wallet" o "add_ons.full_console", antes de cambiar o cobrar nada. Ponerlos en false se acepta.
  • Los complementos de cobro por uso se activan y desactivan en la misma petición sin límite.

Cuando no se puede pagar el primer mes

Activar un complemento mensual cobra su primer mes en la misma petición, de tu saldo, o de tu tarjeta si elegiste tarjeta para los cobros del plan en la página Planes y facturación del panel. Si no se puede pagar, la petición se rechaza y no cambia nada: el complemento sigue desactivado y no se cobra nada.
Recarga tu saldo o guarda una tarjeta y vuelve a mandar la petición. Manda un Idempotency-Key para poder repetir sin cobrar dos veces una petición que se agotó por tiempo.

Renovaciones y desactivación

Un complemento mensual se cobra otra vez en renews_on, el mismo día de cada mes, del mismo saldo o tarjeta.
  • Una renovación que no se puede pagar desactiva el complemento al terminar el mes que ya pagaste. Recibes un correo y no se te debe nada. Puedes volver a activarlo cuando quieras, lo que cobra un mes nuevo.
  • Desactivar un complemento mensual lo deja funcionando hasta el final del mes que pagaste: status queda en ending y ends_on nombra el último día. No se reembolsa nada y no se cobra nada más. Si lo vuelves a activar antes de ends_on, simplemente continúa, sin un cobro nuevo.
Los complementos por uso no tienen un mes que se termine. Activar o desactivar uno surte efecto de inmediato.

Cobros por uso

customer_whatsapp y card_payments se cobran de tu saldo cada vez que se usan: customer_whatsapp cuando se entrega un viaje y card_payments cuando se paga con tarjeta. Nunca se cobran a tu tarjeta. El reembolso de un pago con tarjeta no devuelve sus MX$5.

En modo de prueba

Las tiendas de prueba pueden activar customer_whatsapp, ratings y card_payments, los mismos tres que las tiendas en vivo. Los cobros por uso van a tu saldo de prueba y no se cobra nada real. Ve modo de prueba.

En tu libro de movimientos

Lo que los complementos cobran a tu saldo aparece en GET /v1/ledger: Ve fondea tu saldo y retira.

El evento store.updated

Cada cambio en los complementos de una tienda manda un evento store.updated con el objeto completo de la tienda, add_ons incluido: un complemento activado, desactivado o terminado. Lee los add_ons que trae cada evento en lugar de contar eventos. Ve webhooks.