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

# Get funding status

> Returns your available funds (`available` = prepaid `balance` + promotional `credits`), your automatic recharge settings, and recent top-ups.

Requires the `billing:GetFundingStatus` permission.



## OpenAPI

````yaml /api-reference/openapi/billing.json get /billing/v1/funding
openapi: 3.0.3
info:
  title: Mount Thor Billing API
  version: 15089fd70390
  description: >-
    Read your billing account, funds, credits, prices, usage, costs and
    invoices. Amounts are exact: `units` whole currency units plus `nanos`
    billionths, never floating point.
servers:
  - url: https://customer-api.mountthor.com
security:
  - bearerAuth: []
paths:
  /billing/v1/funding:
    get:
      summary: Get funding status
      description: >-
        Returns your available funds (`available` = prepaid `balance` +
        promotional `credits`), your automatic recharge settings, and recent
        top-ups.


        Requires the `billing:GetFundingStatus` permission.
      operationId: CustomerBillingService_GetFundingStatus
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetFundingStatusResponse'
        '400':
          description: The request is invalid, for example an unknown query parameter.
          headers:
            mt-error-slug:
              description: A stable, machine-readable error identifier, when one applies.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            The credential is missing, invalid or expired. The response has no
            body.
          headers:
            mt-error-slug:
              description: A stable, machine-readable error identifier, when one applies.
              schema:
                type: string
        '403':
          description: >-
            The credential does not allow this operation. When a permission is
            missing, `requiredAction` names it; otherwise the body may be empty.
          headers:
            mt-error-slug:
              description: A stable, machine-readable error identifier, when one applies.
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    GetFundingStatusResponse:
      type: object
      properties:
        balance:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Your paid prepaid balance, excluding promotional credit.
        auto_recharge:
          allOf:
            - $ref: '#/components/schemas/AutoRechargeSettings'
          description: Your automatic recharge settings.
        recent_requests:
          type: array
          items:
            $ref: '#/components/schemas/FundingRequestSummary'
          description: Your recent top-ups, newest first.
        credits:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Unexpired promotional credit, spent before your prepaid balance.
        available:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Everything you can spend now, `balance` plus `credits`.
      description: >-
        Your funds. `available` is what you can spend now; it is `balance` plus
        `credits`.
    Error:
      type: object
      properties:
        code:
          type: integer
          description: A numeric status code.
        message:
          type: string
          description: A human-readable explanation.
        reason:
          type: string
          description: On a 403 from a missing permission, `permission_denied`.
        requiredAction:
          type: string
          description: >-
            On a 403 from a missing permission, the permission the request
            needs.
    Money:
      type: object
      properties:
        currency_code:
          type: string
          description: ISO-4217 currency code, e.g. "USD".
        units:
          type: string
          description: Whole units of the amount. May be negative.
        nanos:
          type: integer
          description: >-
            Fractional units in nanos (10^-9). For a positive amount, nanos is
            in [0, 999999999]; units and nanos must share sign.
          format: int32
      description: >-
        Money — an exact monetary amount. Never use floating point for money;
        this mirrors the google.type.Money shape (units + nanos + ISO-4217
        currency).
    AutoRechargeSettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether automatic recharge is active for the customer.
        threshold:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Recharge is triggered when the paid balance drops below this amount.
        amount:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: >-
            The balance to restore to when triggered. The charge is `amount`
            minus the paid balance at the moment of the trigger, never less than
            the payment minimum nor more than the payment maximum. Must be at
            least the payment minimum above `threshold`.
        status:
          type: string
          description: >-
            `active`, or `payment-required` when the last automatic charge
            failed or needs confirmation. Any update to these settings clears
            `payment-required`.
        last_triggered_at:
          type: string
          description: When an automatic top-up last started.
          format: date-time
      description: >-
        Automatic top-up settings: when your prepaid balance falls below
        `threshold`, your default payment method is charged to bring it back up
        to `amount`. Returned with zero values when automatic recharge was never
        set up.
    FundingRequestSummary:
      type: object
      properties:
        funding_request_id:
          type: string
        amount:
          allOf:
            - $ref: '#/components/schemas/Money'
          description: Amount requested to add to the prepaid balance.
        status:
          type: string
          description: >-
            `processing`, `needs_action` (complete the payment in the portal),
            `completed`, or `failed`. Only completed funds can be spent.
        created_at:
          type: string
          format: date-time
        source:
          type: string
          description: >-
            `manual` for Add prepaid funds, `auto-recharge` for an automatic
            top-up.
      description: One prepaid top-up.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send `Authorization: Bearer <credential>` to
        https://customer-api.mountthor.com. People use the session that `mthr
        login` stores (a token starting `mt_session_`, valid for up to 12
        hours). Automation uses a service-account credential (starting
        `mt_sa_v1_`, valid for 90 days) from Create credential. Each operation
        names the permission it needs. Service accounts hold permissions through
        custom roles, and some operations refuse them; those operations say so.

````

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