openapi: 3.2.0
info:
  description: Use the Usage Proxy API to list Oracle Support Rewards, view related detailed usage information, and manage users who redeem rewards. For more information, see [Oracle Support Rewards Overview](/iaas/Content/Billing/Concepts/supportrewardsoverview.htm).
  title: Usage Proxy Computed Usage API
  version: '20190111'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/923c4c9e7faf08854042f276c1ca058bf5c0d7901ddbf9c52717a1816a0e8d82.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Usage Proxy API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/923c4c9e7faf08854042f276c1ca058bf5c0d7901ddbf9c52717a1816a0e8d82.yaml
    what: the harvested document for Usage Proxy API
servers:
- url: https://127.0.0.1/20190111
tags:
- name: computedUsage
paths:
  /aggregatedComputedUsages:
    get:
      description: 'Collection API that returns a list of aggregated computed usage details (there can be multiple parent products under a given SubID, each of which is represented under the subscription service line # in SPM).

        '
      operationId: ListAggregatedComputedUsages
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/UsageSubscriptionIdQueryParam'
      - $ref: '#/components/parameters/DateFromQueryParam'
      - $ref: '#/components/parameters/DateToQueryParam'
      - $ref: '#/components/parameters/ParentProductQueryParam'
      - $ref: '#/components/parameters/DateGroupingQueryParam'
      - $ref: '#/components/parameters/PaginationLimitAggregatedQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Successful operation

            '
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AggregatedComputedUsageSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of Aggregated Usages
      tags:
      - computedUsage
      x-related-resource: '#/definitions/AggregatedComputedUsageSummary'
  /computedUsages:
    get:
      description: 'Collection API that returns a list of computed usages for the given filters.

        '
      operationId: ListComputedUsages
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/UsageSubscriptionIdQueryParam'
      - $ref: '#/components/parameters/DateFromQueryParam'
      - $ref: '#/components/parameters/DateToQueryParam'
      - $ref: '#/components/parameters/ParentProductNotMandatoryQueryParam'
      - $ref: '#/components/parameters/ComputedProductQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParamComputedUsage'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Successful operation

            '
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ComputedUsageSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns a list of Computed Usages and its associated cost
      tags:
      - computedUsage
  /computedUsages/{computedUsageId}:
    get:
      description: 'Returns computed usage corresponding to the passed ID.

        '
      operationId: GetComputedUsage
      parameters:
      - $ref: '#/components/parameters/ComputedUsageIdPathParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/RequestFieldsQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: 'Successful operation

            '
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a

                particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputedUsage'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Returns Computed Usage Details corresponding to the Compute Usage id passed
      tags:
      - computedUsage
