Skip to main content
En el modo payment vende una variante específica; en el modo setup recopila y guarda los datos de pago sin cobrar. Cada configuración también puede sobrescribir qué métodos de pago se aceptan y cómo se aplica 3D Secure para ese checkout. Usa la API de Checkout Configurations para crear enlaces de pago para una variante existente o definida en línea, listar las configuraciones de una cuenta, recuperar la configuración detrás de una URL de checkout y eliminar los enlaces que ya no deban usarse.
Reemplaza el recurso Legacy Checkout configurations. Las integraciones Legacy existentes siguen funcionando; consulta Versiones de la API para conocer el contrato de estabilidad.

Endpoints

Atributos

string
requerido
ID de la checkout configuration, con el prefijo ch_.
string
requerido
ID de la cuenta, con el prefijo biz_.
string | null
Código de afiliado aplicado en el checkout, o null cuando no hay ninguno.
string
requerido
Cuándo se creó la checkout configuration, como marca de tiempo ISO 8601.
string | null
Moneda usada para la disponibilidad de métodos de pago en modo setup; el valor predeterminado es usd si se omite.
object | null
La configuración que rige un checkout montado a partir de esta configuración, resuelta a través de todas las capas (sus propias sobrescrituras, las de la variante y las de la cuenta): la forma que lleva el payment_method_configuration de una sesión. Aplícala sobre el catálogo de tipos de métodos de pago para obtener el conjunto ofrecible. null significa los valores predeterminados de la plataforma; payment_method_configuration sigue siendo la sobrescritura editable propia de esta configuración.

Propiedades

string[]
Métodos de pago deshabilitados explícitamente.
string[]
Métodos de pago habilitados explícitamente.
boolean
Si se incluyen los métodos de pago predeterminados de la plataforma.
object | null
Metadatos personalizados de clave-valor copiados a pagos y membresías. null sin el scope checkout_configuration:basic:read.
string
requerido
Controla si el checkout cobra al comprador de inmediato o guarda los datos de pago para más adelante.Opciones disponibles: payment, setup
object | null
Sobrescrituras de métodos de pago para este checkout. null cuando usa los valores predeterminados de la variante o de la plataforma.

Propiedades

string[]
Métodos de pago deshabilitados explícitamente para el checkout.
string[]
Métodos de pago habilitados explícitamente para el checkout.
boolean
Si se incluyen los métodos de pago predeterminados de la plataforma.
string | null
URL de checkout que puedes enviar a los clientes.
string | null
URL a la que se envía a los clientes después del checkout, o null cuando no hay redirección configurada.
string | null
Comportamiento de 3D Secure para pagos con tarjeta compatibles en sesión. mandate_challenge exige un desafío 3DS antes de procesar el pago; mandate_if_required exige un desafío solo cuando el procesador de pagos lo requiere; frictionless_if_required usa el flujo 3DS sin fricción habitual. Los pagos de $1,000 o más usan mandate_if_required a menos que se seleccione mandate_challenge. Los requisitos de riesgo y de recuperación de autenticación pueden anular la preferencia. Se aplica en modo setup; null usa 3DS sin fricción. El modo payment usa la política de la variante.Opciones disponibles: mandate_challenge, mandate_if_required, frictionless_if_required
string
requerido
Cuándo se actualizó la checkout configuration por última vez, como marca de tiempo ISO 8601.
object | null
Variante usada para el checkout de pago. null en modo setup.

Propiedades

string
requerido
ID de la variante, con el prefijo plan_.
boolean
requerido
Si esta variante acepta pagos en moneda local mediante precios adaptativos.
integer | null
requerido
Intervalo de facturación recurrente en días, como 30 para mensual o 365 para anual. null para variantes de pago único.
string
requerido
Modelo de facturación de la variante.Opciones disponibles: renewal, one_time
string
requerido
Código de moneda ISO de tres letras para los precios de la variante.
integer | null
requerido
Duración del acceso en días para variantes basadas en vencimiento.
number
requerido
Precio de compra inicial en la moneda de la variante.
string
requerido
Método de venta de la variante.Opciones disponibles: buy_now, waitlist
number
requerido
Precio recurrente cobrado en cada periodo de facturación.
string | null
requerido
Comportamiento de 3D Secure para pagos con tarjeta compatibles en sesión. mandate_challenge exige un desafío 3DS antes de procesar el pago; mandate_if_required exige un desafío solo cuando el procesador de pagos lo requiere; frictionless_if_required usa el flujo 3DS sin fricción habitual. Los pagos de $1,000 o más usan mandate_if_required a menos que se seleccione mandate_challenge. Los requisitos de riesgo y de recuperación de autenticación pueden anular la preferencia. null hereda el valor predeterminado de la cuenta.Opciones disponibles: mandate_challenge, mandate_if_required, frictionless_if_required
integer | null
requerido
Días de prueba gratuita antes del primer cobro de renovación.
string
requerido
Si la variante es visible para los clientes u oculta a la vista pública.Opciones disponibles: visible, hidden, archived, quick_link
CheckoutConfiguration