Solicitar acceso

Activa o cancela la renovación automática del plan

PATCH/api/v1/account/plan

Con auto_renew: false el plan termina al vencer o agotarse y no se cobra el siguiente.

Cuerpo de la petición application/json

  • auto_renewbooleanobligatorio

    Ejemplo: false

Respuestas

200Plan actualizado
  • idstring · uuid
  • planobject
    + Ver 6 campos− Ocultar 6 campos
    • idstring

      Ejemplo: casa-10

    • namestring

      Ejemplo: Casa 10

    • audiencestring

      Valores: natural_person · company · software_house

    • documentsinteger

      Ejemplo: 10000

    • price_copinteger

      Precio en pesos

      Ejemplo: 280000

    • monthsinteger

      Ejemplo: 12

  • documents_includedinteger

    Ejemplo: 10000

  • documents_usedinteger

    Ejemplo: 7350

  • documents_remaininginteger

    Ejemplo: 2650

  • used_percentinteger

    Ejemplo: 73

  • price_copinteger

    Ejemplo: 280000

  • starts_atstring · date-time
  • ends_atstring · date-time
  • auto_renewboolean

    Compra el mismo plan al vencer o agotarse

400Datos inválidos (details trae los campos)
  • codestring

    Ejemplo: error.document.invalid

  • messagestring
  • errorsarray<object>

    Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)

    + Ver 2 campos− Ocultar 2 campos
    • fieldstring

      Ruta del campo en el JSON enviado

      Ejemplo: lines[0].quantity

    • messagestring

      Ejemplo: Cantidad inválida: debe ser mayor que cero.

  • detailsarray<string>

    Rutas de los campos inválidos (compatibilidad; usa errors)

  • request_idstring
401Falta la key o es inválida, está deshabilitada, vencida o revocada (error.missing_api_key, error.invalid_api_key, error.api_key.disabled, error.api_key.expired, error.api_key.revoked)
  • codestring

    Ejemplo: error.document.invalid

  • messagestring
  • errorsarray<object>

    Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)

    + Ver 2 campos− Ocultar 2 campos
    • fieldstring

      Ruta del campo en el JSON enviado

      Ejemplo: lines[0].quantity

    • messagestring

      Ejemplo: Cantidad inválida: debe ser mayor que cero.

  • detailsarray<string>

    Rutas de los campos inválidos (compatibilidad; usa errors)

  • request_idstring
404No existe (o es de otra cuenta)
  • codestring

    Ejemplo: error.document.invalid

  • messagestring
  • errorsarray<object>

    Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)

    + Ver 2 campos− Ocultar 2 campos
    • fieldstring

      Ruta del campo en el JSON enviado

      Ejemplo: lines[0].quantity

    • messagestring

      Ejemplo: Cantidad inválida: debe ser mayor que cero.

  • detailsarray<string>

    Rutas de los campos inválidos (compatibilidad; usa errors)

  • request_idstring
409Conflicto con el estado actual (p. ej. documento referenciado no aceptado, rango agotado)
  • codestring

    Ejemplo: error.document.invalid

  • messagestring
  • errorsarray<object>

    Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)

    + Ver 2 campos− Ocultar 2 campos
    • fieldstring

      Ruta del campo en el JSON enviado

      Ejemplo: lines[0].quantity

    • messagestring

      Ejemplo: Cantidad inválida: debe ser mayor que cero.

  • detailsarray<string>

    Rutas de los campos inválidos (compatibilidad; usa errors)

  • request_idstring