Skip to main content

Usage Monitoring

The /v1/usage endpoint returns your current plan, remaining conversions, overage, and expiration dates. It uses the same API-KEY as the Conversion API endpoints. Use it to track conversion usage, not API request limits.

Endpoint Details

Method: GET

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

Success Example

Complete request with authentication:

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

Failure Example

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

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

Response Parameters

ParameterTypeDescriptionPossible ValuesExample Value
planstring (Enum)
  • Subscription plan name.
FREE
BASIC_MONTHLY
GROWTH_MONTHLY
ENTERPRISE_1_MONTHLY
ENTERPRISE_PRO_MONTHLY
BASIC_MONTHLY
recurringarray
  • Recurring conversion details for the current billing period.
Array of objects[{"total": 2000, "left": 1322, "expires": "2026-05-22T23:59:59Z", "overage": 0}]
recurring.totalinteger
  • Total number of recurring conversions available.
Any positive integer2000
recurring.leftinteger
  • Number of remaining recurring conversions.
  • Includes 0 if no conversions are left.
Any non-negative integer1322
recurring.expiresstring (ISO 8601)
  • Expiration date and time for the current recurring period.
ISO 8601 datetime string in UTC2026-05-22T23:59:59Z
recurring.overageinteger
  • Number of conversions used beyond your plan limit and tracked as overage.
  • Overage is disabled by default and can be enabled in your Dashboard.
Any non-negative integer0
oneTimearray
  • Active one-time conversion packages with remaining conversions.
Array of objects[{"total": 500, "left": 350, "expires": "2026-09-15T23:59:59Z"}]
oneTime.totalinteger
  • Total number of one-time conversions in the package.
Any positive integer500
oneTime.leftinteger
  • Number of remaining one-time conversions.
Any positive integer350
oneTime.expiresstring (ISO 8601)
  • Expiration date and time for the one-time credit package.
ISO 8601 datetime string in UTC2026-09-15T23:59:59Z

Next Steps