Billing Mechanism

This page describes the billing mechanism for each APIs.

Get Geophrase Detail

GET https://api.geophrase.com/business/geophrases/{Geophrase}/

• Each successful request (that returns 200 status code) debits the wallet one unit of READ usage charge.

• To make the billing fair, we do not charge for a 404 status code. This is to handle the scenario that a user provides a non-existing or invalid Geophrase that ends up costing you money.

  We do not charge for a 404 status code for fairness reason. But if we have verifiable evidence that you are treating it as a loophole and exploiting it, your account may be permanently banned.

Bulk Read

POST https://api.geophrase.com/business/geophrases-bulk-read/

• Each successful request (that returns 200 status code) debits the wallet n units of READ usage charge. Where n = length of the array in request body.

• If some or all of the Geophrases you passed in the request body do not exist, you will still be charged for all the elements in the request array.

Get Own Geophrases

GET https://api.geophrase.com/business/geophrases/

• Each successful request (that returns 200 status code) debits the wallet one unit of READ usage charge.

• Since you get 100 items at max in a single page, if you have to retrieve multiple pages, requesting each page will debit the wallet one unit of READ usage charge.

Create a Geophrase

POST https://api.geophrase.com/business/geophrases/

• Each successful request (that returns 201 status code) debits the wallet 1 unit of WRITE usage charge.

Update a Geophrase

PATCH https://api.geophrase.com/business/geophrases/{Geophrase}/

• Each successful request (that returns 200 status code) debits the wallet 1 unit of WRITE usage charge.

Delete a Geophrase

DELETE https://api.geophrase.com/business/geophrases/{Geophrase}/

• Each successful request (that returns 204 status code) debits the wallet 1 unit of WRITE usage charge.

Bulk Create

POST https://api.geophrase.com/business/geophrases-bulk-create/

• Each successful request (that returns 201 status code) debits the wallet n units of WRITE usage charge. Where n = length of the array in request body.

• If some or all of the JSON objects you passed in the request body contain some bad data, e.g. non existing postal code, you will still be charged for all the elements in the request array.

Next step

To know pricing for READ and WRITE usage, visit Pricing page.