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 Billing Schedule 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: billingSchedule
paths:
  /billingSchedules:
    get:
      description: 'This list API returns all billing schedules for a given subscription ID, and

        for a particular subscribed service if provided.

        '
      operationId: ListBillingSchedules
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/SubscriptionIdQueryParam'
      - $ref: '#/components/parameters/SubscribedServiceQueryParam'
      - $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 billing schedule records.

            '
          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/BillingScheduleSummary'
                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'
        default:
          $ref: '#/components/responses/default'
      summary: Returns all billing schedules for a paticular subscription ID.
      tags:
      - billingSchedule
      x-related-resource: '#/definitions/BillingScheduleSummary'
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
    SubscribedServiceQueryParam:
      description: 'This parameter gets the billing schedules for a particular subscribed service.

        '
      in: query
      name: subscribedServiceId
      required: false
      x-default-description: 'null'
      schema:
        type: string
    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
    SubscriptionIdQueryParam:
      description: 'This parameter gets the billing schedules for a particular subscription ID.

        '
      in: query
      name: subscriptionId
      required: true
      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:
    BillingScheduleProduct:
      description: 'Product description.

        '
      properties:
        name:
          description: 'Product name.

            '
          example: Oracle Database Backup Service
          type: string
        partNumber:
          description: 'Indicates the associated accounts receivable invoice number.

            '
          example: B88297
          type: string
      required:
      - partNumber
      - name
      type: object
    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
    BillingScheduleSummary:
      description: 'Billing schedule details related to subscription ID.

        '
      properties:
        amount:
          description: 'Billing schedule line net amount.

            '
          example: '198.0'
          type: string
        arCustomerTransactionId:
          description: 'Indicates the associated accounts receivable customer transaction ID, which is a unique identifier existing on the accounts receivable.

            '
          example: '3781789'
          type: string
        arInvoiceNumber:
          description: 'Indicates the associated accounts receivable invoice number.

            '
          example: '10000020'
          type: string
        billingFrequency:
          description: 'Billing frequency.

            '
          example: Quarterly In Advance / Monthly Usage
          type: string
        invoiceStatus:
          description: 'Billing schedule invoice status.

            '
          enum:
          - INVOICED
          - NOT_INVOICED
          type: string
        netUnitPrice:
          description: 'Billing schedule net unit price.

            '
          example: '22.0'
          type: string
        orderNumber:
          description: 'Order number associated with the subscribed service.

            '
          example: '1234345'
          type: string
        product:
          $ref: '#/components/schemas/BillingScheduleProduct'
        quantity:
          description: 'Billing schedule quantity.

            '
          example: '9'
          type: string
        subscribedServiceId:
          description: 'SPM (Subscription Plan Management) internal subscribed service ID.

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

            '
          format: date-time
          type: string
        timeInvoicing:
          description: 'Billing schedule invoicing date.

            '
          format: date-time
          type: string
        timeStart:
          description: 'Billing schedule start date.

            '
          format: date-time
          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