Referencia API
Página de estadoDashboardReservar una demostración
Empieza a escribir para buscar...

El objeto de suscripción

Atributos

Este objeto representa una suscripción que se puede asociar con un cliente.

id string
El identificador único de la suscripción (MAX 64; MIN 36).
Ejemplo: 7304911d-5df9-429e-8488-ad41abea1a4c

name string
El nombre de la suscripción (MAX 255; MIN 3).
Ejemplo: sub_001

description string
La descripción de la suscripción (MAX 255; MIN 3).
Ejemplo: servicio de streaming

account_id string
El identificador único de la cuenta que tendrá el plan de suscripción disponible para su uso (MAX 64 ; MIN 36).
Ejemplo: 2404911d-5df9-429e-8488-ad41abea1a4b

merchant_reference string
Identificación del plan de suscripción (MAX 255; MIN 3).
Ejemplo: 001_marzo_23

country string
El país de la suscripción.
Ejemplo: CO

status enum
Estado de la suscripción.
Valores posibles:

  • ACTIVE=La suscripción se ha creado con un cliente asociado y ya está activa.
  • PAUSED=La suscripción ha sido pausada y puede ser reactivada.
  • COMPLETED=La suscripción se ha completado porque ha llegado a la fecha y hora de finalización.
  • CANCELED=Suscripción cancelada.

amount objeto

Especifica el objeto del monto de la suscripción, con el valor y la moneda.

currency enum
La moneda utilizada para realizar el pago (MÁX 3; MÍN 3; ISO 4217).
Posibles valores del enum: Compruebe la referencia del país.

value number
Monto del pago (múltiplo de 0,0001).
Ejemplo: 12100,00

frequency objeto

La frecuencia definida para la suscripción de pago .
Si no se establece, los valores por defecto son MES para el tipo y 1 para el valor.

type enum
El tipo de intervalo que tendrá la suscripción en el tiempo (DÍA, SEMANA, MES). Si no se establece, siempre MES por defecto.
Posibles valores de enum: DAY, MONTH, o YEAR.

value int
El valor entre cada intervalo que tendrá la suscripción en el tiempo. Si no se establece, siempre 1 por defecto.
Ejemplo 1

billing_cycles objeto

Especifica el objeto billing_cycles.

total number
Cantidad total de ciclos de facturación.
Ejemplo: 10

current number
Valor del ciclo de facturación actual.
Ejemplo: 2

next_at Timestamp (código de tiempo)
La fecha del próximo pago de la suscripción.
Ejemplo: 2023-02-16T20:00:00.786342Z

billing_date objeto

[Opcional] Especifica el objeto billing_date. Se excluye mutuamente con el objeto de frecuencia.

type number
El tipo de fecha_de_facturación que tendrá la suscripción en tiempo. PREPAGO, POSTFECHA, DÍA. Si no se establece, se establecerá por defecto la fecha de creación del plan.
Ejemplo: PLAN_CREATION_DATE

day number
El día del mes en el que se cargará la suscripción si el tipo es DÍA. Siempre 1 por defecto.
Ejemplo: 2

customer_payer objeto

Especifica el objeto pagador_cliente.

id* string
El identificador único del cliente (MAX 255; MIN 3).
Ejemplo: 3t04911d-5df9-429e-8488-ad41abea1a2c

payment_method array de objects

Especifica el objeto payment_method.

type enum
Tipo de método de pago.
Posibles valores posibles: CARD

token string
El token método de pago de un solo uso proporcionado por Yuno SDK (MÁX. 64; MÍN. 36).
Ejemplo: 9104911d-5df9-429e-8488-ad41abea1a4b

vaulted_token string
El token de bóveda del método de pago almacenado (MÁX: 64; MÍN: 36).
Ejemplo: 6104911d-5df9-429e-8488-ad41abea1a4b

card objeto

Especifica el objeto card.

verify boolean
Utilizando amount = 0 y verify = true, puede verificar la tarjeta del usuario sin autorizar un importe real.
Valores posibles: ture o false.

card_data objeto

Especifica el objeto card_data.

number string
Número de tarjeta sin separadores (MAX 19; MIN 8) - sólo disponible para comerciantes con certificación PCI.
Ejemplo: 4507990000000010

expiration_month number
Mes de caducidad de la tarjeta - MM (MAX 2; MIN 2) - sólo disponible para comercios con certificación PCI.
Ejemplo: 10

