status/creditsabovethreshold
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
https://ws.postcoder.com/pcw/{apikey}/status/creditsabovethreshold/{threshold}Path parameters
| Parameter | Description | Example |
|---|---|---|
apikey | Your API key | PCW45-12345-12345-1234X |
threshold | The number of credits that you wish to use as the threshold | 1000 |
Querystring parameters
| Parameter | Description | Example |
|---|---|---|
format | Sets the format of the response, xml or json (default unless "application/xml" header is detected) | format=json |
Example request and response
https://ws.postcoder.com/pcw/PCW45-12345-12345-1234X/status/creditsabovethreshold/1000?format=json{
"creditsabovethreshold": true
}Response fields
| Field | Description | Example |
|---|---|---|
creditsabovethreshold | A true or false to indicate whether the number of credits remaining is above the threshold supplied in the request | true |
Credit cost
This endpoint is free to use.
Buy a credit pack or set up a monthly plan for use with all Postcoder features.