Read the owner's shared organization credit pool

Returns posted credits and reservations, in microcredits (one credit is 1000000 microcredits). Monthly entitlement posting is idempotent. Only the organization Owner may read this balance. active_meters names the currently billed sources; unreported usage is not included. platform_overrun_micros is recorded platform exposure, not customer debt. Remains available at zero credit.

get/v1/organizations/{organization_id}/credits

Request

  • Base URL: https://app.ohmyho.st
  • URL: https://app.ohmyho.st/v1/organizations/{organization_id}/credits
  • Auth: HTTP bearer

Path parameters

organization_idstring required

Headers

X-Request-Idstring

Optional caller-provided correlation identifier.

Response

Current organization credit balance.

organization_idstring required
unit'microcredits' required
as_ofstring date-time required
available_microsstring required

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

reserved_microsstring required

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

spent_microsstring required

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

expired_microsstring required

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

platform_overrun_microsstring required

Non-negative microcredits, at most 9223372036854775807. One credit equals 1000000 microcredits.

grace_started_atstring date-time nullable required

First confirmed exhaustion in this continuous period; null while funded.

grace_expires_atstring date-time nullable required

Seven days after first confirmed exhaustion. Existing services and domains are retained during this grace; no automatic data deletion. Explicit project stop budgets are separate.

active_metersstring[] required

Changes

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