Guía del producto y de la API
Consultar tu cuota
Qué responde este endpoint
Una llamada indica la situación del mes: cuántas páginas incluye el plan, cuántas se han consumido y si se permite el uso adicional. Está pensado para tu panel y para comprobarlo antes de un trabajo masivo.
Consulta la cuota mensual, el consumo y el estado del uso adicional para mostrarlos en tu propio panel.
Solicitud
curl https://api.pdfgine.com/api/v1/usage \
-H "X-PDFgine-Key: $PDFGINE_KEY"
Respuesta
{
"organizationName": "Northwind Trading Ltd.",
"planCode": "business",
"monthlyPageQuota": 5000,
"usedPages": 1284,
"quotaRemaining": 3716,
"monthlyPreviewPageAllowance": 250,
"usedPreviewPages": 32,
"allowsOverage": true,
"monthlyOverageCap": 1000,
"overagePages": 0,
"meteringBasis": "pdf-equivalent"
}Campo por campo
Todos los contadores corresponden al mes de facturación actual y se reinician al comenzar el siguiente.
| Campo | Qué significa |
|---|---|
monthlyPageQuota | Páginas incluidas en el plan este mes. |
usedPages | Páginas generadas en lo que va de mes. |
quotaRemaining | monthlyPageQuota menos usedPages en el momento de esta respuesta. |
monthlyPreviewPageAllowance | Páginas de vista previa incluidas además de la cuota de páginas; una vista previa no consume la cuota de producción. |
allowsOverage | Si las renderizaciones continúan al agotarse la cuota. Cuando es false, la siguiente renderización responde 402. |
monthlyOverageCap | Cuánto pueden superar la cuota las renderizaciones cuando se permite uso adicional. |
meteringBasis | Qué significa una página a efectos de facturación. pdf-equivalent contabiliza una salida docx o html con el mismo número de páginas que tendría el PDF. |
Personas y filiales
El plan incluye otros dos límites, contados por organización: cuántas personas pueden estar en el espacio de trabajo y cuántas filiales puede gestionar.
| Plan | Personas | Filiales |
|---|---|---|
| Gratis | 2 | 0 |
| Go | 3 | 0 |
| Pro | 10 | 5 |
| Max | Ilimitado | Ilimitado |
Una invitación que supera el límite de miembros se rechaza al enviarla, no al aceptarla, para que nadie pierda tiempo con una invitación que nunca podría funcionar.
Los errores más habituales
- No llames a este endpoint después de cada renderización. Cada renderización ya incluye X-PDFgine-Quota-Remaining, el mismo número sin otro viaje de ida y vuelta.
- Las vistas previas y las renderizaciones de producción se cuentan por separado. Una vista previa que no cambió usedPages no ha fallado; cambió usedPreviewPages.
- allowsOverage false con la cuota agotada implica un 402 en la siguiente renderización, no una cola más lenta. Supervisa quotaRemaining, no el error.
- La cuota y el límite de solicitudes son límites distintos. Una clave puede hacer 120 llamadas cada 60 segundos, sea cual sea la cuota restante; al superarlo, la respuesta es 429 con Retry-After.
- Los contadores siguen el mes de facturación, no el mes natural. Si el plan se contrató el día 12, el mes se renueva el día 12.