Crear una sesión de Checkout

Tu clave API privada (comienza con pvk_)

In: header

Tu ID de organización

In: header

When false, the "Otros Bancos" manual payment option is hidden and blocked for this session.

Defaults to true. Existing sessions without this field behave as if it were true.

Determina si el descuento aplica también a items adicionales (opcional)

Quién decide cuándo se cobra la suscripción que nazca de esta sesión (opcional, predeterminado: engine).

engine: Venflow la cobra automáticamente en cada ciclo. external (Cobro por API): el checkout registra la domiciliación y Venflow nunca cobra solo; cada cobro lo pides tú con POST /v1/subscriptions/{id}/charges.

external debe estar habilitado para tu organización y requiere un plan recurrente y items que no sean por uso (metered). Con external, el trial y la fecha de inicio diferida del plan no aplican; enviar trial_days mayor que 0, scheduled_start_date o allow_manual_payments: true devuelve 400

ID de un cliente existente para prellenar el checkout (opcional)

Datos del cliente que la organización aporta para que el checkout abra con el formulario lleno.

Son SUGERENCIAS editables, no datos verificados: quien abre el enlace puede cambiar cualquiera. No crean ni modifican un cliente — viven en la sesión y dejan de aplicar en cuanto la sesión queda ligada a un cliente real.

Se usa cuando la organización conoce a la persona pero esa persona todavía no es cliente en Venflow. Si ya lo es, usa customer con su identificador: ese camino manda sobre este.

ID of an existing discount to apply to this session

Horas hasta que expire la sesión (1-24, predeterminado: 24)

Solo con collection_mode: "external": si es true, el checkout también cobra el primer pago; los siguientes los pides tú por API. Predeterminado: false. Enviarlo en true sin collection_mode: "external" devuelve 400

Line items to attach to the subscription invoice

Key-value pairs for storing your own information on this checkout session. Venflow does not interpret them: they are stored and returned to you unchanged. At most 50 keys; keys up to 40 characters, values up to 500, and 27000 characters across all keys and values. Do not store sensitive data here: it is not encrypted and is returned on reads.

Four key names are reserved by Venflow and rejected: checkoutMode, subscriptionId, obInvoiceId and billing_cycles; use a different name, such as externalId.

ID del plan para el checkout de suscripción (REQUERIDO)

URL para redirigir después de completar el checkout (opcional)

Delayed start date for the subscription (ISO 8601 date, e.g. "2025-08-01")

Override trial days for this session (0–365)