How Credits Work
Upon starting an account or new subscription with Datafiniti you will receive a new allotment of credit to your account. Your credits allow you to download records when opting to download a search.
Where can I find my current credits used?
You can use the your get account API call to pull your account detail for no charge.
GET https://api.datafiniti.co/v4/account
An example of what a response would look like:
{
"role": "user",
"num_credits_used": 0,
"product_credits_used": 0,
"people_credits_used": 0,
"property_credits_used": 0,
"business_credits_used": 0,
"num_scrape_credits_used": 0,
"disabled_code": 0,
"plan_ids": [
"people-1k-99",
"property-10k-349",
"business-1k-trial",
"product-1k-trial"
],
"auto_collect_enabled": true,
"overage_limit": 100,
"payment_type": "cc",
"overages_enabled": false,
"first_name": "leonard Mcgee",
"last_name": "Trahan",
"email": "[email protected]",
"organization": "test5",
"features": [
{
"enabledFields": [
"view",
"download"
],
"name": "people:search"
},
{
"enabledFields": [
"view"
],
"name": "people:paginate"
},
{
"enabledFields": [
"view",
"download"
],
"name": "property:search"
},
{
"enabledFields": [
"view"
],
"name": "property:paginate"
},
{
"enabledFields": [
"view",
"download"
],
"name": "business:search"
},
{
"enabledFields": [
"view"
],
"name": "business:paginate"
},
{
"enabledFields": [
"view",
"download"
],
"name": "product:search"
},
{
"enabledFields": [
"view"
],
"name": "product:paginate"
}
],
"customer_id": "cus_PwAxhL7ziAxv6C",
"date_created": "2024-04-16T20:28:20.279Z",
"date_updated": "2024-04-22T17:30:15.145Z",
"is_admin": false,
"id": 402
}
Determining what data you have access to
Our plans allow flexibility in both price and use of credits per month depend on what plan your account is subscribed to. Your can check your plan_ids to check what data types you have access to.
{
"plan_ids": [
"people-1k-99",
"property-10k-349",
"business-1k-trial",
"product-1k-trial"
]
}
Plan ids are commonly prefix with the data type it pertains to.
However if you have a custom plan or need help figuring out your data plan please contact [email protected]
Find your credits used
You can also use your GET https://api.datafiniti.co/v4/account to check your credits used of your account.
Credit used are broken up by data type:
num_credits_used- legacy plan API calls.product_credits_used- product data API calls.people_credits_used- people data API calls.property_credits_used- property data API calls.business_credits_used- business data API calls.num_scrape_credits_used- scrape & targeted update API calls.
"num_credits_used": 0,
"product_credits_used": 0,
"people_credits_used": 0,
"property_credits_used": 0,
"business_credits_used": 0,
"num_scrape_credits_used": 0,
When Are Credits Charged to Your Account?
There are multiple ways to spend credits. Let go through the ways this can happen:
API Searches
No matter what data type you are using for a search API call, you are charged credits up to your num_records set in the body of the call.
For example if I search for property using the follow call through postman:
POST https://api.datafiniti.co/v4/properties/search
{
"query": "address:\"4801 Yucca Hl Dr\" AND province:TX AND (city:Austin OR postalCode:78744)",
"num_records":10
}
You will recieve this response:
{
"num_found": 1,
"total_cost": 1,
"records": [
" "address": "4801 Yucca Hl Dr",
"brokers": [
{
"agent": "Ryana Stevson",
"company": "Stevson Property Management",
"dateSeen": "2023-10-30T04:08:00.000Z",
"phones": [
"(512) 670-8269"
]
},
{
"agent": "Leasing Office",
"company": "Stetson Property Management",
"dateSeen": "2024-03-29T17:16:38.560Z",
"phones": [
"(512) 670-8269"
]
}
]
}
In this case since 1 record was found, only 1 property_credit_used was charged.
Credits Used On Search May Vary
If the credits consumed is under the stated credits consumed by the Search API, Datafiniti will only charge for the amount of records found.
Example:
If only 10 records are displayed, we charge 10 credits.
If 0 records are found, no credits will be charged.
Any time you attempt a download of the records found by a search, a Download_id will be presented in the response of the API call. Your total_cost will dictate how many credits your account was charge on the download.
Overages
Depending on the amount of credits needed to download a searched query, you will be charged an overage fee equal to the amount of credits over your credit's available. NOTE you will not be able to download the data files generated to your account until the overages are paid. If you do not know if your account is setup for overages, please contact us at [email protected]
Enrichment & Suppression API
Enrichment & Suppression API calls are based on the number of num_record will be charge against your account upon submitting this request. Once the call is submitted and complete the total_cost. (Same as a normal download works) However this total is only comprehensive once the status of the download is complete.
For more information on Enrichment & Suppression, you can read more about it here.
Before using enrichment & suppression
Since Enrichment charge credit per the batch file you are enriching data from, you may be overcharged credits to your account upon submitting a enrichment request. If you do not know if overcharging is enable / disable on your account you may contact [email protected] to find this info out.
Credit limit refresh period
Your credits to your Datafiniti account refresh period is based on of your data plan subscription. This can vary from monthly to annually. For standard tier plans you can check your settings page here. Please consult with your Datafiniti representative if you do not know your plan's refresh rate.
Updated 8 months ago