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

# Get the current organization's credit balance

> The organization's credit balance in USD (10 credits = $1): settled is everything granted, bought, captured, refunded or adjusted; held is reserved by open holds; available is settled minus held. A capture never exceeds its hold, so spending alone cannot take available below zero; a refund or adjustment can. kinds splits what is available: planUsd is this period's plan credits, spent first and gone when the period or the plan ends; topUpUsd is credits added (bought, or granted by staff), spent after plan credits and gone a year after purchase or when the plan ends, whichever is first; topUpExpiresAt is when the soonest of those expires, null when none do.



## OpenAPI

````yaml https://api.zeroclick.io/openapi.json get /v1/organizations/current/credits
openapi: 3.0.0
info:
  title: ZeroClick API
  description: >-
    REST API for managing ZeroClick sellers, services, pricing, usage, and
    analytics. Authenticate with an API key from the ZeroClick dashboard.
  version: 1.0.0
servers:
  - url: https://api.zeroclick.io
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Sellers
  - name: Services
  - name: Meters
  - name: Plans
  - name: Plan meter prices
  - name: Usage
  - name: Analytics
  - name: Agentify
  - name: Stripe Connect
  - name: Sandbox
  - name: Organizations
  - name: Users
paths:
  /v1/organizations/current/credits:
    get:
      tags:
        - Organizations
      summary: Get the current organization's credit balance
      description: >-
        The organization's credit balance in USD (10 credits = $1): settled is
        everything granted, bought, captured, refunded or adjusted; held is
        reserved by open holds; available is settled minus held. A capture never
        exceeds its hold, so spending alone cannot take available below zero; a
        refund or adjustment can. kinds splits what is available: planUsd is
        this period's plan credits, spent first and gone when the period or the
        plan ends; topUpUsd is credits added (bought, or granted by staff),
        spent after plan credits and gone a year after purchase or when the plan
        ends, whichever is first; topUpExpiresAt is when the soonest of those
        expires, null when none do.
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  balance:
                    type: object
                    properties:
                      settledUsd:
                        type: string
                      heldUsd:
                        type: string
                      availableUsd:
                        type: string
                    required:
                      - settledUsd
                      - heldUsd
                      - availableUsd
                    additionalProperties: false
                  kinds:
                    type: object
                    properties:
                      planUsd:
                        type: string
                      topUpUsd:
                        type: string
                      topUpExpiresAt:
                        nullable: true
                        type: string
                        format: date-time
                        pattern: >-
                          ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                    required:
                      - planUsd
                      - topUpUsd
                      - topUpExpiresAt
                    additionalProperties: false
                required:
                  - balance
                  - kinds
                additionalProperties: false
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key created in the ZeroClick dashboard under Settings → API keys.
        Keys start with `zc_`. Send them as `Authorization: Bearer zc_...`.

````

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