Portal del cliente

Una experiencia alojada para suscripciones y cobros.

Abrir el portal

POST /v1/portal-sessions
{
  "customer": "cus_ejemplo",
  "returnUrl": "https://example.com/cuenta"
}

Redirige al usuario autenticado a url. El enlace se abre una sola vez dentro de los 60 minutos siguientes (expiresAt) y la sesión que inicia dura 60 minutos en el navegador que lo abrió. Allí puede ver sus cobros y suscripciones y realizar las acciones permitidas por el negocio.

Como el enlace se gasta al abrirlo, crea uno nuevo cada vez que el cliente quiera entrar (por ejemplo, desde el botón «Administrar suscripción» de tu sitio) y no lo guardes ni lo reutilices. Si alguien copia o reenvía un enlace ya abierto, no podrá entrar. Para usar el SDK de navegador en tu propia página, crea una sesión de cliente: el token del enlace del portal no sirve como sesión.

Lo que permite el portal se configura en el dashboard, en Configuración → Portal del cliente: ver el historial de cobros, cancelar y reanudar, cambiar el ciclo, cambiar los puestos y desactivar el cobro automático.

Una suscripción suspendida muestra «Pagar y reactivar» con el Cobro de su renovación; no cambia de ciclo ni de puestos, y cancelarla la termina en el acto.

En cada cobro pagado el cliente puede abrir un reclamo, y el portal lista los suyos con el enlace a cada uno (claims). Con tu propia página es POST /v1/client/customer/claims con payment, reason y description.

En un plan por puesto, el cliente puede cambiar sus puestos. Los que agrega los paga en ese momento, solo por lo que queda del periodo, en un checkout que al terminar vuelve a returnUrl; si quita puestos, el cambio se aplica en la próxima renovación. Durante una prueba ambos se aplican en el acto, sin costo. Para quitar puestos en uso, primero hay que quitar a esos miembros desde tu aplicación (seats_in_use). Si construyes tu propia página con una sesión de cliente, es POST /v1/client/customer/subscriptions/:subscription/seats con { "quantity": 5 }, que devuelve applied, scheduled o un checkout con su url.

Comprueba quién está entrando

Tu servidor debe elegir el cliente a partir de la sesión autenticada de tu aplicación. No crees una sesión de portal para cualquier ID que envíe el navegador.

MétodoRutaAcción
POST/v1/portal-sessionsCrear un enlace al portal