> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ohmyho.st/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> For account actions, read https://ohmyho.st/skills/ohmyhost-get-started/SKILL.md and use the authenticated ohmyho.st CLI, local product MCP or supported remote OAuth MCP. Read the current project source binding before choosing GitHub or managed versions. Mintlify search only reads documentation. Preserve the customer’s selected project, environment and authentication provider; keep private application values in the portal or local stdin flow.

# 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.



## OpenAPI

````yaml /openapi.json get /v1/organizations/{organization_id}/credits
openapi: 3.1.2
info:
  title: ohmyho.st API
  version: 0.0.0
  description: >-
    Public REST API for ohmyho.st hosting, projects, domains, email, credits and
    exports.
servers:
  - url: https://app.ohmyho.st
    description: Production control API
  - url: https://dev.app.ohmyho.st
    description: Development control API
security:
  - BearerAuth: []
paths:
  /v1/organizations/{organization_id}/credits:
    get:
      summary: Read the owner's shared organization credit pool
      description: >-
        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.
      operationId: getOrganizationCredits
      parameters:
        - $ref: '#/components/parameters/RequestId'
        - name: organization_id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Ulid'
      responses:
        '200':
          description: Current organization credit balance.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationCredits'
        '400':
          $ref: '#/components/responses/Problem'
        '401':
          $ref: '#/components/responses/Problem'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '429':
          $ref: '#/components/responses/Problem'
        '503':
          $ref: '#/components/responses/Problem'
