HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Crear Customer Portal Session

Crea una sesión de un Customer en el Customer Portal y devuelve la url con la que entra.

Se usa para llevar a un Customer al portal desde un canal propio: la url que viene en la respuesta es el enlace que se le entrega.

billing_data.id_customer es obligatorio. Si no se envía billing_data.id_account, la sesión queda asociada al Account principal de la organización.

expiration_datetime es obligatorio, debe quedar al menos 30 minutos en el futuro y se interpreta en UTC. Al llegar esa fecha la sesión pasa sola al estado expired, sin necesidad de llamar a la operación de expiración.

external_id es una referencia propia opcional y no puede repetirse entre las Customer Portal Sessions ni las Checkout Sessions de la organización: un valor ya usado devuelve 409. flow_name elige el flujo con el que abre el portal y por defecto es "0". Lo que venga en additional_metadata se guarda tal cual y se devuelve en las lecturas de la sesión.

Al crear la sesión se despacha un mensaje al Customer con el enlace: con la plantilla indicada en template si se envía, y en caso contrario según la configuración de mensajería de la organización, sobre el canal indicado en communication_channel. Ese despacho es asincrónico y no condiciona la creación: si falla, la sesión igual queda creada.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
additional_metadata
object
additional_query_parameters
object
billing_data
object
required
string
date-time
required
string
string
Defaults to 0
payment_options_configuration
object
redirection_configuration
object
string
Headers
string

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Responses

404

No existe el Customer, Subscription o Account indicado bajo la organización, o la organización no tiene portal configurado.

409

Ya existe una Customer Portal Session o una Checkout Session con ese external_id.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json