Credit Usage

SMARTe Discover APIs operate on a credit-based consumption model. Credits are associated with your organization and are evaluated for every data retrieval request.

Credit validation occurs before processing begins. Credits are deducted only when data is successfully delivered.

How Credits Are Deducted

Each request is evaluated independently. Credit deduction is tied to data delivery, not to request submission.

Credits are calculated based on the volume of data returned and the type of data delivered.

Total Credits = Number of records returned × Applicable Credits per record

When Credits Are Deducted

Person Discover API returns person records in All mode
Company Discover API returns company records in All mode
Records are successfully returned in the response

When Credits Are Not Deducted

Preview mode is used
Stats API is used (no credits applicable)
Authentication or authorization fails
Input validation fails
The request is rate limited
No matching records are found
The response contains no data

Credit Validation

Before processing a request, SMARTe verifies that sufficient credits are available for the organization. If sufficient credits are not available:

The request is rejected
No data retrieval is performed
An error response is returned

Credit Information in Responses

For successful requests, credit-related metadata is included in response headers. Typical headers include:

credits-deducted

This information can be used for tracking and reconciliation of API usage.

Managing Credit Usage

To manage credit consumption effectively:

Use Stats API to estimate record counts before retrieving data
Use Preview mode to validate filters without consuming credits
Avoid unnecessary full data extraction

Credit allocation and replenishment are managed at the api key level.