Skip to main content

Crear Suscripción

POST 
/suscripcion

Crear Suscripción

Request​

Body

Crear Suscripción

    plan_id stringrequired

    Id del plan al que será suscrito el usuario

    cliente_id stringrequired

    Id de cliente (Objeto Cliente->id) en plataforma T1pagos que será suscrito

    monto number

    Monto que será cobrado en la suscripción, en caso de que la suscripción sea a un plan con monto variable

    metodo_pago stringrequired

    Possible values: [tarjeta]

    Define el tipo de pago que será usado en la suscripción, en cargos con tarjeta bancaria deberá ser ('tarjeta')

    metodo_pago_token stringrequired

    Token de método de pago seleccionado, en el caso de tarjeta se esperaría que el valor de "token_tarjeta" sea verificado antes de activar la suscripción

    inicio date-time

    Fecha de registro de suscripción en el Comercio, indica una fecha pasada que servirá como ancla, a partir de esa fecha (pasada) se realizará el cálculo de las siguientes fechas de renovación

Responses​

Suscripción creada exitosamente

Schema

    status string

    Possible values: [success, fail, error]

    Estatus de la petición

    http_code integer

    Possible values: [200, 400, 401, 404, 500]

    Código http de respuesta en el header

    datetime date-time

    Fecha y hora de creación del plan

    timestamp integer

    Tiempo Unix o POSIX

    data

    object

    suscripcion

    object

    Objeto Suscripción

    id string

    Id de suscripción

    creacion date-time

    Fecha de creación de suscripción

    actualizacion date-time

    Fecha de última edición

    plan_id string

    Id del plan al que será suscrito el usuario

    cliente_id string

    Id de cliente (Objeto Cliente->id) en plataforma T1pagos que será suscrito

    metodo_pago string

    Possible values: [tarjeta]

    Define el tipo de pago que será usado en la suscripción, en cargos con tarjeta bancaria deberá ser ('tarjeta')

    metodo_pago_token string

    Valor del token/id de método de pago seleccionado

    estado string

    Possible values: [prueba, activa, pendiente, suspendida, cancelada]

    Estado de la suscripción (prueba, activa, pendiente, suspendida, cancelada) de acuerdo al catálogo de estados de una suscripción"

    monto number

    Monto que será cobrado en la suscripción, sólo disponible en planes que permitan el uso de montos variables

    inicio date

    SÓLO PARA MIGRACIONES, designará cuando se realizó la suscripción del usuario en la plataforma, a partir de esa fecha se realizará el cálculo de las fechas de renovación

    fin date

    Fecha de cancelación de suscripción

    prueba_inicio date

    Fecha de inicio de periodo de prueba

    prueba_fin date

    Fecha de término de periodo de prueba

    periodo_fecha_inicio date

    Fecha del primer día de periodo suscrito

    periodo_fecha_fin date

    Fecha del último día de periodo suscrito

    fecha_proximo_cargo date

    Fecha de próximo cargo del plan

    plan

    object

    Objeto Plan de Suscripción

    id string

    Id de Plan

    id_externo string

    Identificador único de Plan en plataforma del comercio

    creacion date-time

    Fecha de creación del objeto

    actualizacion date-time

    Fecha de última edición

    nombre string

    Nombre de Plan

    monto number

    Monto que será cobrado en la suscripción

    monto_variable boolean

    Determina si podrán crearse suscripciones con montos variables

    monto_minimo number

    Monto máximo para suscripcioones con monto variable

    monto_maximo number

    Monto mínimo para suscripcioones con monto variable

    moneda string

    Possible values: >= 3 characters and <= 3 characters

    Identificador de moneda de tres caracteres de acuerdo al estándar ISO 4217

    pais string

    Possible values: >= 3 characters and <= 3 characters

    Default value: MEX

    Identificador de país de tres caracteres

    frecuencia integer

    Possible values: >= 1

    Determina cuantas veces debe repetirse el tipo de periodo para que se realice el siguiente cobro

    tipo_periodo string

    Possible values: [dia, semana, mes, anio]

    Puede ser "dia", "semana", "mes", o "anio"

    max_reintentos integer

    Possible values: <= 10

    Máximo de reintentos (uno por día) que serán realizados antes de cancelar una suscripción, en el caso por defecto se realizarán 3 reintentos, será posible realizar un máximo de 10 reintentos

    estado string

    Possible values: [activo, inactivo]

    Estado del plan ('activo' / 'inactivo')

    puede_suscribir boolean

    Determina si podrán crearse nuevas suscripciones en un plan

    prueba_frecuencia integer

    Possible values: >= 1

    Determina cuantas veces debe repetirse el tipo de periodo para que se designe el día de primer cobro (al término del periodo de prueba)

    prueba_tipo_periodo string

    Possible values: [dia, semana, mes, anio]

    Puede ser "dia", "semana", "mes", o "anio"

    puede_duplicar boolean

    Determina si podrán crearse múltiples suscripciones a un mismo plan por un mismo cliente

    max_suscripcion_usuario integer

    Default value: 1

    Determina el número máximo de suscripciones, por usuario, a un mismo plan cuándo la bandera puede_duplicar está activa

    cliente

    object

    id string

    Possible values: <= 64 characters

    Identificador único de cliente

    creacion date-time

    Fecha de creación del objeto

    actualizacion date-time

    Fecha de última edición

    id_externo string

    Possible values: non-empty and <= 64 characters

    Identificador único de cliente en plataforma del comercio

    creacion_externa date-time

    Fecha y hora de creación del usuario en el comercio

    nombre string

    Possible values: >= 3 characters and <= 30 characters

    Nombre o nombres del cliente

    apellido_paterno string

    Possible values: >= 3 characters and <= 30 characters

    Apellido paterno del cliente

    apellido_materno string

    Possible values: >= 3 characters and <= 30 characters

    Apellido materno del cliente

    sexo string

    Possible values: [masculino, femenino]

    Sexo del cliente

    email emailrequired

    Possible values: <= 250 characters

    Correo electrónico del cliente

    telefono

    object

    tipo string

    Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

    De acuerdo al catálogo tipo teléfono

    codigo_pais string

    Codigo telefónico de un país

    codigo_area string

    Codigo telefónico de área

    prefijo string

    Valor opcional, prefijo utilizado por algunos países

    numero number

    Teléfono del cliente

    extension number

    Extensión

    nacimiento date-time

    Fecha de nacimiento

    direccion

    object

    creacion date-time

    Fecha de creación del objeto

    linea1 string

    Possible values: <= 120 characters

    Línea de dirección 1

    linea2 string

    Possible values: <= 120 characters

    Línea de dirección 2

    linea3 string

    Possible values: <= 120 characters

    Línea de dirección 3

    cp string

    Possible values: >= 3 characters and <= 10 characters

    Código postal

    telefono

    object

    tipo string

    Possible values: [no_definido, movil, casa, oficina, facturacion, mensajeria, temporal]

    De acuerdo al catálogo tipo teléfono

    codigo_pais string

    Codigo telefónico de un país

    codigo_area string

    Codigo telefónico de área

    prefijo string

    Valor opcional, prefijo utilizado por algunos países

    numero number

    Teléfono del cliente

    extension number

    Extensión

    municipio string

    Possible values: <= 60 characters

    Municipio o delegación

    ciudad string

    Possible values: <= 60 characters

    Ciudad

    estado string

    Possible values: >= 3 characters and <= 3 characters

    Identificador de estado de tres caracteres de acuerdo al estándar ISO 3166-2

    pais string

    Possible values: >= 3 characters and <= 3 characters

    Identificador de país de tres caracteres de acuerdo al estándar ISO 3166-1

    referencia_1 string

    Possible values: <= 120 characters

    Referencia adicional, ejemplo: nombre de entre calle 1

    referencia_2 string

    Possible values: <= 120 characters

    Referencia adicional, ejemplo: nombre de entre calle 2

    longitud number

    Possible values: >= -90 and <= 90

    Coordenadas de longitud de localización del domicilio

    latitud number

    Possible values: >= -90 and <= 90

    Coordenadas de latitud de localización del domicilio

    estado string

    Possible values: [activo, inactivo, suspendido]

    Estado del Cliente

Loading...