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 Commitment 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: commitment
paths:
  /commitments:
    get:
      description: 'Returns all commitments for a particular subscribed service.

        '
      operationId: ListCommitments
      parameters:
      - description: 'Obtains the commitments for a particular subscribed service.

          '
        in: query
        name: subscribedServiceId
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: Successful operation. Returns a list of commitments corresponding to the passed subscribed service ID.
          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/CommitmentSummary'
                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: Returns all commitments for a given Subscribed Service Id
      tags:
      - commitment
  /commitments/{commitmentId}:
    get:
      description: 'Returns the commitment details corresponding to the provided ID.

        '
      operationId: GetCommitment
      parameters:
      - $ref: '#/components/parameters/CommitmentIdPathParam'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: Successful operation. Returns a single commitment record corresponding to the passed commitment ID.
          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/Commitment'
        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: Returns the commitment details corresponding to the commitment id provided
      tags:
      - commitment
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
    CommitmentIdPathParam:
      description: The commitment ID.
      in: path
      name: commitmentId
      required: true
      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:
    CommitmentSummary:
      description: 'Subscribed service commitment summary.

        '
      properties:
        availableAmount:
          description: 'Commitment available amount.

            '
          example: '1.0'
          type: string
        fundedAllocationValue:
          description: 'Funded allocation line value.

            Example: 12000.00

            '
          type: string
        id:
          description: 'SPM (Subscription Plan Management) internal commitment ID.

            '
          example: 1AEC900CD14F42339562EBA52423CE27
          type: string
        quantity:
          description: 'Commitment quantity.

            '
          example: '2'
          type: string
        subscribedServiceId:
          description: 'SPM internal subscribed service ID.

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

            '
          example: '2019-02-13T22:11:21.451Z'
          format: date-time
          type: string
        timeStart:
          description: 'Commitment start date.

            '
          example: '2019-02-12T22:11:21.451Z'
          format: date-time
          type: string
        usedAmount:
          description: 'Commitment used amount.

            '
          example: 12.14
          type: string
      required:
      - id
      type: object
    Commitment:
      description: 'Subscribed service commitment summary.

        '
      properties:
        availableAmount:
          description: 'Commitment available amount.

            '
          example: '1.0'
          type: string
        fundedAllocationValue:
          description: 'Funded allocation line value.

            Example: 12000.00

            '
          type: string
        id:
          description: 'SPM (Subscription Plan Management) internal commitment ID.

            '
          example: 1AEC900CD14F42339562EBA52423CE27
          type: string
        quantity:
          description: 'Commitment quantity.

            '
          example: '2'
          type: string
        subscribedServiceId:
          description: 'SPM internal subscribed service ID.

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

            '
          example: '2019-02-13T22:11:21.451Z'
          format: date-time
          type: string
        timeStart:
          description: 'Commitment start date.

            '
          example: '2019-02-12T22:11:21.451Z'
          format: date-time
          type: string
        usedAmount:
          description: 'Commitment used amount.

            '
          example: 12.14
          type: string
      required:
      - id
      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