Skip to main content
GET
Get credit balance

Authorizations

Authorization
string
header
required

JWT authentication token

Response

Credit balance

available_credits
number<double>
required
issued_credits
number<double>
required
used_credits
number<double>
required
expires_at
string<date-time>
grand_total_issued_credits
number<double>

Grand total credits ever issued to this resource. For subscription customers, the sum of every monthly subscription grant (subscription_grant/renew/proration) plus all top-up purchases and positive admin amount grants. For non-subscription customers, top-up purchases and admin amount grants only. Not reduced by usage, expiry, or cancellation.

grand_total_used_credits
number<double>

Total task spend counted from the most recent admin usage reset (reset_usage event); all-time when no admin reset exists. Independent of subscription renewal/settlement window moves.

has_payment_method
boolean
has_purchased
boolean

Whether user has ever purchased credits via Stripe

is_expired
boolean
last_purchase_at
string<date-time>

Date of the most recent credit purchase

last_purchase_credits
number<double>

Credits from the most recent purchase

payment_methods
object[]
resource_type
enum<string>
Available options:
user,
team