Credits
Get credits usage
Credits
Get credits usage
Get current credit usage for the authenticated user
GET
/
api
/
v1
/
credits
curl --request GET \
--url https://vortexpdf.com/api/v1/credits \
--header 'Authorization: Bearer <token>'
{
"data": {
"credits_total": 123,
"credits_used": 123,
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"plan_name": "<string>",
"usage_details": [
{
"aggregated_value": 123,
"end_time": "2023-11-07T05:31:56Z",
"id": "<string>",
"livemode": true,
"meter": "<string>",
"start_time": "2023-11-07T05:31:56Z"
}
]
}
}
Authorizations
Manage your API keys at https://vortexpdf.com/api-keys
Response
200
application/json
Credits usage response
Current credits usage information
Total credits available in the plan
Credits used in the current billing period
Name of the user's current plan
Detailed breakdown of credits usage
Details of credits usage for a specific time period
Number of credits used
The end time of the usage period
The ID of the usage record
The meter identifier
The start time of the usage period
Whether this is a live meter or test
End date of the current billing period
Start date of the current billing period
curl --request GET \
--url https://vortexpdf.com/api/v1/credits \
--header 'Authorization: Bearer <token>'
{
"data": {
"credits_total": 123,
"credits_used": 123,
"period_end": "2023-11-07T05:31:56Z",
"period_start": "2023-11-07T05:31:56Z",
"plan_name": "<string>",
"usage_details": [
{
"aggregated_value": 123,
"end_time": "2023-11-07T05:31:56Z",
"id": "<string>",
"livemode": true,
"meter": "<string>",
"start_time": "2023-11-07T05:31:56Z"
}
]
}
}