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 Ratecard 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: ratecard
paths:
  /ratecards:
    get:
      description: 'Returns all rate cards for a given subscription ID and account ID (if provided), and

        for a particular date range.

        '
      operationId: ListRateCards
      parameters:
      - description: 'Line-level subscription ID.

          '
        in: query
        name: subscriptionId
        required: true
        schema:
          type: string
      - description: 'Gets the rate cards whose effective start date starts on or after a particular date.

          '
        in: query
        name: timeFrom
        required: false
        x-default-description: 'null'
        schema:
          type: string
          format: date-time
      - description: 'Gets the rate cards whose effective end date ends on or before a particular date.

          '
        in: query
        name: timeTo
        required: false
        x-default-description: 'null'
        schema:
          type: string
          format: date-time
      - description: 'Gets the rate cards filterd by the part number.

          '
        in: query
        name: partNumber
        required: false
        x-default-description: 'null'
        schema:
          type: string
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        '200':
          description: 'Successful operation. Returns a list of rate cards corresponding to the passed subscription ID and date range (if provided).

            '
          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/RateCardSummary'
                type: array
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
      summary: Finds ratecards by Subscription Id and date range(if provided)
      tags:
      - ratecard
components:
  parameters:
    CompartmentIdQueryParam:
      description: The OCID of the root compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    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
    SortByQueryParam:
      description: 'The field to sort by. You can provide one sort order (''sortOrder'').

        '
      in: query
      name: sortBy
      required: false
      x-default-description: 'null'
      schema:
        type: string
        enum:
        - ORDERNUMBER
        - TIMEINVOICING
    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
    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
    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
  schemas:
    RateCardProduct:
      description: 'Product description.

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

            '
          example: Metered Subscription Commitment
          type: string
        name:
          description: 'Product name.

            '
          example: Oracle Database Backup Service
          type: string
        partNumber:
          description: 'Product part number.

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

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

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

            '
          example: GIGABYTE STORAGE CAPACITY PER MONTH
          type: string
      required:
      - partNumber
      - name
      - unitOfMeasure
      type: object
    SubscriptionCurrency:
      description: 'Currency details.

        '
      properties:
        isoCode:
          description: 'Currency code.

            '
          example: USD
          type: string
        name:
          description: 'Currency name.

            '
          example: US Dollar
          type: string
        stdPrecision:
          description: 'Standard precision of the currency.

            '
          example: 2
          format: int64
          type: integer
      required:
      - isoCode
      type: object
    RateCardSummary:
      description: 'Rate card summary.

        '
      properties:
        currency:
          $ref: '#/components/schemas/SubscriptionCurrency'
        discretionaryDiscountPercentage:
          description: 'Rate card discretionary discount percentage.

            '
          example: 5
          type: string
        isTier:
          description: 'Rate card price tier parameter.

            '
          example: true
          type: boolean
        netUnitPrice:
          description: 'Rate card net unit price.

            '
          example: 0.0234
          type: string
        overagePrice:
          description: 'Rate card overage price.

            '
          example: 0.0234
          type: string
        product:
          $ref: '#/components/schemas/RateCardProduct'
        rateCardTiers:
          description: 'List of tiered rate card prices.

            '
          items:
            $ref: '#/components/schemas/RateCardTier'
          type: array
        subscribedServiceId:
          description: 'SPM (Subscription Plan Management) internal subscribed service ID.

            '
          example: 1AEC900CD14F42339562EBA52423CE27
          type: string
        timeEnd:
          description: 'Rate card end date.

            '
          example: '2019-02-20T00:00:00Z'
          format: date-time
          type: string
        timeStart:
          description: 'Rate card start date.

            '
          example: '2019-02-20T00:00:00Z'
          format: date-time
          type: string
      required:
      - product
      - netUnitPrice
      - overagePrice
      type: object
    RateCardTier:
      description: 'Rate card tier details.

        '
      properties:
        netUnitPrice:
          description: 'Rate card tier net unit price.

            '
          example: 1.234
          type: string
        overagePrice:
          description: 'Rate card tier overage price.

            '
          example: 1.235
          type: string
        upToQuantity:
          description: 'Rate card tier quantity range.

            '
          example: 999999
          type: string
      type: object
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