All functions

getCredits

Returns the current day's credit usage statistics for the authenticated organization, including credits used, the daily limit based on the active plan, and the remaining balance.

GET/creditsAPI docs

Free

Use cases

Dashboard credit monitoring

Display real-time credit consumption in your app dashboard. Integrate the credits API into your admin panel to show used/remaining credits and warn users before they hit their limit.

Workflow automation with n8n or Make

Build automated workflows that check credit balance before processing batches. Use the credits endpoint as a conditional gate to pause expensive operations when credits run low.

Parameters

NameTypeDescription
organizationIdstringrequiredThe ID of the organization to query credits for

Response

NameTypeDescription
usednumberCredits consumed this billing period
limitnumberMaximum credits available per billing period
remainingnumberCredits still available (limit minus used)