Usage Monitoring

This endpoint provides real-time information about the current usage of the API. It allows monitoring of API consumption, including the number of successful conversions made and the remaining conversions in the current billing period.

Endpoint Details

Method: GET

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

Example

Below is example response from usage endpoint:

{
  "plan": "DEVELOPER",
  "recurring": [
    {
      "total": 2000,
      "left": 999,
      "expiryAt": "2024-11-21 23:59:59"
    }
  ],
  "oneTime": [
    {
      "total": 1000,
      "left": 895,
      "expiryAt": "2024-11-16 20:05:00"
    }
  ]
}

Response Parameters

Parameter	Type	Description	Possible Values	Example Value
plan	string	Subscription plan name.	All plan names	DEVELOPER
recurring	array	Details of recurring document conversion plan.	Array of objects	[{"total": 2000, "left": 999, "expiryAt": "2024-11-16T20:05:00Z"}]
recurring.total	number	Total number of recurring conversions available.	Any positive integer	2000
recurring.left	number	Number of recurring conversions left.	Any non-negative integer (including 0)	999
recurring.expiryAt	string (ISO 8601)	Expiry date and time for the recurring limit.	ISO 8601 datetime string in UTC	2024-11-21T23:59:59Z
oneTime	array	Details of one-time request packs.	Array of objects	[{"total": 1000, "left": 895, "expiryAt": "2024-11-16T20:05:00Z"}]
oneTime.total	number	Total number of one-time conversions available.	Any positive integer	1000
oneTime.left	number	Number of one-time conversions left.	Any non-negative integer (including 0)	895
oneTime.expiryAt	string (ISO 8601)	Expiry date and time for the one-time limit.	ISO 8601 datetime string in UTC	2024-11-16T20:05:00Z