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 Subscribed Service 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: subscribedService
paths:
  /subscribedServices:
    get:
      description: 'Returns all subscribed services for a given Subscription ID.

        '
      operationId: ListSubscribedServices
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/SubscribedServiceSubscriptionIdQueryParam'
      - $ref: '#/components/parameters/SubscribedServiceLineOrderLineIdQueryParam'
      - description: 'This parameter filters subscribed services based on its status.

          '
        in: query
        name: status
        required: false
        schema:
          type: string
          default: 'null'
      - $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 subscribed services corresponding to the passed subscription 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/SubscribedServiceSummary'
                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 subscribed services for a given subscription id
      tags:
      - subscribedService
  /subscribedServices/{subscribedServiceId}:
    get:
      description: 'Returns the subscribed service details corresponding to the provided ID.

        '
      operationId: GetSubscribedService
      parameters:
      - $ref: '#/components/parameters/SubscribedServiceIdPathParam'
      - $ref: '#/components/parameters/SubscribedServiceRequestFields'
      - $ref: '#/components/parameters/OpcRequestIdHeader'
      responses:
        200:
          description: Successful operation. Returns a single subscribed service record corresponding to the passed subscribed service 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/SubscribedService'
        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 subscribed service details corresponding to the subscribed service id provided
      tags:
      - subscribedService
