製品・APIガイド
利用枠を確認
このエンドポイントの返す情報
1回の呼び出しで、プランのページ数、使用済みページ数、超過利用の可否など、当月の状況を把握できます。ご自身のダッシュボードや、一括処理前の確認に利用できます。
月間利用枠、消費量、超過利用の状態を取得します。ご自身のダッシュボード内での表示に利用できます。
リクエスト
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 | 課金上の1ページの意味です。pdf-equivalentは、docxやhtmlの出力を、PDFにした場合と同じページ数として計算します。 |
メンバーと子会社
プランには、テナント単位で集計される上限がさらに2つあります。ワークスペースのメンバー数と、管理できる子会社数です。
| プラン | メンバー数 | 子会社 |
|---|---|---|
| 無料 | 2 | 0 |
| Go | 3 | 0 |
| Pro | 10 | 5 |
| Max | 無制限 | 無制限 |
メンバー数の上限を超える招待は、承諾時ではなく送信時に拒否されます。利用できない招待に時間を費やすことはありません。
よくある問題
- 生成のたびに、このエンドポイントを呼び出す必要はありません。生成レスポンスのX-PDFgine-Quota-Remainingに、追加の通信なしで同じ残量が含まれています。
- プレビューと本番生成は、別々に集計されます。プレビューでusedPagesが変わらなくても失敗ではなく、usedPreviewPagesが増えています。
- allowsOverageがfalseで利用枠を使い切ると、キューが遅くなるのではなく、次の生成で402が返されます。エラーではなくquotaRemainingを監視してください。
- 利用枠とレート制限は別の上限です。利用枠の残量に関係なく、1つのキーは60秒に120回呼び出せます。超過すると、Retry-After付きの429が返されます。
- カウンターは暦月ではなく請求月に従います。12日に購入したプランでは、毎月12日に期間が切り替わります。