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

# Consultar consumo

> Obtiene un desglose detallado del consumo de créditos por periodo y tipo de acción.

## Query Parameters

<ParamField query="startDate" type="string" required>
  Fecha inicio en formato ISO 8601 (ej. `2026-05-01T00:00:00Z`).
</ParamField>

<ParamField query="endDate" type="string" required>
  Fecha fin en formato ISO 8601.
</ParamField>

<ParamField query="groupBy" type="string" default="day">
  Agrupar resultados por: `day` o `action`.
</ParamField>

<ResponseExample>
  ```json 200 groupBy=action theme={null}
  {
    "startDate": "2026-05-01T00:00:00Z",
    "endDate": "2026-05-14T23:59:59Z",
    "totalCredits": 1550,
    "breakdown": [
      { "action": "call", "credits": 890, "count": 15 },
      { "action": "conversation", "credits": 340, "count": 22 },
      { "action": "schedule.whatsapp", "credits": 150, "count": 50 },
      { "action": "schedule.sms", "credits": 100, "count": 50 },
      { "action": "schedule.email", "credits": 70, "count": 70 },
      { "action": "schedule.app", "credits": 0, "count": 45 }
    ]
  }
  ```

  ```json 200 groupBy=day theme={null}
  {
    "startDate": "2026-05-01T00:00:00Z",
    "endDate": "2026-05-03T23:59:59Z",
    "totalCredits": 320,
    "breakdown": [
      { "date": "2026-05-01", "credits": 120, "count": 18 },
      { "date": "2026-05-02", "credits": 95, "count": 12 },
      { "date": "2026-05-03", "credits": 105, "count": 15 }
    ]
  }
  ```
</ResponseExample>

<ResponseField name="totalCredits" type="integer">
  Total de créditos consumidos en el periodo consultado.
</ResponseField>

<ResponseField name="breakdown" type="array">
  Desglose del consumo según la agrupación seleccionada.
</ResponseField>

<ResponseField name="breakdown[].action" type="string">
  Tipo de acción (cuando `groupBy=action`): `call`, `conversation`, `schedule.email`, `schedule.sms`, `schedule.whatsapp`, `schedule.app`.
</ResponseField>

<ResponseField name="breakdown[].count" type="integer">
  Número de operaciones realizadas.
</ResponseField>


## OpenAPI

````yaml openapi.yml GET /billing/consumption
openapi: 3.1.0
info:
  title: LINA Healthcare Platform API
  version: 1.0.0
  description: |
    API de integración para la plataforma LINA Healthcare.
    Todas las rutas requieren un token JWT obtenido intercambiando una API Key.
servers:
  - url: https://api.linahealthcareplatform.com/api/v1
    description: Production
security:
  - bearerAuth: []
paths:
  /billing/consumption:
    get:
      tags:
        - Créditos
      summary: Consultar consumo
      operationId: getConsumption
      parameters:
        - name: startDate
          in: query
          schema:
            type: string
            format: date
        - name: endDate
          in: query
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Consumo
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Token JWT obtenido via POST /auth/token

````