Crear suscripción
Crea un plan de suscripción recurrente con ciclos de facturación, periodos de prueba y credenciales de pago almacenadas.
vaulted_token que ya tienes. Si el cliente se registra y paga al mismo tiempo, puedes enviar un bloque subscription en Crear pago: una sola llamada cobra la tarjeta y crea la suscripción a partir de ese mismo cobro. Esa ruta está documentada solo para pagos con tarjeta sin fricción. Consulta Inicia una suscripción con el primer pago.promotion con un id o un code para aplicar una promoción asociada al plan. El primer cobro lleva el descuento. La suscripción debe estar en un plan que tenga la promoción asociada. La suscripción almacena su propia copia de la promoción, que no se edita después. Consulta Promociones en planes de suscripción.AUTOMATIC asociada al plan se aplica por sí sola cuando la suscripción se crea en ese plan. Si la solicitud también envía una promotion, gana el descuento mayor; los dos no se acumulan.Errores de promoción
Crear una suscripción conpromotion puede fallar con los códigos de abajo. En cada caso, no se crea nada.
AUTOMATIC asociada al plan se maneja de forma distinta. Si no se puede aplicar, porque está deshabilitada, venció o no tiene usos restantes, la suscripción se crea sin ella y la solicitud igualmente tiene éxito. Lo mismo ocurre cuando el servicio de promociones no encuentra la promoción asociada. Solo un 503 o 504 detiene la creación.
Consulta la sección Códigos de respuesta HTTP para ver los detalles de los posibles resultados de error.
Configurar una regla de reembolso
refund_rule se puede definir al crear la suscripción para configurar cómo se calcula un reembolso CUSTOM cuando una solicitud de cancelación posterior no incluye su propio refund_amount:
PERCENT y FIXED son excluyentes: una regla PERCENT solo lleva percent (0–100) y una regla FIXED solo lleva amount. El amount.currency de una regla FIXED debe ser igual a la moneda de la propia suscripción.
Se puede cambiar o eliminar más adelante en Actualizar suscripción y se describe en el objeto Subscription. Consulta Cancelar suscripción para ver cómo se usa. Está disponible para las organizaciones habilitadas; contacta a Yuno. Para las demás, enviar refund_rule se ignora en silencio y no se almacena nada.Autorizaciones
Encabezados
Un identificador único para la solicitud. Debe ser diferente cada vez (UUID). Consulta autenticación.
Cuerpo
El país de la suscripción (MAX 2; MIN 2; ISO 3166-1).
Especifica el objeto customer_payer para identificar al cliente. Obligatorio. Ten en cuenta que los errores de validación de este objeto nombran el campo customer_payer.code, no customer_payer.id; por ejemplo 400 BAD_REQUEST ("customer_payer.code field is required") cuando se omite.
Descriptor de estado de cuenta que se muestra en el extracto bancario del titular de la tarjeta. Cuando se define, se guarda en la suscripción y se propaga a cada pago de refacturación generado por el motor de suscripciones. Los límites de longitud y formato varían según el proveedor (por ejemplo, Unlimit lo trunca a 22 caracteres y Airwallex a 30). Worldpay no lee este campo; construye la narrativa del extracto a partir de payment_description.
255El identificador único de un plan al que suscribir a este cliente. Es mutuamente excluyente con amount: envía exactamente uno de los dos. Omite trial_period y billing_date cuando se define: ambos se heredan del plan y la solicitud se rechaza con 400 BAD_REQUEST si los envías. Omite también frequency: también se hereda del plan, pero enviarla no se rechaza: se ignora en silencio y la frecuencia del plan la reemplaza. Si el plan tiene su propia configuración de reintentos, omite también retries: la suscripción hereda los reintentos del plan, y enviar ambos se rechaza con 400 INVALID_PARAMETERS.
Especifica el objeto 'retries'. Indica si se deben reintentar las transacciones rechazadas en Yuno y el monto si es necesario. Con plan_id, envía retries solo cuando el plan no tiene una configuración de reintentos propia. Si el plan define reintentos, la suscripción los hereda y una solicitud que también envíe retries se rechaza con 400 INVALID_PARAMETERS.
Vincula esta suscripción con el pago inicial creado con el mismo ID de acuerdo. Se usa para el seguimiento, la conciliación y la gestión de contracargos. Debe coincidir exactamente con el subscription_agreement_id enviado en payment_method.detail.card.stored_credentials.subscription_agreement_id en el pago de origen (MAX 255).
Aplica una promoción asociada al plan en el que se crea esta suscripción. Envía exactamente uno entre id o code. La promoción comienza con la suscripción y descuenta el primer cobro. Si no se puede aplicar (no está asociada al plan, venció, está deshabilitada, aún no comienza o no tiene usos disponibles), la solicitud se rechaza y no se crea nada. Si el plan también tiene una promoción automática, se aplica el mayor descuento en el primer cobro, y la promoción que envías gana en caso de empate. Consulta Promociones en planes de suscripción.
Respuesta
201
Inicio del período de facturación en el que está la suscripción actualmente, una cadencia antes de current_period_end. Dentro de una prueba o de cualquier otra fase del plan, sigue la cadencia de esa fase. Una suscripción terminal (CANCELED o COMPLETED) conserva su ventana final en lugar de pasar a null. Es null solo para una suscripción sin cadencia recurrente. Siempre se devuelve junto con current_period_end.
"2023-01-16T20:00:00.912480Z"
La política de reintentos que se aplica cuando se rechaza un cobro recurrente. Consulta Reintentos.
El enriquecimiento opcional de la orden enviada en la creación, devuelto tal cual. Consulta El objeto Suscripción para ver su estructura completa.
Qué desencadenó la cancelación: MERCHANT, SYSTEM, PLAN_CHANGE o RETRIES_EXHAUSTED. Solo se define una vez que la suscripción llega a CANCELED; null en caso contrario. Trátalo como un valor abierto: maneja los valores no reconocidos de forma adecuada.
"MERCHANT"
Las definiciones de fases del plan vinculado, tal como las declara el plan, incluida la fase terminal REGULAR. Solo está presente en suscripciones vinculadas a un plan que tiene fases. Esta es la escalera propia del plan, no la instantánea de este suscriptor: para lo que se fijó para esta suscripción en la creación, usa billing_phases.
Cuándo la fase indicada por current_phase pasa a la siguiente: para una suscripción en su prueba, cuándo cambia al precio regular. Es el fin del último período de facturación que cubre la fase, así que en el último período de una prueba es igual a current_period_end. Es null para una suscripción sin plan y para una que ya salió de la escalera de fases.
"2023-03-16T20:00:00.786342Z"
La regla de reembolso almacenada que se usa para resolver un reembolso de cancelación CUSTOM cuando la solicitud de cancelación no envía su propio refund_amount. Solo está presente cuando hay una configurada; se omite, no es null, en caso contrario. Disponible para las organizaciones habilitadas; contacta a Yuno.
Cuándo está programado que la suscripción se reanude automáticamente. Solo está presente en una suscripción actualmente pausada con una duración (pause_cycles o pause_until enviados al pausar); está ausente, no es null, en cualquier otra lectura.
"2026-10-15T15:54:22.780166Z"