Skip to main content
GET
Python SDK

Credits and plans

PAYG is Pay-as-you-go. AYCE is All-you-can-eat.

When to use this endpoint

Check your balance before a paid retrieval or verification, and refresh it after a completed job. Reading your balance does not reserve or spend credits.

Example

Set REVENUEBASE_API_KEY to your API key.
Response captured from the local test API on October 13, 2026. Results can change as the dataset or account changes.

Read the response

credits is the credit balance reported for your account. It is not a row count or the daily free View allowance. This endpoint does not provide a credit-price breakdown or guarantee that an export hold will fit. Use Estimate for a contact file, Company Estimate for a company file, and the credit guide to understand holds.

Errors and next steps

Check the API key if authentication fails. If the credit service is unavailable, a 503 response can include Retry-After. Refresh the balance after a metered operation before deciding what to retrieve next.

Authorizations

x-key
string
header
required

Response

200 - application/json

Successful Response

credits
integer
required