Skip to main content
GET
/
api
/
accounts
/
{id}
/
credits
cURL
curl --request GET \
  --url https://api.recoupable.com/api/accounts/{id}/credits \
  --header 'x-api-key: <api-key>'
{
  "account_id": "550e8400-e29b-41d4-a716-446655440000",
  "remaining_credits": 87,
  "total_credits": 100,
  "used_credits": 13,
  "is_pro": false,
  "timestamp": "2026-05-01T12:34:56.000Z"
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Path Parameters

​
id
string<uuid>
required

The unique identifier (UUID) of the account. Must be the authenticated account or another accessible via organization membership.

Response

Credit balance retrieved successfully

​
account_id
string<uuid>
required

The unique identifier of the account this balance belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
remaining_credits
integer
required

Credits still available in the current monthly period. Refills automatically once the period elapses.

Required range: x >= 0
Example:

87

​
total_credits
integer
required

Total credits granted per monthly period for the account's current plan. Free accounts and pro accounts receive different allotments.

Required range: x >= 0
Example:

100

​
used_credits
integer
required

Credits consumed in the current monthly period. Equal to total_credits - remaining_credits.

Required range: x >= 0
Example:

13

​
is_pro
boolean
required

True when the account is on a pro plan, directly via an account subscription or via an organization subscription.

Example:

false

​
timestamp
string<date-time> | null
required

ISO 8601 timestamp of the last balance update or monthly refill. Null when the account has never spent or refilled credits.

Example:

"2026-05-01T12:34:56.000Z"