components:
  schemas:
    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
    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
    SubscribedServiceLocation:
      description: 'Address location.

        '
      properties:
        address1:
          description: 'Address first line.

            '
          type: string
        address2:
          description: 'Address second line.

            '
          type: string
        city:
          description: 'City.

            '
          type: string
        country:
          description: 'Country.

            '
          type: string
        postalCode:
          description: 'Postal code.

            '
          type: string
        region:
          description: 'Region.

            '
          type: string
        tcaLocationId:
          description: 'TCA (Trading Community Architecture) location identifier.

            '
          format: int64
          type: integer
      type: object
    SubscribedServiceAddress:
      description: 'Address.

        '
      properties:
        billSiteUseId:
          description: 'Bill to site use ID.

            '
          format: int64
          type: integer
        isBillTo:
          description: 'Identify as the customer shipping address.

            '
          type: boolean
        isShipTo:
          description: 'Identify as the customer invoicing address.

            '
          type: boolean
        location:
          $ref: '#/components/schemas/SubscribedServiceLocation'
        name:
          description: 'Address name identifier.

            '
          type: string
        phone:
          description: 'Phone.

            '
          type: string
        service2SiteUseId:
          description: 'Service-to-site use ID.

            '
          format: int64
          type: integer
        tcaCustAcctSiteId:
          description: 'TCA (Trading Community Architecture) customer account site ID.

            '
          format: int64
          type: integer
        tcaPartySiteNumber:
          description: 'Party site number.

            '
          type: string
      type: object
    SubscribedServicePaymentTerm:
      description: 'Payment term details.

        '
      properties:
        createdBy:
          description: 'User that created the payment term.

            '
          example: user@oracle.com
          type: string
        description:
          description: 'Payment term description.

            '
          example: GB_30 NET
          type: string
        isActive:
          description: 'Payment term active parameter.

            '
          example: true
          type: boolean
        name:
          description: 'Payment term name.

            '
          example: GB_30 NET
          type: string
        timeCreated:
          description: 'Payment term last update date.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Payment term last update date.

            '
          format: date-time
          type: string
        updatedBy:
          description: 'User that updated the payment term.

            '
          example: user@oracle.com
          type: string
        value:
          description: 'Payment term value.

            '
          example: '4177178'
          type: string
      type: object
    SubscribedServiceBusinessPartner:
      description: 'Business partner.

        '
      properties:
        customerChainType:
          description: 'Customer chain type.

            '
          type: string
        isChainCustomer:
          description: 'Specifies whether or not the business partner is a chain customer.

            '
          type: boolean
        isPublicSector:
          description: 'Specifies whether or not the business partner is part of the public sector.

            '
          type: boolean
        name:
          description: 'Commercial name, also referred to as customer name.

            '
          type: string
        namePhonetic:
          description: 'Phonetic name.

            '
          type: string
        tcaCustAccountNumber:
          description: 'TCA (Trading Community Architecture) customer account number.

            '
          type: string
        tcaCustomerAccountId:
          description: 'TCA customer account ID.

            '
          format: int64
          type: integer
        tcaPartyId:
          description: 'TCA party ID.

            '
          format: int64
          type: integer
        tcaPartyNumber:
          description: 'TCA party number.

            '
          type: string
      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
    SubscribedServiceUser:
      description: 'User.

        '
      properties:
        email:
          description: 'Email.

            '
          format: email
          type: string
        firstName:
          description: 'First name.

            '
          type: string
        lastName:
          description: 'Last name.

            '
          type: string
        name:
          description: 'Name.

            '
          type: string
        tcaContactId:
          description: 'TCA (Trading Community Architecture) contact ID.

            '
          format: int64
          type: integer
        tcaCustAccntSiteId:
          description: 'TCA customer account site ID.

            '
          format: int64
          type: integer
        tcaPartyId:
          description: 'TCA party ID.

            '
          format: int64
          type: integer
        username:
          description: 'User name.

            '
          type: string
      type: object
    SubscribedServiceSummary:
      description: 'Subscribed service contract details.

        '
      properties:
        adminEmail:
          description: 'Subscribed service admin email ID.

            '
          example: admin@gmail.com
          type: string
        agreementId:
          description: 'Subscribed service agreement ID.

            '
          example: 18378618
          format: int64
          type: integer
        agreementName:
          description: 'Subscribed service agreement name.

            '
          example: HK-CSA-QT5545292
          type: string
        agreementType:
          description: 'Subscribed service agreement type.

            '
          example: CLOUD
          type: string
        availableAmount:
          description: 'Subscribed sercice available or remaining amount.

            '
          example: 407.84
          format: double
          type: string
        billToAddress:
          $ref: '#/components/schemas/SubscribedServiceAddress'
        billToContact:
          $ref: '#/components/schemas/SubscribedServiceUser'
        billToCustomer:
          $ref: '#/components/schemas/SubscribedServiceBusinessPartner'
        billingFrequency:
          description: 'Subscribed service invoice frequency.

            '
          example: Annual in Advance / Monthly Usage
          type: string
        bookingOptyNumber:
          description: 'Booking opportunity number of subscribed service.

            '
          example: 5G6LD
          type: string
        buyerEmail:
          description: 'Subscribed service buyer email ID.

            '
          example: buyer@gmail.com
          type: string
        commitmentScheduleId:
          description: 'Subscribed service commitment schedule ID.

            '
          example: '10002387'
          type: string
        createdBy:
          description: 'User that created the subscribed service.

            '
          example: user@oracle.com
          type: string
        creditPercentage:
          description: 'Subscribed service credit percentage.

            '
          example: 12.84
          format: double
          type: string
        csi:
          description: 'Subscribed service CSI number.

            '
          example: 22366070
          format: int64
          type: integer
        customerTransactionReference:
          description: 'Identifier for a customer''s transactions for purchase of any Oracle services.

            '
          example: CTR-10541963-1
          type: string
        dataCenter:
          description: 'Subscribed service data center.

            '
          example: US001
          type: string
        dataCenterRegion:
          description: 'Subscribed service data center region.

            '
          example: North America
          type: string
        eligibleToRenew:
          description: 'Subscribed service eligible to renew field.

            '
          example: Y
          type: string
        endUserAddress:
          $ref: '#/components/schemas/SubscribedServiceAddress'
        endUserContact:
          $ref: '#/components/schemas/SubscribedServiceUser'
        endUserCustomer:
          $ref: '#/components/schemas/SubscribedServiceBusinessPartner'
        fulfillmentSet:
          description: 'Subscribed service fulfillment set.

            '
          example: CLOUDCM-2
          type: string
        fundedAllocationValue:
          description: 'Funded allocation line value.

            Example: 12000.00

            '
          format: double
          type: string
        id:
          description: 'SPM (Subscription Plan Management) internal subscribed service ID.

            '
          example: 1AEC900CD14F42339562EBA52423CE27
          type: string
        isAllowance:
          description: 'Indicates if a service can recieve usages and consequently have available amounts computed.

            '
          example: true
          type: boolean
        isCapToPriceList:
          description: 'If true compares the rate between the rate card and the active price list, and the minimum rate would be fetched.

            '
          example: false
          type: boolean
        isCreditEnabled:
          description: 'Used in context of service credit lines.

            '
          example: true
          type: boolean
        isHavingUsage:
          description: 'Indicates whether or not there has been usage for the subscribed service.

            '
          type: boolean
        isIntentToPay:
          description: 'Subscribed service intent to pay parameter.

            '
          example: true
          type: boolean
        isPayg:
          description: 'Subscribed service PAYG parameter.

            '
          example: false
          type: boolean
        isSingleRateCard:
          description: 'Indicates if the subscribed service has a single rate card.

            '
          example: true
          type: boolean
        isVariableCommitment:
          description: 'Indicates if the commitment lines can have different quantities.

            '
          example: true
          type: boolean
        lineNetAmount:
          description: 'Subscribed service line net amount.

            '
          example: 22.0
          format: double
          type: string
        majorSet:
          description: 'Subscribed service major set.

            '
          example: 1000
          format: int64
          type: integer
        netUnitPrice:
          description: 'Subscribed service net unit price.

            '
          example: 20.999
          format: double
          type: string
        operationType:
          description: 'Subscribed service operation type.

            '
          example: Update
          type: string
        orderHeaderId:
          description: 'Sales order header associated with the subscribed service.

            '
          example: 6456345
          format: int64
          type: integer
        orderLineId:
          description: 'Sales order line ID associated with the subscribed service.

            '
          example: 12343243
          format: int64
          type: integer
        orderLineNumber:
          description: 'Sales order line number associated with the subscribed service.

            '
          example: 2
          type: integer
        orderNumber:
          description: 'Sales order number associated with the subscribed service.

            '
          example: 1234345
          format: int64
          type: integer
        orderType:
          description: 'Order type of subscribed service.

            '
          example: SG:CLOUD SERVICES
          type: string
        originalPromoAmount:
          description: 'Subscribed service promotion amount.

            '
          example: 500
          format: double
          type: string
        overageBillTo:
          description: 'Overage bill to of subscribed service.

            '
          example: BillTo_Customer
          type: string
        overageDiscountPercentage:
          description: 'Subscribed service overage discount percentage.

            '
          example: 10.84
          format: double
          type: string
        overagePolicy:
          description: 'Overage policy of subscribed service.

            '
          example: BOSP, BOZP, BOPL, BOCP
          type: string
        partnerCreditAmount:
          description: 'Subscribed service partner credit amount.

            '
          example: 419.98
          format: double
          type: string
        partnerTransactionType:
          description: 'Contains the name of the partner to which the subscription belongs, however depending on which subscription, the invoicing can differ.

            '
          example: Reseller, MSP, VAD, RESELLER, PROGRAMS, SPECIFIED END USE, FUJITSU-K5, FUJITSU, CMP
          type: string
        paygPolicy:
          description: 'Pay As You Go policy of subscribed service. Can be null, indicating no PAYG policy.

            '
          example: null, BPAYGPL, BPAYGCP
          type: string
        paymentMethod:
          description: 'Payment method of subscribed service.

            '
          example: PayPal
          type: string
        paymentNumber:
          description: 'Payment number of subscribed service.

            '
          example: POEF-1/SOEST
          type: string
        paymentTerm:
          $ref: '#/components/schemas/SubscribedServicePaymentTerm'
        pricePeriod:
          description: 'Indicates the period for which the commitment amount can be utilized, exceeding which, the amount lapses. Also used in calculation of total contract line value.

            '
          example: SP, M
          type: string
        pricingModel:
          description: 'Subscribed service pricing model.

            '
          example: Annual
          type: string
        product:
          $ref: '#/components/schemas/RateCardProduct'
        programType:
          description: 'Subscribed service program type.

            '
          example: EVENT-TRIALS
          type: string
        promoOrderLineId:
          description: "Not null if this service has an associated promotion line in SPM (Subscription Plan Management). Contains the line identifier from order management of \nthe associated promo line.\n"
          example: 1413324676
          format: int64
          type: integer
        promoType:
          description: 'Subscribed service promotion type.

            '
          example: STANDARD
          type: string
        promotionPricingType:
          description: 'Promotion pricing type of subscribed service. Can be null, indicating no promotional pricing.

            '
          example: null, PROMOTION
          type: string
        provisioningSource:
          description: 'Subscribed service provisioning source.

            '
          example: SPM
          type: string
        quantity:
          description: 'Subscribed service quantity.

            '
          example: 20
          format: double
          type: string
        rateCardDiscountPercentage:
          description: 'Subscribed service rate card ciscount percentage.

            '
          example: 5.84
          format: double
          type: string
        ratecardType:
          description: 'SPM (Subscription Plan Management) rate card type.

            '
          example: Free_Tier/ Free_Tier_Paid /Free_Tier_Trial_POC
          type: string
        renewalOptyId:
          description: 'Subscribed service opportunity ID.

            '
          example: 300007482664656
          format: int64
          type: integer
        renewalOptyNumber:
          description: 'Renewal opportunity number of subscribed service.

            '
          example: 3G3LD
          type: string
        renewalOptyType:
          description: 'Renewal opportunity type of subscribed service.

            '
          example: RENEWAL
          type: string
        renewedSubscribedServiceId:
          description: 'SPM (Subscription Plan Management) renewed subscription ID.

            '
          example: 1AEC900CD14F42339562EBA52423CE27
          type: string
        resellerAddress:
          $ref: '#/components/schemas/SubscribedServiceAddress'
        resellerContact:
          $ref: '#/components/schemas/SubscribedServiceUser'
        resellerCustomer:
          $ref: '#/components/schemas/SubscribedServiceBusinessPartner'
        revenueLineId:
          description: 'Subscribed service revenue line ID.

            '
          example: 300010896040582
          format: int64
          type: integer
        revenueLineNumber:
          description: 'Revenue line number of subscribed service.

            '
          example: GHBW8
          type: string
        revisedArrInLc:
          description: 'Subscribed service revised ARR.

            '
          example: 1.0
          format: double
          type: string
        revisedArrInSc:
          description: 'Subscribed service revised ARR in standard currency.

            '
          example: 2.0
          format: double
          type: string
        salesAccountPartyId:
          description: 'Subscribed service sales account party ID.

            '
          example: 100000036569032
          format: int64
          type: integer
        salesChannel:
          description: 'Sales channel of subscribed service.

            '
          example: FIELD-DIRECT
          type: string
        serialNumber:
          description: 'Subscribed service line number.

            '
          example: '1.000'
          type: string
        serviceToAddress:
          $ref: '#/components/schemas/SubscribedServiceAddress'
        serviceToContact:
          $ref: '#/components/schemas/SubscribedServiceUser'
        serviceToCustomer:
          $ref: '#/components/schemas/SubscribedServiceBusinessPartner'
        soldToContact:
          $ref: '#/components/schemas/SubscribedServiceUser'
        soldToCustomer:
          $ref: '#/components/schemas/SubscribedServiceBusinessPartner'
        startDateType:
          description: 'Subscribed service start date type.

            '
          example: fixedDates
          type: string
        status:
          description: 'Subscribed service status.

            '
          example: TERMINATED, AWAITING_PROVISIONING_HOLD, AWAITING_PROVISIONING, SUPERSEDED, TERMINATED_PENDING_FINAL_BILLING, SUSPEND, DRAFT, EXPIRED, ACTIVE, AWAITING_PROVISIONING_ERROR, SIGNED
          type: string
        subscriptionId:
          description: 'Subscription ID associated with the subscribed service.

            '
          example: '1291630'
          type: string
        subscriptionSource:
          description: 'Subscribed service source.

            '
          example: MA
          type: string
        systemArrInLc:
          description: 'Subscribed service system ARR (Annualized Recurring Revenue).

            '
          example: 1.0
          format: double
          type: string
        systemArrInSc:
          description: 'Subscribed service system ARR in standard currency.

            '
          example: 2.0
          format: double
          type: string
        systemAtrArrInLc:
          description: 'Subscribed service system ATR-ARR (Annualized Recurring Revenue - Available to Renew).

            '
          example: 1.0
          format: double
          type: string
        systemAtrArrInSc:
          description: 'Subscribed service system ATR-ARR in standard currency.

            '
          example: 2.0
          format: double
          type: string
        termValue:
          description: 'Term value in months.

            '
          example: 20
          format: int64
          type: integer
        termValueUom:
          description: 'Term value UOM (Unit of Measure).

            '
          example: Monthly
          type: string
        timeAgreementEnd:
          description: 'Subscribed service agreement end date.

            '
          format: date-time
          type: string
        timeCreated:
          description: 'Subscribed service creation date.

            '
          format: date-time
          type: string
        timeCustomerConfig:
          description: 'Subscribed service customer configuration date.

            '
          format: date-time
          type: string
        timeEnd:
          description: 'Subscribed service end date.

            '
          format: date-time
          type: string
        timeMajorsetEnd:
          description: 'Subscribed service major set end date.

            '
          format: date-time
          type: string
        timeMajorsetStart:
          description: 'Subscribed service major set start date.

            '
          format: date-time
          type: string
        timePaymentExpiry:
          description: 'Subscribed service payment expiration date.

            '
          format: date-time
          type: string
        timeProvisioned:
          description: 'Subscribed service provisioning date.

            '
          format: date-time
          type: string
        timeServiceConfigurationEmailSent:
          description: 'Subscribed service configuration email sent date.

            '
          format: date-time
          type: string
        timeStart:
          description: 'Subscribed service start date.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'Subscribed service last update date.

            '
          format: date-time
          type: string
        timeWelcomeEmailSent:
          description: 'Subscribed service welcome email sent date.

            '
          format: date-time
          type: string
        totalValue:
          description: 'Subscribed service total value.

            '
          example: 419.98
          format: double
          type: string
        transactionExtensionId:
          description: 'Subscribed service transaction extension ID.

            '
          example: 5768930
          format: int64
          type: integer
        type:
          description: 'Subscribed service line type.

            '
          example: Renewable
          type: string
        updatedBy:
          description: 'User that updated the subscribed service.

            '
          example: user@oracle.com
          type: string
        usedAmount:
          description: 'Subscribed service used amount.

            '
          example: 12.14
          format: double
          type: string
      required:
      - id
      type: object
    SubscribedService:
      description: 'Subscribed service contract details.

        '
      properties:
        adminEmail:
          description: 'Subscribed service admin email ID.

            '
          example: admin@gmail.com
          type: string
        agreementId:
          description: 'Subscribed service agreement ID.

            '
          example: 18378618
          format: int64
          type: integer
        agreementName:
          description: 'Subscribed service agreement name.

            '
          example: HK-CSA-QT5545292
          type: s

# --- truncated at 32 KB (54 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-subscribedservice-api-openapi.yml