Skip to main content
GET
/
account
/
credits
Get credit balance
curl --request GET \
  --url https://api.peel.sh/account/credits \
  --header 'X-API-Key: <api-key>'
{
  "auto_recharge_enabled": true,
  "auto_recharge_monthly_limit": 1,
  "auto_recharge_pack": "<string>",
  "auto_recharge_threshold": 1,
  "credits": 1,
  "current_period_end": "<string>",
  "has_subscription": true,
  "is_unlimited": true,
  "monthly_credits": 1,
  "plan": "<string>",
  "purchased_credits": 1,
  "subscription_credits": 1,
  "updated_at": "<string>",
  "used_credits": 1,
  "used_purchased_credits": 1,
  "used_subscription_credits": 1
}

Authorizations

X-API-Key
string
header
required

Response

Current credit state.

auto_recharge_enabled
boolean
required
auto_recharge_monthly_limit
integer
required
Required range: x >= 0
auto_recharge_pack
string
required
auto_recharge_threshold
integer
required
Required range: x >= 0
credits
integer
required
Required range: x >= 0
current_period_end
string | null
required
has_subscription
boolean
required
is_unlimited
boolean
required
monthly_credits
integer | null
required
Required range: x >= 0
plan
string
required
purchased_credits
integer
required
Required range: x >= 0
subscription_credits
integer
required
Required range: x >= 0
updated_at
string
required
used_credits
integer
required
Required range: x >= 0
used_purchased_credits
integer
required
Required range: x >= 0
used_subscription_credits
integer
required
Required range: x >= 0