GET api/Usage?key={key}

Get zip-codes.com usage data.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
key

zip-codes.com api key

string

Required

Body Parameters

None.

Response Information

Resource Description

UsageDto
NameDescriptionTypeAdditional information
CreditsUsedToday

string

None.

CreditsUsedThisBillingCycle

string

None.

RemainingCredits

string

None.

NextBillingDate

string

None.

Error

If Error has a value then the api call failed.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "CreditsUsedToday": "sample string 1",
  "CreditsUsedThisBillingCycle": "sample string 2",
  "RemainingCredits": "sample string 3",
  "NextBillingDate": "sample string 4",
  "Error": "sample string 5"
}

text/javascript

Sample:
{"CreditsUsedToday":"sample string 1","CreditsUsedThisBillingCycle":"sample string 2","RemainingCredits":"sample string 3","NextBillingDate":"sample string 4","Error":"sample string 5"}

application/xml, text/xml

Sample:
<Usage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ccx.Xrm.ZipCodes.Controllers">
  <CreditsUsedThisBillingCycle>sample string 2</CreditsUsedThisBillingCycle>
  <CreditsUsedToday>sample string 1</CreditsUsedToday>
  <Error>sample string 5</Error>
  <NextBillingDate>sample string 4</NextBillingDate>
  <RemainingCredits>sample string 3</RemainingCredits>
</Usage>