Skip to main content
GET
/
v1
/
credits
curl https://api.sendpilot.ai/v1/credits \
  -H "X-API-Key: YOUR_API_KEY"
{
  "available": 12500,
  "subscription": 7500,
  "purchased": 5000,
  "used": 2500,
  "nextResetDate": "2026-06-01T00:00:00.000Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.sendpilot.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns your workspace’s current credits balance, usage, and quota information.

Request

X-API-Key
string
required
Your API key

Response

available
number
Total credits currently available across all buckets (subscription + purchased).
subscription
number
Remaining subscription/AppSumo credits for the current billing cycle.These reset back to the plan allocation at the beginning of each billing cycle.
purchased
number
Remaining purchased credits.Purchased credits never expire and roll over across billing cycles.
used
number
Credits consumed during the current billing cycle.
nextResetDate
string
ISO 8601 timestamp indicating when the subscription credit bucket will next reset.Returns null for workspaces without an active subscription or license.
curl https://api.sendpilot.ai/v1/credits \
  -H "X-API-Key: YOUR_API_KEY"
{
  "available": 12500,
  "subscription": 7500,
  "purchased": 5000,
  "used": 2500,
  "nextResetDate": "2026-06-01T00:00:00.000Z"
}
Credits are tracked using two buckets:
  • Subscription credits — Included with your active plan or AppSumo license and reset every billing cycle.
  • Purchased credits — One-time purchased credits that never expire and roll over indefinitely.
The available field represents the combined total of both buckets.

Authorizations

X-API-Key
string
header
required

API key for authentication

Response

Credits balance and quota information

Credits balance and quota information for all features

available
number
required

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

Example:

12500

subscription
number
required

Subscription/AppSumo 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"