Get Lookup Info

GET/v1/addver/

Returns your organization’s current lookup usage and plan information. Useful for checking how many lookups you have consumed and whether you are on a paid plan.

ReturnsExpand Collapse

data: object { freeLimit, used }

freeLimit: number

The maximum number of lookups allowed in the current billing period. null indicates an unlimited plan.

used: number

The number of lookups consumed in the current billing period.

message: string

status: "success" or "error"

One of the following:

"success"

"error"

Get Lookup Info

curl https://api.postgrid.com/v1/addver/ \
    -H "X-API-Key: $POSTGRID_ADDRESS_VERIFICATION_API_KEY"

{
  "data": {
    "freeLimit": 0,
    "used": 0
  },
  "message": "message",
  "status": "success"
}

Returns Examples

{
  "data": {
    "freeLimit": 0,
    "used": 0
  },
  "message": "message",
  "status": "success"
}