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

# Get Budgets

> Returns the complete Budget collection for the Business Manager associated with the WhatsApp Business Phone Number ID. An empty collection means usage is unlimited.



## OpenAPI

````yaml /openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/budgets
openapi: 3.0.0
info:
  title: YCloud Meta Business Agent Public API
  version: v2
  description: >-
    Create, configure, test, and operate a Meta Business Agent for a WhatsApp
    Business phone number through YCloud.
servers:
  - url: https://api.ycloud.com/v2
    description: YCloud API base URL
security:
  - api_key: []
tags:
  - name: Meta Business Agents
    description: >-
      Meta Business Agent onboarding, knowledge, skills, connectors, tools,
      operations, and evaluations.
paths:
  /metaBusinessAgents/{entityId}/budgets:
    get:
      tags:
        - Meta Business Agents
      summary: Get Budgets
      description: >-
        Returns the complete Budget collection for the Business Manager
        associated with the WhatsApp Business Phone Number ID. An empty
        collection means usage is unlimited.
      operationId: meta-business-agent-get-budgets
      parameters:
        - name: entityId
          in: path
          required: true
          schema:
            type: string
          description: WhatsApp Business Phone Number ID that owns the Meta Business Agent.
      responses:
        '200':
          description: Operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentBudgetCollectionDTO'
        '400':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaBusinessAgentErrorResponse'
        '401':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaBusinessAgentErrorResponse'
        '403':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaBusinessAgentErrorResponse'
        '404':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaBusinessAgentErrorResponse'
        '409':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaBusinessAgentErrorResponse'
        '429':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaBusinessAgentErrorResponse'
        '500':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaBusinessAgentErrorResponse'
        '502':
          description: Request failed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetaBusinessAgentErrorResponse'
components:
  schemas:
    AgentBudgetCollectionDTO:
      type: object
      additionalProperties: false
      required:
        - budgets
      properties:
        budgets:
          type: array
          description: >-
            Complete Budget collection. Each `(unit_type, time_window)` pair is
            unique. An empty array means unlimited usage.
          items:
            $ref: '#/components/schemas/AgentBudgetDTO'
    MetaBusinessAgentErrorResponse:
      type: object
      additionalProperties: true
      properties:
        status:
          type: integer
        code:
          type: string
        message:
          type: string
        target:
          type: string
        docUrl:
          type: string
        requestId:
          type: string
        metaBusinessAgentApiError:
          $ref: '#/components/schemas/MetaBusinessAgentApiError'
    AgentBudgetDTO:
      allOf:
        - $ref: '#/components/schemas/AgentBudgetInput'
        - type: object
          required:
            - budget_id
          properties:
            budget_id:
              type: string
              minLength: 1
              description: Meta Budget ID.
    MetaBusinessAgentApiError:
      type: object
      additionalProperties: false
      properties:
        title:
          type: string
          description: Meta error title, when available.
        detail:
          type: string
          description: Actionable Meta error detail, when available.
        type:
          type: string
          description: Meta error category or URI, when available.
        status:
          type: integer
          description: Upstream HTTP status.
        requestId:
          type: string
          description: Upstream request identifier.
    AgentBudgetInput:
      type: object
      additionalProperties: false
      description: >-
        One usage limit. Each `(unit_type, time_window)` pair must be unique
        within the collection.
      required:
        - unit_type
        - time_window
        - max_budget
      properties:
        budget_id:
          type: string
          description: Required when replacing an existing Budget. Omit for a new Budget.
        unit_type:
          type: string
          enum:
            - token
            - ai_turn
          description: Usage unit controlled by this Budget.
        time_window:
          type: string
          enum:
            - one_day
            - seven_days
            - fourteen_days
            - thirty_days
          description: Rolling time window used to calculate usage.
        max_budget:
          type: integer
          format: int64
          minimum: 1
          description: Maximum usage allowed during the rolling time window.
  securitySchemes:
    api_key:
      type: apiKey
      in: header
      name: X-API-Key

````

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