Credits

Get credit balance

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.

get/v1/credits

Request

  • Base URL: https://api.squirrelscan.com
  • URL: https://api.squirrelscan.com/v1/credits
  • Auth: HTTP bearer

Query parameters

orgIdstring

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

Response

Balance, plan, and pricing.

balanceinteger required

Available credits for the organization.

planobject required

The organization's plan definition.

pricingobject required

Credit cost table keyed by feature.

pricingVersioninteger required

Monotonic version of the pricing table.

Changes

No recorded changes to this operation across all 1 revision of this API.