Skip to main content

​
About

Read-only visibility into your organization’s plan and credit balances, plus current credit prices — enough for an integration or agent to check whether a credit-spending call (like a skip trace) can proceed, and to tell a human where to top up. All operations go through the developer API gateway — one endpoint, called by operationId. If you haven’t set up a key yet, start with the Developer API Overview.

​
Operations

The API never purchasesThere is no operation that buys credits or changes your plan. When a balance is low, send the user the URL from getCreditsPurchaseUrl — purchasing always happens in the app, by a person.
Which operations spend credits?Credit-spending operations require the ADMIN scope and are flagged on their own pages: enrichContact and createContactFromProperty (Contacts API), skipTraceProperty and manualSkiptrace (Properties API). Each consumes one skip-trace credit.
Scope-gated, org-scoped by your keyBilling operations take no cross-org ids, so there is no 403 forbidden here — every read is automatically scoped to your organization by the key. getBillingSummary requires the ADMIN scope; the rest are READ. See Authorization for the model.

​
Example

Check the skip-trace balance before a batch enrichment:
Full variable schemas, response shapes, and worked examples for every operation are available from the discovery endpoint.