Skip to main content

Consultar un Plan por medio de id_externo

GET 
/plan/id_externo/:id_externo

Consultar un Plan por medio de id_externo

Request​

Path Parameters

    id_externo stringrequired

    Identificador único de Plan en plataforma del comercio

Responses​

Objeto tipo Plan

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

    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

Loading...