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

# Get Paygo Balance

> Read money and admission inputs under the canonical authority lock order.



## OpenAPI

````yaml https://api.getfloo.com/openapi.json get /v1/billing/paygo/balance
openapi: 3.1.0
info:
  title: floo API
  version: 0.1.0
servers:
  - url: https://api.getfloo.com
security: []
paths:
  /v1/billing/paygo/balance:
    get:
      tags:
        - billing
      summary: Get Paygo Balance
      description: >-
        Read money and admission inputs under the canonical authority lock
        order.
      operationId: billing_get_paygo_balance
      parameters:
        - $ref: '#/components/parameters/X-Floo-Org-Id'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaygoBalanceResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  parameters:
    X-Floo-Org-Id:
      name: X-Floo-Org-Id
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: Organization to act in; defaults to the one joined most recently.
  schemas:
    PaygoBalanceResponse:
      properties:
        billing_mode:
          anyOf:
            - $ref: '#/components/schemas/BillingMode'
            - type: 'null'
        funding_eligible:
          type: boolean
          title: Funding Eligible
        activation:
          type: string
          enum:
            - dormant
            - scheduled
            - active
          title: Activation
        usage_started_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Usage Started At
        pending_nanodollars:
          type: string
          title: Pending Nanodollars
        balance_nanodollars:
          type: string
          title: Balance Nanodollars
        recorded_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Recorded At
        authority:
          anyOf:
            - $ref: '#/components/schemas/PaygoAuthorityResponse'
            - type: 'null'
        enforcement:
          anyOf:
            - $ref: '#/components/schemas/PaygoEnforcementResponse'
            - type: 'null'
      type: object
      required:
        - billing_mode
        - funding_eligible
        - activation
        - usage_started_at
        - pending_nanodollars
        - balance_nanodollars
        - recorded_at
      title: PaygoBalanceResponse
      description: >-
        Current committed money snapshot; positive credit balance does not
        authorize spending.
    ErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Body of every error response except request validation (422).
    BillingMode:
      type: string
      enum:
        - subscription
        - prepaid
      title: BillingMode
      description: Durable mutually-exclusive customer billing authority.
    PaygoAuthorityResponse:
      properties:
        state:
          $ref: '#/components/schemas/PaygoSpendState'
        stop_reason:
          anyOf:
            - $ref: '#/components/schemas/PaygoStopReason'
            - type: 'null'
        binding_authority:
          $ref: '#/components/schemas/PaygoBindingAuthority'
        balance_sequence:
          type: integer
          title: Balance Sequence
        funds_remaining_nanodollars:
          type: string
          title: Funds Remaining Nanodollars
        period_usage_nanodollars:
          type: string
          title: Period Usage Nanodollars
        hard_limit_nanodollars:
          anyOf:
            - type: string
            - type: 'null'
          title: Hard Limit Nanodollars
        remaining_nanodollars:
          type: string
          title: Remaining Nanodollars
        observed_at:
          type: string
          format: date-time
          title: Observed At
      type: object
      required:
        - state
        - stop_reason
        - binding_authority
        - balance_sequence
        - funds_remaining_nanodollars
        - period_usage_nanodollars
        - hard_limit_nanodollars
        - remaining_nanodollars
        - observed_at
      title: PaygoAuthorityResponse
      description: Current admission inputs; a read never authorizes a later operation.
    PaygoEnforcementResponse:
      properties:
        desired_blocked:
          type: boolean
          title: Desired Blocked
        generation:
          type: integer
          title: Generation
        applied_generation:
          type: integer
          title: Applied Generation
      type: object
      required:
        - desired_blocked
        - generation
        - applied_generation
      title: PaygoEnforcementResponse
      description: Recorded provider convergence, not a live workload health assessment.
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
      additionalProperties: true
      type: object
      required:
        - code
        - message
      title: ErrorDetail
      description: Standard error envelope with operation-specific JSON context.
    PaygoSpendState:
      type: string
      enum:
        - pending_activation
        - available
        - low
        - imminent
        - exhausted
        - recovered
        - unknown
      title: PaygoSpendState
      description: Customer-visible prepaid authority states.
    PaygoStopReason:
      type: string
      enum:
        - pending_activation
        - unknown
        - payment_failed
        - unpaid_ceiling
        - refund_pending
        - hard_limit
      title: PaygoStopReason
      description: Ordered reasons running prepaid services must stop.
    PaygoBindingAuthority:
      type: string
      enum:
        - funds
        - hard_limit
        - activation
        - meter_freshness
        - unknown
      title: PaygoBindingAuthority
      description: The authority currently limiting additional spend.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A `floo_` API key.

````

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