Skip to main content
GET
Get unified credit balance
Requires credits:read. The response is a unified balance, not separate quotas per feature:
  • available: subscription plus purchased credits remaining.
  • subscription: remaining plan allocation for this cycle.
  • purchased: purchased credits remaining; these carry over.
  • used: credits consumed during the current cycle.
  • nextResetDate: subscription allocation reset timestamp, or null when no active subscription/license applies.
Lead extraction costs 1 credit per lead. Lead-database searches reserve 2 credits per requested lead and return unused credits at completion. The balance is independent of sender quotas and API rate limits.

Authorizations

X-API-Key
string
header
required

API key for authentication (prefix: sp_live_ or sp_test_)

Response

available
number
required

Total credits available now (sum of subscription + purchased buckets).

Example:

12500

subscription
number
required

Plan allocation remaining. Reset to the plan total at the start of each billing cycle.

Example:

7500

purchased
number
required

Purchased credits remaining. These never expire and roll over across billing cycles.

Example:

5000

used
number
required

Credits consumed in the current billing cycle.

Example:

2500

nextResetDate
string | null

ISO 8601 timestamp at which the subscription bucket will next reset to the plan total. null for workspaces with no active subscription/license.

Example:

"2026-06-01T00:00:00.000Z"