> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-home-button.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter os custos de uso da organização

> Retorna um total geral e uma lista de registros diários de custo de uso da organização por entidade no período consultado (máximo de 31 dias). Todos os dias, tanto na solicitação quanto na resposta, são avaliados com base no fuso horário UTC.



## OpenAPI

````yaml /pt-BR/products/cloud/api-reference/cloud-openapi.json get /v1/organizations/{organizationId}/usageCost
openapi: 3.0.1
info:
  contact:
    email: support@clickhouse.com
    name: ClickHouse Support
    url: >-
      https://clickhouse.com/docs/en/cloud/manage/openapi?referrer=openapi-299828
  title: OpenAPI spec for ClickHouse Cloud
  version: '1.0'
servers:
  - url: https://api.clickhouse.cloud
security:
  - basicAuth: []
tags:
  - name: Organization
  - name: User management
  - name: Billing
  - name: Service
  - name: Backup
  - name: OpenAPI
  - name: Prometheus
  - name: ClickPipes
paths:
  /v1/organizations/{organizationId}/usageCost:
    get:
      tags:
        - Billing
      summary: Obter os custos de uso da organização
      description: >-
        Retorna um total geral e uma lista de registros diários de custo de uso
        da organização por entidade no período consultado (máximo de 31 dias).
        Todos os dias, tanto na solicitação quanto na resposta, são avaliados
        com base no fuso horário UTC.
      parameters:
        - description: ID da organização solicitada.
          in: path
          name: organizationId
          required: true
          schema:
            format: uuid
            type: string
        - description: Data de início do relatório, por exemplo, 2024-12-19.
          in: query
          name: from_date
          required: true
          schema:
            format: date-time
            type: string
        - description: >-
            Data de término (inclusive) do relatório, por exemplo, 2024-12-20.
            Essa data não pode ser mais de 30 dias após from_date (para um
            período máximo consultado de 31 dias).
          in: query
          name: to_date
          required: true
          schema:
            format: date-time
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  requestId:
                    description: ID único atribuído a cada solicitação. UUIDv4
                    format: uuid
                    type: string
                  result:
                    $ref: '#/components/schemas/UsageCost'
                  status:
                    description: Código de status HTTP.
                    example: 200
                    type: number
                type: object
          description: Resposta bem-sucedida
        '400':
          content:
            application/json:
              schema:
                properties:
                  error:
                    description: Descrição detalhada do erro.
                    type: string
                  status:
                    description: Código de status HTTP.
                    example: 400
                    type: number
                type: object
          description: >-
            O servidor não pode ou não quer processar a solicitação devido a
            algo considerado um erro do cliente.
components:
  schemas:
    UsageCost:
      properties:
        costs:
          $ref: '#/components/schemas/UsageCostRecord'
        grandTotalCHC:
          description: Custo total geral de uso em ClickHouse Credits (CHCs).
          type: number
    UsageCostRecord:
      properties:
        dataWarehouseId:
          description: ID do dataWarehouse ao qual esta entidade pertence (ou é).
          format: uuid
          type: string
        date:
          description: Data de uso. Data ISO-8601, baseada no fuso horário UTC.
          format: date
          type: string
        entityId:
          description: ID exclusivo da entidade.
          format: uuid
          type: string
        entityName:
          description: Nome da entidade.
          type: string
        entityType:
          description: Tipo da entidade.
          enum:
            - datawarehouse
            - service
            - clickpipe
          type: string
        locked:
          description: >-
            Quando verdadeiro, o registro é imutável. Registros desbloqueados
            podem sofrer alterações até serem bloqueados.
          type: boolean
        metrics:
          $ref: '#/components/schemas/UsageCostMetrics'
        serviceId:
          description: >-
            ID do service ao qual esta entidade pertence (ou é). Definido como
            null para entidades dataWarehouse.
          format: uuid
          nullable: true
          type: string
        totalCHC:
          description: Custo total de uso em ClickHouse Credits (CHCs) para esta entidade.
          type: number
    UsageCostMetrics:
      properties:
        backupCHC:
          description: >-
            Custo de backup em ClickHouse Credits (CHCs). Aplica-se a entidades
            dataWarehouse.
          type: number
        computeCHC:
          description: >-
            Custo de compute em ClickHouse Credits (CHCs). Aplica-se a entidades
            service e clickpipe.
          type: number
        dataTransferCHC:
          description: >-
            Custo de transferência de dados em ClickHouse Credits (CHCs).
            Aplica-se a entidades clickpipe.
          type: number
        initialLoadCHC:
          description: >-
            Custo de carga inicial e ressincronizações em ClickHouse Credits
            (CHCs). Aplica-se a entidades clickpipe.
          type: number
        interRegionTier1DataTransferCHC:
          description: >-
            Custo da transferência de dados entre regiões tier1 em ClickHouse
            Credits (CHCs). Aplica-se a entidades service.
          type: number
        interRegionTier2DataTransferCHC:
          description: >-
            Custo da transferência de dados entre regiões tier2 em ClickHouse
            Credits (CHCs). Aplica-se a entidades service.
          type: number
        interRegionTier3DataTransferCHC:
          description: >-
            Custo da transferência de dados entre regiões tier3 em ClickHouse
            Credits (CHCs). Aplica-se a entidades service.
          type: number
        interRegionTier4DataTransferCHC:
          description: >-
            Custo da transferência de dados entre regiões tier4 em ClickHouse
            Credits (CHCs). Aplica-se a entidades service.
          type: number
        publicDataTransferCHC:
          description: >-
            Custo de transferência de dados em ClickHouse Credits (CHCs).
            Aplica-se a entidades service.
          type: number
        storageCHC:
          description: >-
            Custo de armazenamento em ClickHouse Credits (CHCs). Aplica-se a
            entidades dataWarehouse.
          type: number
  securitySchemes:
    basicAuth:
      description: >-
        Use o ID da chave e o segredo da chave obtidos no ClickHouse Cloud
        console: https://clickhouse.com/docs/cloud/manage/openapi
      scheme: basic
      type: http

````