Plan activo y consumo de la bolsa

GET/api/v1/account/plan

El plan dura un año o hasta consumir la bolsa, lo que ocurra primero; los documentos no se acumulan. Cada documento aceptado descuenta de la bolsa (los de las hijas, de la bolsa de su casa). Avisos por correo: al 70, 80 y 90 % (al 90 %, si se renueva sola, que tenga fondos el medio de pago); a 4, 3 y 2 semanas del vencimiento; y el día que se renueva o termina. Al vencer o agotarse, si auto_renew está activo, se cobra el mismo plan a la tarjeta guardada (ver Pagos): el plan nuevo se abre al aprobarse el pago y su año cuenta desde ese día. Mientras el pago esté pendiente, si se rechaza o si auto_renew está apagado, en producción no se emiten documentos (402 error.plan.inactive) hasta pagar. Una cuenta hija responde 409 error.plan.child_account.

Respuestas

200OK

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

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