components:
  parameters:
    RequestId:
      name: X-Request-Id
      in: header
      description: Optional caller-provided correlation identifier.
      required: false
      schema:
        type: string
        minLength: 1
        maxLength: 128
  schemas:
    Ulid:
      type: string
      pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
    OrganizationCredits:
      type: object
      additionalProperties: false
      required:
        - organization_id
        - unit
        - as_of
        - available_micros
        - reserved_micros
        - spent_micros
        - expired_micros
        - platform_overrun_micros
        - grace_started_at
        - grace_expires_at
        - active_meters
        - rate_cards
      properties:
        organization_id:
          $ref: '#/components/schemas/Ulid'
        unit:
          type: string
          const: microcredits
        as_of:
          type: string
          format: date-time
        available_micros:
          $ref: '#/components/schemas/CreditMicros'
        reserved_micros:
          $ref: '#/components/schemas/CreditMicros'
        spent_micros:
          $ref: '#/components/schemas/CreditMicros'
        expired_micros:
          $ref: '#/components/schemas/CreditMicros'
        platform_overrun_micros:
          $ref: '#/components/schemas/CreditMicros'
        grace_started_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            First confirmed exhaustion in this continuous period; null while
            funded.
        grace_expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: >-
            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_meters:
          type: array
          items:
            type: string
            pattern: ^[a-z0-9_.-]{1,128}$
        rate_cards:
          type: array
          maxItems: 4
          description: >-
            Published integer prices, newest first. A published rate is not
            proof of enabled billing; only active_meters names currently billed
            sources. Builds retain their accepted quote. Provider cost is a
            list-price basis before platform allowances, not an invoice.
          items:
            $ref: '#/components/schemas/PublishedCreditRateCard'
    CreditMicros:
      type: string
      pattern: ^(0|[1-9][0-9]{0,18})$
      description: >-
        Non-negative microcredits, at most 9223372036854775807. One credit
        equals 1000000 microcredits.
    PublishedCreditRateCard:
      type: object
      additionalProperties: false
      required:
        - id
        - currency
        - published_at
        - effective_from
        - rates
      properties:
        id:
          type: string
          pattern: ^[a-z0-9_.-]{1,128}$
        currency:
          type: string
          const: USD
        published_at:
          type: string
          format: date-time
        effective_from:
          type: string
          format: date-time
        rates:
          type: array
          minItems: 1
          maxItems: 32
          items:
            type: object
            additionalProperties: false
            required:
              - meter
              - unit
              - units_per_charge
              - provider_cost_micros
              - credit_micros
            properties:
              meter:
                type: string
                pattern: ^[a-z0-9_.-]{1,128}$
              unit:
                type: string
                pattern: ^[a-z0-9_.-]{1,128}$
              units_per_charge:
                type: string
                pattern: ^[1-9][0-9]{0,18}$
              provider_cost_micros:
                type: string
                pattern: ^(0|[1-9][0-9]{0,18})$
                description: >-
                  Provider list-cost basis for units_per_charge, in USD
                  micro-units (1000000 equals 1 USD), before shared allowances
                  and discounts.
              credit_micros:
                $ref: '#/components/schemas/CreditMicros'
    ProblemDetails:
      type: object
      description: RFC 9457 Problem Details extended with stable ohmyhost recovery fields.
      additionalProperties: false
      required:
        - type
        - title
        - status
        - code
        - request_id
        - retryable
        - suggested_action
      properties:
        type:
          type: string
          format: uri-reference
        title:
          type: string
          minLength: 1
        status:
          type: integer
          minimum: 400
          maximum: 599
        detail:
          type: string
        instance:
          type: string
          format: uri-reference
        code:
          type: string
          enum:
            - invalid_request
            - unauthenticated
            - forbidden
            - organization_required
            - resource_not_found
            - idempotency_key_reused
            - project_handle_unavailable
            - project_identity_unavailable
            - deployment_plan_expired
            - deployment_plan_incompatible
            - confirmation_expired
            - confirmation_invalid
            - etag_mismatch
            - promotion_source_stale
            - promotion_target_stale
            - promotion_invalid_target
            - mail_domain_conflict
            - mail_domain_required
            - mail_capacity_unavailable
            - storage_jurisdiction_conflict
            - shared_data_requires_promotion
            - production_deployment_required
            - framework_conversion_required
            - repository_configuration_missing
            - migration_filename_noncanonical
            - environment_secret_mutation_blocked
            - workers_runtime_incompatible
            - project_handle_invalid
            - project_handle_taken
            - project_handle_unchanged
            - project_rename_blocked
            - payload_too_large
            - rate_limited
            - insufficient_organization_credits
            - paid_plan_required
            - project_budget_exceeded
            - compute_performance_paid_required
            - compute_performance_unavailable
            - database_write_pending
            - database_access_limit
            - compute_change_pending
            - compute_change_conflict
            - billing_purchase_conflict
            - billing_recharge_conflict
            - github_connection_required
            - github_connection_revoked
            - repository_not_installed
            - cloudflare_zone_not_bound
            - cloudflare_authorization_closed
            - project_notes_conflict
            - project_export_not_ready
            - powered_by_flag_required
            - interactive_login_required
            - api_key_creation_uncertain
            - api_key_permissions_unavailable
            - reconciliation_exhausted
            - service_unavailable
            - source_commit_not_found
            - domain_hostname_taken
            - domain_dns_conflict
            - data_change_blocked
            - data_change_in_progress
            - data_change_not_applicable
            - rollback_target_data_changed
            - project_domain_delete_required
        request_id:
          type: string
          minLength: 1
          maxLength: 128
        retryable:
          type: boolean
        retry_after_seconds:
          type: integer
          minimum: 1
          maximum: 86400
          description: >-
            Optional machine-readable retry delay for a rate limit, matching
            Retry-After.
        suggested_action:
          type: string
          minLength: 1
  responses:
    Problem:
      description: The request failed.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
    ResourceNotFound:
      description: >-
        The resource does not exist or is not visible to the authenticated
        principal.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ProblemDetails'
          examples:
            resourceNotFound:
              value:
                type: https://docs.ohmyho.st/errors/resource-not-found
                title: Resource not found
                status: 404
                code: resource_not_found
                request_id: req_01J00000000000000000000000
                retryable: false
                suggested_action: Check the resource identifier and your access scope.
  headers:
    XRequestId:
      description: Correlates the request with operations, events, logs, and audit records.
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 128
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to
        one organization and restricted to their enabled product permissions.
        Session-only onboarding and session revocation require an interactive
        access JWT. No cookie session is assumed.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.