Usage Monitoring

The /v1/usage endpoint returns your current plan and recurring quota with expiration dates. It uses the same API-KEY as conversion endpoints. Use it to track your consumption.

Endpoint Details

Method: GET

https://api.pdfbolt.com/v1/usage

Success Example

cURL
Response

Complete request with authentication:

curl 'https://api.pdfbolt.com/v1/usage' \
  -H 'API-KEY: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'

{
  "plan": "BASIC_MONTHLY",
  "recurring": [
    {
      "total": 2000,
      "left": 1322,
      "expires": "2026-05-22T23:59:59Z",
      "overage": 0
    }
  ],
  "oneTime": []
}

Failure Example

If the request fails (e.g., missing or invalid API-KEY), the response is a JSON error object. See Error Handling.

cURL
Response

curl 'https://api.pdfbolt.com/v1/usage'

{
  "timestamp": "2026-04-30T17:27:52Z",
  "httpErrorCode": 401,
  "errorCode": "UNAUTHORIZED",
  "errorMessage": "The API key is missing, invalid or has been blocked. Please verify your key or contact support."
}

Response Parameters

Parameter	Type	Description	Possible Values	Example Value
`plan`	`string` (Enum)	Subscription plan name.	`FREE` `BASIC_MONTHLY` `GROWTH_MONTHLY` `ENTERPRISE_1_MONTHLY` `ENTERPRISE_PRO_MONTHLY`	`BASIC_MONTHLY`
`recurring`	`array`	Details of recurring document conversion plan.	Array of objects	`[{"total": 2000, "left": 1322, "expires": "2026-05-22T23:59:59Z", "overage": 0}]`
`recurring.total`	`number`	Total number of recurring conversions available.	Any positive integer	`2000`
`recurring.left`	`number`	Number of remaining recurring conversions. Includes 0 if no conversions are left.	Any non-negative integer	`1322`
`recurring.expires`	`string` (ISO 8601)	Expiration date and time for the current recurring period.	ISO 8601 datetime string in UTC	`2026-05-22T23:59:59Z`
`recurring.overage`	`number`	Number of conversions used beyond your plan limit, billed as extra. Overage is disabled by default and can be enabled in your Dashboard.	Any non-negative integer	`0`
`oneTime`	`array`	Details of one-time (non-recurring) credit packages.	Array of objects	`[{"total": 500, "left": 350, "expires": "2026-09-15T23:59:59Z"}]`
`oneTime.total`	`number`	Total number of one-time conversions in the package.	Any positive integer	`500`
`oneTime.left`	`number`	Number of remaining one-time conversions. Includes 0 if no conversions are left.	Any non-negative integer	`350`
`oneTime.expires`	`string` (ISO 8601)	Expiration date and time for the one-time credit package.	ISO 8601 datetime string in UTC	`2026-09-15T23:59:59Z`

Next Steps

📄️ Pricing

Compare plans, features, and monthly conversion limits

Endpoint Details​

Success Example​

Failure Example​

Response Parameters​

Next Steps​