Usage Monitoring

This endpoint provides real-time information about your API usage, including details on your subscription plan, the total number of conversions, remaining conversions, and the expiration date for current limits.

Endpoint Details

Method: GET

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

Example

Below is an example response from the usage endpoint:

{
  "plan": "BASIC_MONTHLY",
  "recurring": [
    {
      "total": 2000,
      "left": 999,
      "expiryAt": "2025-01-29T23:59:26Z",
      "overage": 0
    }
  ],
  "oneTime": [
    {
      "total": 1000,
      "left": 895,
      "expiryAt": "2025-01-12T23:59:26Z"
    }
  ]
}

Response Parameters

Parameter	Type	Description	Possible Values	Example Value
plan	string	Subscription plan name.	All plan names	DEVELOPER_MONTHLY
recurring	array	Details of recurring document conversion plan.	Array with objects	[{"total": 2000, "left": 999, "expiryAt": "2025-01-29T23:59:26Z"}]
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	999
recurring.expiryAt	string (ISO 8601)	Expiration date and time for the recurring limit.	ISO 8601 datetime string in UTC	2025-01-29T23:59:26Z
recurring.overage	number	Number of overage conversions used for recurring plans.	Any non-negative integer	0
oneTime	array	Details of one-time request packs.	Array of objects	[{"total": 1000, "left": 895, "expiryAt": "2025-01-29T23:59:26Z"}]
oneTime.total	number	Total number of one-time conversions available.	Any positive integer	1000
oneTime.left	number	Number of remaining one-time conversions. Includes 0 if no conversions are left.	Any non-negative integer	895
oneTime.expiryAt	string (ISO 8601)	Expiration date and time for the one-time limit.	ISO 8601 datetime string in UTC	2025-01-12T23:59:26Z