---
title: "Query feature cost"
url: "https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-private-0/versions/6e18e75c-446e-4fe4-8c39-2ccdd58e22a9/operations/query-feature-cost"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-metering-billing-private-0/versions/6e18e75c-446e-4fe4-8c39-2ccdd58e22a9.md

# Query feature cost

`POST` `/openmeter/features/{featureId}/cost/query`

Operation ID: `query-feature-cost`

Query the cost of a feature.

## Path parameters

- `featureId` (string, required)

## Request body

Content types: `application/json`

## Responses

- `200` - The request has succeeded.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Konnect Metering & Billing
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /openmeter/features/{featureId}/cost/query:
    post:
      operationId: query-feature-cost
      summary: Query feature cost
      description: Query the cost of a feature.
      parameters:
        - name: featureId
          in: path
          required: true
          schema:
            $ref: "#/components/schemas/ULID"
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/MeterQueryRequest"
      responses:
        "200":
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/FeatureCostQueryResult"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      tags:
        - OpenMeter Features
security:
  - systemAccountAccessToken: []
  - personalAccessToken: []
  - konnectAccessToken: []
components:
  schemas:
    ULID:
      description: ULID (Universally Unique Lexicographically Sortable Identifier).
      type: string
      example: 01G65Z755AFWAKHE12NY0CQ9FH
      pattern: ^[0-7][0-9A-HJKMNP-TV-Z]{25}$
      title: ULID
    MeterQueryRequest:
      description: A meter query request.
      type: object
      properties:
        from:
          description: The start of the period the usage is queried from.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          title: RFC3339 Date-Time
        to:
          description: The end of the period the usage is queried to.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          title: RFC3339 Date-Time
        granularity:
          description: |-
            The size of the time buckets to group the usage into.
            If not specified, the usage is aggregated over the entire period.
          type: string
          enum:
            - PT1M
            - PT1H
            - P1D
            - P1M
        time_zone:
          description: >-
            The value is the name of the time zone as defined in the IANA Time
            Zone Database (http://www.iana.org/time-zones).

            The time zone is used to determine the start and end of the time
            buckets.

            If not specified, the UTC timezone will be used.
          type: string
          default: UTC
        group_by_dimensions:
          description: The dimensions to group the results by.
          type: array
          items:
            type: string
          example:
            - model
            - type
          maxItems: 100
        filters:
          description: Filters to apply to the query.
          type: object
          properties:
            dimensions:
              description: >-
                Filters to apply to the dimensions of the query.

                For `subject` and `customer_id` only equals ("eq", "in")
                comparisons are supported.
              type: object
              additionalProperties:
                $ref: "#/components/schemas/QueryFilterStringMapItem"
              maxProperties: 10
      example:
        from: 2023-01-01T00:00:00Z
        to: 2023-01-02T00:00:00Z
        granularity: P1D
        time_zone: UTC
    FeatureCostQueryResult:
      description: Result of a feature cost query.
      type: object
      properties:
        from:
          description: Start of the queried period.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          title: RFC3339 Date-Time
        to:
          description: End of the queried period.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          title: RFC3339 Date-Time
        data:
          description: The cost data rows.
          type: array
          items:
            $ref: "#/components/schemas/FeatureCostQueryRow"
      required:
        - data
    QueryFilterStringMapItem:
      description: >-
        A query filter for an item in a string map attribute.

        Operators are mutually exclusive, only one operator is allowed at a
        time.
      type: object
      properties:
        exists:
          description: The attribute exists.
          type: boolean
        eq:
          description: The attribute equals the provided value.
          type: string
        neq:
          description: The attribute does not equal the provided value.
          type: string
        in:
          description: The attribute is one of the provided values.
          type: array
          items:
            type: string
          maxItems: 100
          minItems: 1
        nin:
          description: The attribute is not one of the provided values.
          type: array
          items:
            type: string
          maxItems: 100
          minItems: 1
        contains:
          description: The attribute contains the provided value.
          type: string
        ncontains:
          description: The attribute does not contain the provided value.
          type: string
        and:
          description: Combines the provided filters with a logical AND.
          type: array
          items:
            $ref: "#/components/schemas/QueryFilterString"
          maxItems: 10
          minItems: 1
        or:
          description: Combines the provided filters with a logical OR.
          type: array
          items:
            $ref: "#/components/schemas/QueryFilterString"
          maxItems: 10
          minItems: 1
      additionalProperties:
        not: {}
      maxProperties: 1
      minProperties: 1
      title: Query String Map Item Filter
    FeatureCostQueryRow:
      description: A row in the result of a feature cost query.
      type: object
      properties:
        usage:
          description: The metered usage value for the period.
          type: string
          pattern: ^\-?[0-9]+(\.[0-9]+)?$
        cost:
          description: >-
            The computed cost amount (usage × unit cost).

            Null when pricing is not available for the given combination of
            dimensions.
          type: string
          nullable: true
          pattern: ^\-?[0-9]+(\.[0-9]+)?$
        currency:
          description: The currency code of the cost amount.
          type: string
          example: USD
          maxLength: 3
          minLength: 3
          pattern: ^[A-Z]{3}$
        detail:
          description: Detail message when cost amount is null, explaining why the cost
            could not be resolved.
          type: string
        from:
          description: The start of the time bucket the value is aggregated over.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          title: RFC3339 Date-Time
        to:
          description: The end of the time bucket the value is aggregated over.
          type: string
          format: date-time
          example: 2023-01-01T01:01:01.001Z
          title: RFC3339 Date-Time
        dimensions:
          description: |-
            The dimensions the value is aggregated over.
            `subject` and `customer_id` are reserved dimensions.
          type: object
          additionalProperties:
            type: string
      required:
        - usage
        - cost
        - currency
        - from
        - to
        - dimensions
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    QueryFilterString:
      description: >-
        A query filter for a string attribute.

        Operators are mutually exclusive, only one operator is allowed at a
        time.
      type: object
      properties:
        eq:
          description: The attribute equals the provided value.
          type: string
        neq:
          description: The attribute does not equal the provided value.
          type: string
        in:
          description: The attribute is one of the provided values.
          type: array
          items:
            type: string
          maxItems: 100
          minItems: 1
        nin:
          description: The attribute is not one of the provided values.
          type: array
          items:
            type: string
          maxItems: 100
          minItems: 1
        contains:
          description: The attribute contains the provided value.
          type: string
        ncontains:
          description: The attribute does not contain the provided value.
          type: string
        and:
          description: Combines the provided filters with a logical AND.
          type: array
          items:
            $ref: "#/components/schemas/QueryFilterString"
          maxItems: 10
          minItems: 1
        or:
          description: Combines the provided filters with a logical OR.
          type: array
          items:
            $ref: "#/components/schemas/QueryFilterString"
          maxItems: 10
          minItems: 1
      additionalProperties:
        not: {}
      maxProperties: 1
      minProperties: 1
      title: Query String Filter
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  examples:
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
