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

# Get call cost

> The billable spend attributed to one call, split by cost type, with every cost line behind it. Simulated calls include the costs their simulation incurred before the call connected. Amounts are billable spend only, in exact micro-dollars (`*UsdMicros`) and dollars (`*Usd`, for display). Requires an API key with the `billing:read` permission.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/call/{callId}/cost
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Agent
  - name: Agent Endpoint
  - name: Call
  - name: Chat
  - name: Metric
  - name: Metric Policy
  - name: Metric Collection Job
  - name: Customer Flow
  - name: Customer Flow Edge Case
  - name: Simulation
  - name: Simulation Persona
  - name: Simulation Environment
  - name: Simulation Scenario
  - name: Simulation Run Plan
  - name: Simulation Template
  - name: Simulation Run Plan Job
  - name: Simulation Job
  - name: HTTP Request Definition
  - name: Webhook
  - name: Issue
  - name: Autoimprove
  - name: Agent Config
  - name: Knowledge Base
  - name: Config
  - name: Organization Project
  - name: Organization Project Member
  - name: Organization Project API Key
  - name: Organization Config
  - name: CLI Auth
  - name: Me
  - name: Project
  - name: Usage
  - name: Analytics
  - name: Dashboard
  - name: Benchmark
  - name: Health
  - name: Prospect Simulation
paths:
  /v1/call/{callId}/cost:
    get:
      tags:
        - Call
      summary: Get call cost
      description: >-
        The billable spend attributed to one call, split by cost type, with
        every cost line behind it. Simulated calls include the costs their
        simulation incurred before the call connected. Amounts are billable
        spend only, in exact micro-dollars (`*UsdMicros`) and dollars (`*Usd`,
        for display). Requires an API key with the `billing:read` permission.
      operationId: getV1CallByCallIdCost
      parameters:
        - in: path
          name: callId
          schema:
            type: string
            format: uuid
          required: true
      responses:
        '200':
          description: The call’s cost
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CallCost'
                required:
                  - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Permission error
              example:
                type: forbidden
                code: permission_denied
                message: You do not have permission to access this resource
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Call not found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Roark from '@roarkanalytics/sdk';


            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });


            const response = await
            client.call.getCost('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');


            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            response = client.call.get_cost(
                "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            )
            print(response.data)
components:
  schemas:
    CallCost:
      type: object
      properties:
        callId:
          type: string
          format: uuid
        currency:
          type: string
          const: usd
        totalUsdMicros:
          type: integer
          description: Total billable spend for this call, in micro-dollars.
        totalUsd:
          type: number
        breakdown:
          type: array
          items:
            $ref: '#/components/schemas/CostBreakdownItem'
          description: Spend by cost type. Sums to totalUsdMicros.
        items:
          type: array
          items:
            $ref: '#/components/schemas/CallCostLine'
          description: Every billable cost line attributed to the call.
      required:
        - callId
        - currency
        - totalUsdMicros
        - totalUsd
        - breakdown
        - items
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
    CostBreakdownItem:
      type: object
      properties:
        source:
          type: string
          enum:
            - SIM_PLATFORM_FEE
            - SIM_TTS
            - SIM_STT
            - SIM_LLM
            - SIM_TELEPHONY
            - METRIC
            - TRANSCRIPTION
            - INTERNAL_LLM
            - INTERNAL_STT
          description: The cost source, e.g. SIM_PLATFORM_FEE, SIM_LLM, METRIC.
        surface:
          type: string
          enum:
            - SIMULATION
            - POST_CALL
          description: SIMULATION or POST_CALL.
        amountUsdMicros:
          type: integer
          description: Billable spend for this type, in micro-dollars.
        amountUsd:
          type: number
          description: The same figure in US dollars.
        quantity:
          type: number
          minimum: 0
          description: Units billed (see the line items for the unit).
      required:
        - source
        - surface
        - amountUsdMicros
        - amountUsd
        - quantity
    CallCostLine:
      type: object
      properties:
        eventId:
          type: string
          description: Stable id of the cost event. Use it to deduplicate.
        source:
          type: string
          enum:
            - SIM_PLATFORM_FEE
            - SIM_TTS
            - SIM_STT
            - SIM_LLM
            - SIM_TELEPHONY
            - METRIC
            - TRANSCRIPTION
            - INTERNAL_LLM
            - INTERNAL_STT
        surface:
          type: string
          enum:
            - SIMULATION
            - POST_CALL
        amountUsdMicros:
          type: integer
        amountUsd:
          type: number
        quantity:
          type: number
          minimum: 0
        quantityUnit:
          type: string
          enum:
            - MINUTES
            - INPUT_TOKENS
            - OUTPUT_TOKENS
            - CHARACTERS
            - AUDIO_SECONDS
            - UNITS
        provider:
          type:
            - string
            - 'null'
        model:
          type:
            - string
            - 'null'
        simulationJobId:
          type:
            - string
            - 'null'
          format: uuid
        metricDefinitionId:
          type:
            - string
            - 'null'
          format: uuid
          description: The metric a METRIC line was charged for.
        metricCollectionJobId:
          type:
            - string
            - 'null'
          format: uuid
          description: >-
            The grading pass a METRIC line paid for. A call graded twice carries
            one line per pass.
        occurredAt:
          type: string
          description: When the cost was incurred, ISO 8601.
      required:
        - eventId
        - source
        - surface
        - amountUsdMicros
        - amountUsd
        - quantity
        - quantityUnit
        - provider
        - model
        - simulationJobId
        - metricDefinitionId
        - metricCollectionJobId
        - occurredAt
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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