Cookie consent

We use some essential cookies to make this website work. We'd like to set additional cookies to help us measure your experience when you view and interact with the website.

Cookie policy


This endpoint checks whether the number of credits available to your API key is above a threshold number that you specify in the request, and returns a true or false value accordingly.

Request URL


Path parameters

apikeyYour API keyPCW45-12345-12345-1234X
thresholdThe number of credits that you wish to use as the threshold1000

Querystring parameters

formatSets the format of the response, xml or json (default unless "application/xml" header is detected)format=json

Example request and response


	"creditsabovethreshold": true

Response fields

creditsabovethresholdA true or false to indicate whether the number of credits remaining is above the threshold supplied in the requesttrue

Credit cost

This endpoint is free to use.

Buy a credit pack or set up a monthly plan for use with all Postcoder features.