Get Lookup Info

client.addressVerification.getLookupInfo(?): AddressVerificationGetLookupInfoResponse { data, message, status }

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

AddressVerificationGetLookupInfoResponse { data, message, status }

data: Data { freeLimit, used }

freeLimit: number | null

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" | "error"

One of the following:

"success"

"error"

Get Lookup Info

import PostGrid from 'postgrid-node';

const client = new PostGrid({
  addressVerificationAPIKey: process.env['POSTGRID_ADDRESS_VERIFICATION_API_KEY'], // This is the default and can be omitted
});

const response = await client.addressVerification.getLookupInfo();

console.log(response.data);

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

Returns Examples

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