Account Info#

Methods to get various details about your account.

/account/credit/balance#

Get remaining account balance.

  • Method: GET

  • Endpoint: /v1/account/credit/balance

Query parameters#

No query parameters accepted.

Payload#

No body parameters accepted.

Response 2#

{
    "remainingCredits": 99795868
}

CURL#

curl --location --request GET 'https://api.pdf.co/v1/account/credit/balance' \
--header 'x-api-key: '

/license/info#

Get your complete license information.

Note

This applies to the on-premises API Server only.

  • Method: GET

  • Endpoint: /license/info

Query parameters#

No query parameters accepted.

Payload#

No body parameters accepted.

Response 2#

{
    "body": {
        "modules": [
            {
                "moduleName": "PDFExtractor",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            },
            {
                "moduleName": "PDFToHTML",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            },
            {
                "moduleName": "PDFGenerator",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            },
            {
                "moduleName": "BarcodeGenerator",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            },
            {
                "moduleName": "BarcodeReader",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            },
            {
                "moduleName": "PDFRenderer",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            },
            {
                "moduleName": "Spreadsheet",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            },
            {
                "moduleName": "DocumentParser",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            },
            {
                "moduleName": "TextRecognition",
                "enabled": true,
                "licenseInfo": {
                    "LicenseType": "Commercial",
                    "UpdatesExpireOn": "Never",
                    "LimitType": "Unlimited",
                    "LimitTerm": "None",
                    "Limit": -1,
                    "Remainder": -1
                }
            }
        ]
    },
    "pageCount": 0,
    "error": false,
    "status": 200
}

CURL#

curl --location --request GET 'localhost:8080/license/info'

Footnotes

1

Supports links from Google Drive, Dropbox, and PDF.co Built-In Files Storage. To upload files via the API check out the File Upload section. Note: If you experience intermittent Too Many Requests or Access Denied errors, please try to add cache: to enable built-in URL caching. (e.g cache:https://example.com/file1.pdf) For data security, you have the option to encrypt output files and decrypt input files. Learn more about user-controlled data encryption.

2(1,2)

Main response codes as follows:

Code

Description

200

Success

400

Bad request. Typically happens because of bad input parameters, or because the input URLs can’t be reached, possibly due to access restrictions like needing a login or password.

401

Unauthorized

402

Not enough credits

445

Timeout error. To process large documents or files please use asynchronous mode (set the async parameter to true) and then check status using the /job/check endpoint. If a file contains many pages then specify a page range using the pages parameter. The number of pages of the document can be obtained using the /pdf/info endpoint.

Note

For more see the complete list of available response codes.