expiration_year number
Año de caducidad de la tarjeta - AAAA (MÁX 4; MIN 4) - sólo disponible para comercios con certificación PCI.
Ejemplo: 2025

security_code number
Código de seguridad de la tarjeta (MAX 4; MIN 3) - sólo disponible para comercios con certificación PCI.
Ejemplo: 123

holder_name string
Nombre completo del titular de la tarjeta tal como aparece en la tarjeta (MÁX. 26; MIN. 3). tarjeta (MAX 26; MIN 3) - sólo disponible para comerciantes con certificación PCI.
Ejemplo: JUAN DOE

trial_period objeto

Especifica el objeto trial_period.

billing_cycles number
Cantidad total de ciclos de facturación a los que debe aplicarse la prueba_gratuita debe aplicarse.
Ejemplo: 1

amount objeto

Importe a descontar por el periodo de prueba.

currency string
La moneda utilizada para realizar el periodo de prueba. (ISO 4217 MAX 3; MIN 3).
Ejemplo: COP

value number
Mes de caducidad de la tarjeta - MM (MAX 2; MIN 2) - sólo disponible para comercios con certificación PCI.
Ejemplo: 10

availability objeto

Especifica el objeto de disponibilidad. Las fechas en las que la suscripción estará disponible. Si es nula, la fecha de inicio será el día de la creación y no tendrá fecha de finalización.

start_at Timestamp (código de tiempo)
La fecha de inicio en la que la suscripción estará disponible para su uso.
Ejemplo: 2024-01-16T00:00:00.786342Z

finish_at Timestamp (código de tiempo)
La fecha final hasta la que la suscripción estará disponible para su uso.
Ejemplo: 2024-05-26T20:00:00.786342Z

retries objeto

Especifica el objeto de reintentos. Si necesitamos reintentar transacciones rechazadas en Yuno y el monto, si es necesario.

retry_on_decline bool
Si debemos volver a intentar un pago o no después de un primer rechazo. Falso por defecto.
Ejemplo: VERDADERO

amount number
El número de reintentos que tendrá el plan de suscripción hasta completarse. Si no se establece, o es superior a 7, 7 se definirá por defecto. Máximo: 7
Ejemplo: 4

initial_payment_validation bool
Bandera para identificar si la suscripción debe esperar al primer pago para continuar. Falso por defecto. MIN 27).
Ejemplo: falso

metadata objeto

Especifica el objeto de metadatos.

key string
Este valor sirve como nombre o identificador de los metadatos. Utiliza un término descriptivo. (MÁX. 48; MÍN. 1).
Ejemplo: sub_ext_id

value string
La información que deseas almacenar en los metadatos. (MÁX. 512; MÍN. 1).
Ejemplo: AA001

payments Matriz de cadenas

Especifica la matriz de pagos.

id* string
El identificador único del pago (MÁX 64 ; MÍN 36).
Ejemplo: 5104911d-5df9-229e-8468-bd41abea1a4s

created_at Timestamp (código de tiempo)
Fecha y hora de creación de la suscripción (ISO 8601 MÁX 27; MIN 27).
Ejemplo: 2023-12-16T20:46:54.786342Z

updated_at Timestamp (código de tiempo)
Fecha y hora de la última actualización de la suscripción (ISO 8601 MAX 27; MIN 27).
Ejemplo: 2023-12-16T21:00:54.786342Z

additional_data objeto

Especifica el objeto additional_data. Este objeto no es obligatorio. Sin embargo, si envía esta información, la experiencia de pago será mejorada para su usuario.
order objeto

Especifica el objeto de orden.

items array de objetos

Especifica el objeto del elemento.

id string
El identificador único del elemento (MÁX 255; MÍN 3).
Ejemplo: 3214

name string
El nombre del elemento (MÁX 255; MÍN 3).
Ejemplo: iPhone 12 Pro Max

quantity int
La cantidad del artículo (MÁX 999; MÍN 1).
Ejemplo 1

unit_amount float
El importe unitario del artículo (múltiplo de 0,0001).
Ejemplo: 550

category string
La categoría del artículo (MÁX 255; MÍN 3).
Valores posibles: Compruebe la Lista de categorías de artículos.

brand string
La marca del artículo (MÁX 255; MÍN 3).
Ejemplo: manzana

sku_code string
La unidad de mantenimiento de existencias (SKU) del artículo (MÁX 255; MÍN 3).
Ejemplo: A2342

manufacture_part_number string
El número de pieza de fabricación del artículo (MÁX 255; MÍN 3).
Ejemplo: 345621234