Get credit balance

Read the active organization's credit balance and pricing

GET / v1 / credits

Current credit balance for the active organization, plus the plan and the credit pricing table. Pass `?orgId=` to target a specific organization the caller is a member of.

Query parameters

orgId string

Target a specific organization the caller belongs to. Defaults to the active org.

Responses

Balance, plan, and pricing.

balance integer required

Available credits for the organization.

plan object required

The organization's plan definition.

pricing object required

Credit cost table keyed by feature.

pricingVersion integer required

Monotonic version of the pricing table.

curl --request GET \
  --url "https://api.squirrelscan.com/v1/credits"

const res = await fetch("https://api.squirrelscan.com/v1/credits", {
  method: "GET",
});
const data = await res.json();

import requests


r = requests.get("https://api.squirrelscan.com/v1/credits")
r.raise_for_status()
data = r.json()

{
  "balance": 123,
  "plan": {},
  "pricing": {},
  "pricingVersion": 123
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>"
  }
}

Edit this page