components:
  parameters:
    ComputedProductQueryParam:
      description: 'Product part number for the computed usage.

        '
      in: query
      name: computedProduct
      required: false
      x-default-description: 'null'
      schema:
        type: string
    RequestFieldsQueryParam:
      description: "Partial response refers to an optimization technique offered\nby the RESTful web APIs, to return only the information \n(fields) required by the client. This parameter controls which fields to\nreturn.\n"
      in: query
      name: fields
      x-default-description: []
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    SortByQueryParamComputedUsage:
      description: 'The field to sort by. You can provide one sort order (`sortOrder`).

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - timeCreated
        - timeOfArrival
        - timeMeteredOn
        default: timeCreated
    PaginationTokenQueryParam:
      description: 'The value of the ''opc-next-page'' response header from the previous "List" call.

        '
      in: query
      name: page
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 512
        minLength: 1
    DateFromQueryParam:
      description: 'Initial date to filter computed usage data in SPM. For non-aggregated data, the time period between fromDate and toDate, expressed in RFC 3339 timestamp format.

        '
      in: query
      name: timeFrom
      required: true
      schema:
        type: string
        format: date-time
    UsageSubscriptionIdQueryParam:
      description: 'Subscription ID is an identifier associated with the service, used for filtering the computed usage in SPM.

        '
      in: query
      name: subscriptionId
      required: true
      schema:
        type: string
    ParentProductNotMandatoryQueryParam:
      description: 'Product part number for the subscribed service line, called the parent product.

        '
      in: query
      name: parentProduct
      required: false
      x-default-description: 'null'
      schema:
        type: string
    DateToQueryParam:
      description: 'Final date to filter computed usage data in SPM, expressed in RFC 3339 timestamp format.

        '
      in: query
      name: timeTo
      required: true
      schema:
        type: string
        format: date-time
    CompartmentIdQueryParam:
      description: The OCID of the root compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationLimitQueryParam:
      description: 'The maximum number of items to return in a paginated "List" call. Default: (`50`)


        Example: ''500''

        '
      in: query
      name: limit
      required: false
      x-default-description: 500
      schema:
        type: integer
        maximum: 1000
        minimum: 1
    PaginationLimitAggregatedQueryParam:
      description: "The maximum number of aggregatedComputedUsages items to return within the Subscription \"List\" call, this \ncounts the overall count across all items.\nExample: `500`\n"
      in: query
      name: limit
      schema:
        type: integer
        default: 1000
        maximum: 1000
        minimum: 1
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (''ASC'') or descending (''DESC'').

        '
      in: query
      name: sortOrder
      required: false
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    ComputedUsageIdPathParam:
      description: The computed usage ID.
      in: path
      name: computedUsageId
      required: true
      schema:
        type: string
    DateGroupingQueryParam:
      description: 'Grouping criteria to use for aggregating the computed usage, whether hourly (`HOURLY`), daily (`DAILY`), monthly (`MONTHLY`), or none (`NONE`), so as not to follow a grouping criteria by date.

        '
      in: query
      name: grouping
      required: false
      schema:
        type: string
        enum:
        - HOURLY
        - DAILY
        - MONTHLY
        - NONE
        default: MONTHLY
    OpcRequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

        '
      in: header
      name: opc-request-id
      required: false
      x-default-description: 'null'
      schema:
        type: string
    ParentProductQueryParam:
      description: 'Product part number for the subscribed service line, referred to as the parent product.

        '
      in: query
      name: parentProduct
      required: false
      x-default-description: 'null'
      schema:
        type: string
  schemas:
    Error:
      description: Error object model.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
      type: object
    ComputedUsage:
      description: 'Computed usage summary object.

        '
      properties:
        commitmentServiceId:
          description: 'Subscribed service commitment ID.

            '
          type: string
        computeSource:
          description: 'SPM (Subscription Plan Management) internal compute records source.

            '
          type: string
        cost:
          description: 'Computed unrounded line Amount.

            '
          type: string
        costRounded:
          description: 'Computed rounded line amount.

            '
          type: string
        currencyCode:
          description: 'Currency code.

            '
          type: string
        dataCenter:
          description: 'Data center attribute as sent by the meterering system to SPM.

            '
          type: string
        id:
          description: 'SPM internal computed usage ID, which is a 32-character string.

            '
          type: string
        isInvoiced:
          description: 'Invoicing status for the aggregated compute usage.

            '
          type: boolean
        mqsMessageId:
          description: 'The meterering system identfier sent to SPM. SPM does not transform this attribute and is received as-is.

            '
          type: string
        netUnitPrice:
          description: 'Net unit price for the product in consideration, price actual.

            '
          type: string
        originalUsageNumber:
          description: 'SPM internal original usage line number identifier in SPM, originating from the metered services entity.

            '
          type: string
        parentProduct:
          $ref: '#/components/schemas/ComputedUsageProduct'
        parentSubscribedServiceId:
          description: 'Subscribed service line parent ID.

            '
          example: null
          type: string
        planNumber:
          description: 'Subscription plan number.

            '
          type: string
        product:
          $ref: '#/components/schemas/ComputedUsageProduct'
        quantity:
          description: 'Total quantity that was used for computation.

            '
          format: float
          type: string
        rateCardId:
          description: 'Ratecard ID at subscribed service level.

            '
          type: string
        rateCardTierdId:
          description: 'References the tier in the rate card for the associated usage (OCI uses the same reference to cross-reference for correctness in CSV Usage Reports), obtained from the OBSCNTR_IPT_PRODUCTTIER entity.

            '
          type: string
        timeCreated:
          description: 'Computed usage created time, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        timeMeteredOn:
          description: 'Metered service date, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        timeOfArrival:
          description: 'Usage computation date, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Computed usage updated time, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        type:
          description: 'Usage compute type in SPM.

            '
          enum:
          - PROMOTION
          - DO_NOT_BILL
          - USAGE
          - COMMIT
          - OVERAGE
          - PAY_AS_YOU_GO
          - MONTHLY_MINIMUM
          - DELAYED_USAGE_INVOICE_TIMING
          - DELAYED_USAGE_COMMITMENT_EXP
          - ON_ACCOUNT_CREDIT
          - SERVICE_CREDIT
          - COMMITMENT_EXPIRATION
          - FUNDED_ALLOCATION
          - DONOT_BILL_USAGE_POST_TERMINATION
          - DELAYED_USAGE_POST_TERMINATION
          type: string
        unitOfMeasure:
          description: 'Unit of measure.

            '
          type: string
        usageNumber:
          description: 'SPM internal usage line number identifier in SPM, originating from the metered services entity.

            '
          type: string
      required:
      - id
      type: object
    ComputedUsageProduct:
      description: 'Product description.

        '
      properties:
        billingCategory:
          description: 'Metered service billing category.

            '
          type: string
        name:
          description: 'Product name.

            '
          type: string
        partNumber:
          description: 'Product part number.

            '
          type: string
        productCategory:
          description: 'Product category.

            '
          type: string
        provisioningGroup:
          description: 'Product provisioning group.

            '
          type: string
        ucmRateCardPartType:
          description: 'Rate card part type of product.

            '
          example: Free Pricing Tier - Consumption
          type: string
        unitOfMeasure:
          description: 'Unit of measure.

            '
          type: string
      required:
      - partNumber
      - name
      type: object
    AggregatedComputedUsageSummary:
      description: 'Subscribed service contract details.

        '
      properties:
        aggregatedComputedUsages:
          description: 'Aggregation of computed usages for the subscribed service.

            '
          items:
            $ref: '#/components/schemas/ComputedUsageAggregation'
          type: array
        currencyCode:
          description: 'Currency code.

            '
          example: US
          type: string
        parentProduct:
          $ref: '#/components/schemas/ComputedUsageProduct'
        parentSubscribedServiceId:
          description: 'Subscribed service line parent ID.

            '
          example: null
          type: string
        planNumber:
          description: 'Subscribed service asociated subscription plan number.

            '
          example: '10738384'
          type: string
        pricingModel:
          description: 'Subscribed services pricing model.

            '
          enum:
          - PAY_AS_YOU_GO
          - MONTHLY
          - ANNUAL
          - PREPAID
          - FUNDED_ALLOCATION
          example: PAY_AS_YOU_GO
          type: string
        rateCardId:
          description: 'Inernal SPM rate card ID at line level.

            '
          type: string
        subscriptionId:
          description: 'Subscription ID is an identifier associated with the service used for filtering the computed usage in SPM (Subscription Plan Management).

            '
          example: '7191299'
          type: string
        timeEnd:
          description: 'Subscribed services contract line end date, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        timeStart:
          description: 'Subscribed services contract line start date, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
      required:
      - subscriptionId
      type: object
    ComputedUsageSummary:
      description: 'Computed usage summary object.

        '
      properties:
        commitmentServiceId:
          description: 'Subscribed service commitment ID.

            '
          type: string
        computeSource:
          description: 'SPM (Subscription Plan Management) internal compute records source.

            '
          type: string
        computedUsageId:
          description: 'SPM internal computed usage ID, which is a 32-character string.

            '
          type: string
        cost:
          description: 'Computed unrounded line amount.

            '
          type: string
        costRounded:
          description: 'Computed rounded line amount.

            '
          type: string
        currencyCode:
          description: 'Currency code.

            '
          type: string
        dataCenter:
          description: 'Data center attribute as sent by the meterering system to SPM.

            '
          type: string
        isInvoiced:
          description: 'Invoicing status for the aggregated compute usage.

            '
          type: boolean
        mqsMessageId:
          description: 'The meterering system identfier sent to SPM. SPM does not transform this attribute and is received as-is.

            '
          type: string
        netUnitPrice:
          description: 'Net unit price for the product in consideration, price actual.

            '
          type: string
        originalUsageNumber:
          description: 'SPM internal original usage Line number identifier in SPM, originating from the metered services entity.

            '
          type: string
        parentProduct:
          $ref: '#/components/schemas/ComputedUsageProduct'
        parentSubscribedServiceId:
          description: 'Subscribed service line parent ID.

            '
          example: null
          type: string
        planNumber:
          description: 'Subscription plan number.

            '
          type: string
        product:
          $ref: '#/components/schemas/ComputedUsageProduct'
        quantity:
          description: 'Total quantity that was used for computation.

            '
          format: float
          type: string
        rateCardId:
          description: 'Rate card ID at the subscribed service level.

            '
          type: string
        rateCardTierdId:
          description: 'References the tier in the rate card for the associated usage (OCI uses the same reference to cross-reference for correctness in CSV Usage Reports), obtained from the OBSCNTR_IPT_PRODUCTTIER entity.

            '
          type: string
        timeCreated:
          description: 'Computed usage created time, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        timeMeteredOn:
          description: 'Metered service date, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        timeOfArrival:
          description: 'Usage computation date, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Computed usage updated time, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        type:
          description: 'Usage compute type in SPM.

            '
          enum:
          - PROMOTION
          - DO_NOT_BILL
          - USAGE
          - COMMIT
          - OVERAGE
          - PAY_AS_YOU_GO
          - MONTHLY_MINIMUM
          - DELAYED_USAGE_INVOICE_TIMING
          - DELAYED_USAGE_COMMITMENT_EXP
          - ON_ACCOUNT_CREDIT
          - SERVICE_CREDIT
          - COMMITMENT_EXPIRATION
          - FUNDED_ALLOCATION
          - DONOT_BILL_USAGE_POST_TERMINATION
          - DELAYED_USAGE_POST_TERMINATION
          type: string
        unitOfMeasure:
          description: 'Unit of measure.

            '
          type: string
        usageNumber:
          description: 'SPM internal usage line number identifier in SPM, originating from the metered services entity.

            '
          type: string
      required:
      - computedUsageId
      type: object
    ComputedUsageAggregation:
      description: 'Computed usage aggregation object.

        '
      properties:
        cost:
          description: 'Sum of rounded computed line amount.

            '
          example: '10.1'
          type: string
        costUnrounded:
          description: 'Sum of unrounded computed line amount.

            '
          example: '9.999999'
          type: string
        dataCenter:
          description: 'Data center attribute as sent by the meterering system to SPM (Subscription Plan Management).

            '
          type: string
        netUnitPrice:
          description: 'Net unit price for the product in consideration.

            '
          example: '3.33333'
          type: string
        product:
          $ref: '#/components/schemas/ComputedUsageProduct'
        quantity:
          description: 'Total quantity that was used for computation.

            '
          example: 3
          format: float
          type: string
        timeMeteredOn:
          description: 'Metered service date, expressed in RFC 3339 timestamp format.

            '
          format: date-time
          type: string
        type:
          description: 'Usage compute type in SPM.

            '
          enum:
          - PROMOTION
          - DO_NOT_BILL
          - USAGE
          - COMMIT
          - OVERAGE
          - PAY_AS_YOU_GO
          - MONTHLY_MINIMUM
          - DELAYED_USAGE_INVOICE_TIMING
          - DELAYED_USAGE_COMMITMENT_EXP
          - ON_ACCOUNT_CREDIT
          - SERVICE_CREDIT
          - COMMITMENT_EXPIRATION
          - FUNDED_ALLOCATION
          - DONOT_BILL_USAGE_POST_TERMINATION
          - DELAYED_USAGE_POST_TERMINATION
          example: PAY_AS_YOU_GO
          type: string
      type: object
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If

            you need to contact Oracle about a particular request,

            please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
x-oracle-package: com.oracle.pic.usage