제품 및 API 안내
한도 확인
이 엔드포인트가 반환하는 정보
한 번의 호출로 요금제에 포함된 페이지 수, 사용한 수량, 초과 사용 허용 여부 등 이번 달 상황을 알 수 있습니다. 자체 대시보드와 일괄 작업 전 점검용으로 사용합니다.
월 한도, 사용량, 초과 사용 상태를 조회합니다. 자체 대시보드에 표시하기에 적합합니다.
요청
curl https://api.pdfgine.com/api/v1/usage \
-H "X-PDFgine-Key: $PDFGINE_KEY"
응답
{
"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"
}필드별 설명
모든 수치는 현재 청구 월을 기준으로 하며 다음 기간에 초기화됩니다.
| 필드 | 의미 |
|---|---|
monthlyPageQuota | 이번 달 요금제에 포함된 페이지 수입니다. |
usedPages | 이번 달 현재까지 생성한 페이지 수입니다. |
quotaRemaining | 이 응답 시점의 monthlyPageQuota에서 usedPages를 뺀 값입니다. |
monthlyPreviewPageAllowance | 페이지 한도 외에 요금제에 포함된 미리보기 페이지 수입니다. 미리보기는 실제 생성 한도를 사용하지 않습니다. |
allowsOverage | 한도를 모두 사용한 후에도 생성을 계속할 수 있는지 나타냅니다. false이면 다음 생성에 402로 응답합니다. |
monthlyOverageCap | 초과 사용이 허용될 때 한도를 얼마나 넘겨 생성할 수 있는지 나타냅니다. |
meteringBasis | 청구에서 한 페이지가 무엇을 의미하는지 나타냅니다. pdf-equivalent는 docx 또는 html 출력을 PDF로 만들었을 때와 같은 페이지 수로 계산합니다. |
구성원과 자회사
요금제에는 테넌트별로 집계되는 두 가지 한도가 더 있습니다. 워크스페이스에 참여할 수 있는 인원과 관리할 수 있는 자회사 수입니다.
| 요금제 | 인원 | 자회사 |
|---|---|---|
| 무료 | 2 | 0 |
| Go | 3 | 0 |
| Pro | 10 | 5 |
| Max | 무제한 | 무제한 |
인원 한도를 초과한 초대는 수락할 때가 아니라 보낼 때 거부됩니다. 따라서 처음부터 사용할 수 없는 초대에 시간을 쓰지 않습니다.
자주 발생하는 문제
- 생성할 때마다 이 엔드포인트를 호출하지 마세요. 각 생성 응답의 X-PDFgine-Quota-Remaining에 같은 잔여량이 포함되므로 추가 호출이 필요 없습니다.
- 미리보기와 실제 생성은 별도로 집계됩니다. 미리보기에서 usedPages가 변하지 않아도 실패한 것이 아니라 usedPreviewPages가 변한 것입니다.
- allowsOverage가 false이고 한도가 소진되면 대기열이 느려지는 것이 아니라 다음 생성에 402가 반환됩니다. 오류 대신 quotaRemaining을 확인하세요.
- 사용 한도와 요청 속도 제한은 다릅니다. 잔여 한도와 관계없이 키는 60초당 120회 호출할 수 있으며 초과하면 Retry-After가 포함된 429를 반환합니다.
- 카운터는 달력의 월이 아닌 청구 월을 따릅니다. 12일에 구매한 요금제는 매월 12일에 기간이 갱신됩니다.