AUautify
Credits

Get the organization's credit balance

Returns the organization's credits for the current period: how many were granted, how many are used, and how many remain. These are the same figures the Credits page in Aximo shows. Read it before a run to warn when the balance is low, instead of learning it from a run refused with 403.

Figures are in the organization's credit unit, named by creditUnit. The two units are not interchangeable, and nothing converts between them.

An organization whose contract has expired, or a request from outside the organization's IP allowlist, is refused with 403 before the balance is read.

get/api/organizations/credits

Request

Response

The organization's credit balance.

creditUnit'legacy' | 'platform' required

The unit every figure is in. platform for an organization on Autify Platform credits, legacy otherwise.

grantednumber required

Credits available this period, used plus remaining.

usednumber required

Credits used this period.

remainingnumber required

Credits left in the balance. Never negative. Does not include on-demand credits, so it can be 0 while runs still start; check onDemandRemaining and blocked.

onDemandRemainingnumber required

On-demand credits still available this period once remaining is used up. 0 when on-demand is off.

meteredboolean required

Whether this deployment enforces credits. When false, runs are never refused for credits and the figures can be ignored.

blockedboolean required

Whether starting a session or run right now would be refused with 403 and reason insufficient_credits.

Changes

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