find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/oracle-usageplans-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: 'API for the API Gateway service. Use this API to manage gateways, deployments, and related items.

    For more information, see

    [Overview of API Gateway](/iaas/Content/APIGateway/Concepts/apigatewayoverview.htm).

    '
  title: Gateway Usage Plans API
  version: '20190501'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/4a7a190925fb30298864e9aee04c85cfd197a64c6eca47f749c72b5d9b9046ba.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the API Gateway 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/4a7a190925fb30298864e9aee04c85cfd197a64c6eca47f749c72b5d9b9046ba.yaml
    what: the harvested document for API Gateway API
servers:
- url: http://127.0.0.1/20190501
- url: https://127.0.0.1/20190501
tags:
- name: usagePlans
paths:
  /usagePlans:
    get:
      description: Returns a list of usage plans.
      operationId: ListUsagePlans
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/UsagePlanLifecycleStateQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: A page of UsagePlan objects.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response,

                additional pages of results remain. For important details about how

                pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
                default: 'null'
            opc-prev-page:
              description: 'For list pagination. When this header appears in the response,

                additional pages of results were seen previously. For important details

                about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePlanCollection'
        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: Gets a list of all usage plans in a compartment
      tags:
      - usagePlans
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/UsagePlan'
    post:
      description: Creates a new usage plan.
      operationId: CreateUsagePlan
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        201:
          description: The usage plan is being created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
                default: 'null'
            location:
              description: 'Location of the resource.

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePlan'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a new usage plan.
      tags:
      - usagePlans
      x-obmcs-client-retries-enabled: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUsagePlanDetails'
        description: Details for the new usage plan.
        required: true
  /usagePlans/{usagePlanId}:
    delete:
      description: Deletes the usage plan with the given identifier.
      operationId: DeleteUsagePlan
      parameters:
      - $ref: '#/components/parameters/UsagePlanIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: The usage plan will be deleted.
          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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a provisioned usage plan.
      tags:
      - usagePlans
      x-related-resource: '#/definitions/UsagePlan'
    get:
      description: Gets a usage plan by identifier.
      operationId: GetUsagePlan
      parameters:
      - $ref: '#/components/parameters/UsagePlanIdentifierPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Retrieves the usage plan with the given identifier.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
                default: 'null'
            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
                default: 'null'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsagePlan'
        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: Get usage plan.
      tags:
      - usagePlans
      x-obmcs-client-retries-enabled: true
    put:
      description: Updates the usage plan with the given identifier.
      operationId: UpdateUsagePlan
      parameters:
      - $ref: '#/components/parameters/UsagePlanIdentifierPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: The usage plan will be updated.
          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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update the usage plan.
      tags:
      - usagePlans
      x-related-resource: '#/definitions/UsagePlan'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUsagePlanDetails'
        description: The information to be updated.
        required: true
  /usagePlans/{usagePlanId}/actions/addLock:
    post:
      description: Adds a lock to a UsagePlan resource.
      operationId: AddUsagePlanLock
      parameters:
      - description: 'Unique 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
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/UsagePlanIdentifierPathParam'
      - $ref: '#/components/parameters/AddResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is added.
          headers:
            etag:
              description: 'etag for the returned UsagePlan resource.

                '
              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:
                $ref: '#/components/schemas/UsagePlan'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Adds a lock to a UsagePlan resource.
      tags:
      - usagePlans
      x-related-resource: '#/definitions/UsagePlan'
  /usagePlans/{usagePlanId}/actions/changeCompartment:
    post:
      description: Changes the usage plan compartment.
      operationId: ChangeUsagePlanCompartment
      parameters:
      - $ref: '#/components/parameters/UsagePlanIdentifierPathParam'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/OverrideLocksQueryParameter'
      responses:
        202:
          description: The usage plan's compartment will be changed.
          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
                default: 'null'
            opc-work-request-id:
              description: 'The OCID of the work request. Use

                [GetWorkRequest](#/en/iaas/20190501/WorkRequests/GetWorkRequest) with

                this id to track the status

                of the request.

                '
              schema:
                type: string
                default: 'null'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Change the usage plan compartment.
      tags:
      - usagePlans
      x-related-resource: '#/definitions/UsagePlan'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeUsagePlanCompartmentDetails'
        description: Details of the target compartment.
        required: true
  /usagePlans/{usagePlanId}/actions/removeLock:
    post:
      description: Removes a lock from a UsagePlan resource.
      operationId: RemoveUsagePlanLock
      parameters:
      - description: 'Unique 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
        schema:
          type: string
      - description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

          parameter to the value of the etag from a previous GET or POST response for that resource. The resource

          will be updated or deleted only if the etag you provide matches the resource''s current etag value.

          '
        in: header
        name: if-match
        schema:
          type: string
      - $ref: '#/components/parameters/UsagePlanIdentifierPathParam'
      - $ref: '#/components/parameters/RemoveResourceLockDetailsBodyParam'
      responses:
        200:
          description: Lock is removed.
          headers:
            etag:
              description: 'etag for the returned UsagePlan resource.

                '
              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:
                $ref: '#/components/schemas/UsagePlan'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Removes a lock to a UsagePlan resource.
      tags:
      - usagePlans
      x-related-resource: '#/definitions/UsagePlan'
components:
  parameters:
    SortByQueryParam:
      description: 'The field to sort by. You can provide one sort order (`sortOrder`).

        Default order for `timeCreated` is descending. Default order for

        `displayName` is ascending. The `displayName` sort order is case

        sensitive.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    UsagePlanIdentifierPathParam:
      description: The ocid of the usage plan.
      in: path
      name: usagePlanId
      required: true
      schema:
        type: string
    AddResourceLockDetailsBodyParam:
      description: AddResourceLockDetails body parameter
      in: body
      name: AddResourceLockDetails
      required: true
      schema:
        $ref: '#/components/schemas/AddResourceLockDetails'
    RemoveResourceLockDetailsBodyParam:
      description: RemoveResourceLockDetails body parameter
      in: body
      name: RemoveResourceLockDetails
      required: true
      schema:
        $ref: '#/components/schemas/RemoveResourceLockDetails'
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'. The default order depends on the sortBy value.
      in: query
      name: sortOrder
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    UsagePlanLifecycleStateQueryParam:
      description: 'A filter to return only resources that match the given lifecycle state.

        Example: `ACTIVE`

        '
      in: query
      name: lifecycleState
      required: false
      x-obmcs-enumref: '#/definitions/UsagePlan/lifecycleState'
      schema:
        type: string
        default: 'null'
    RequestIdHeader:
      description: The client request id for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
        default: 'null'
    OverrideLocksQueryParameter:
      description: Whether to override locks (if any exist).
      in: query
      name: isLockOverride
      schema:
        type: boolean
        default: false
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      schema:
        type: string
        default: 'null'
        maxLength: 1024
        minLength: 1
    DisplayNameQueryParam:
      description: 'A user-friendly name. Does not have to be unique, and it''s changeable.


        Example: `My new resource`

        '
      in: query
      name: displayName
      schema:
        type: string
        default: 'null'
        maxLength: 255
        minLength: 1
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 100
        maximum: 1000
        minimum: 1
    CompartmentIdQueryParam:
      description: The ocid of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      schema:
        type: string
        default: 'null'
        maxLength: 64
        minLength: 1
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call

        for a resource, set the `if-match` parameter to the value of the

        etag from a previous GET or POST response for that resource.

        The resource will be updated or deleted only if the etag you

        provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      schema:
        type: string
        default: 'null'
  schemas:
    EntitlementSummary:
      description: 'A summary of an entitlement included in a usage plan.

        '
      properties:
        description:
          description: 'A user-friendly description. To provide some insight about the resource.

            Avoid entering confidential information.

            '
          maxLength: 400
          type: string
        name:
          description: 'An entitlement name, unique within a usage plan.

            '
          maxLength: 255
          minLength: 1
          type: string
        quota:
          $ref: '#/components/schemas/Quota'
        rateLimit:
          $ref: '#/components/schemas/RateLimit'
      required:
      - name
      type: object
    UsagePlan:
      description: 'A usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the

            resource is created.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a

              namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see

            [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.


            Example: `My new resource`

            '
          type: string
        entitlements:
          description: 'A collection of entitlements currently assigned to the usage plan.

            '
          items:
            $ref: '#/components/schemas/Entitlement'
          maxItems: 400
          minItems: 0
          type: array
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair

            with no predefined name, type, or namespace. For more information, see

            [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of a usage plan

            resource.

            '
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message describing the current state in more detail.

            For example, can be used to provide actionable information for a resource in a Failed state.

            '
          type: string
        lifecycleState:
          description: The current state of the usage plan.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          type: string
        locks:
          description: Locks associated with this resource.
          items:
            $ref: '#/components/schemas/ResourceLock'
          maxItems: 2
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string type is supported.

                '
              type: object
            description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

              Example: `{"bar-key": "value"}`

              '
            type: object
          description: 'System tags for this resource. Each key is predefined and scoped to a namespace.

            Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

            '
          type: object
        timeCreated:
          description: The time this resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time this resource was last updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - entitlements
      - lifecycleState
      - timeCreated
      - timeUpdated
      type: object
    Entitlement:
      description: 'A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.

        '
      properties:
        description:
          description: 'A user-friendly description. To provide some insight about the resource.

            Avoid entering confidential information.

            '
          maxLength: 400
          type: string
        name:
          description: 'An entitlement name, unique within a usage plan.

            '
          maxLength: 255
          minLength: 1
          type: string
        quota:
          $ref: '#/components/schemas/Quota'
        rateLimit:
          $ref: '#/components/schemas/RateLimit'
        targets:
          description: 'A collection of targeted deployments that the entitlement will be applied to.

            '
          items:
            $ref: '#/components/schemas/EntitlementTarget'
          maxItems: 250
          minItems: 1
          type: array
      required:
      - name
      type: object
    Quota:
      description: 'Quota policy for a usage plan.

        '
      properties:
        operationOnBreach:
          description: 'What the usage plan will do when a quota is breached:

            `REJECT` will allow no further requests

            `ALLOW` will continue to allow further requests

            '
          enum:
          - REJECT
          - ALLOW
          type: string
        resetPolicy:
          description: 'The policy that controls when quotas will reset.

            Example: `CALENDAR`

            '
          enum:
          - CALENDAR
          type: string
        unit:
          description: 'The unit of time over which quotas are calculated.

            Example: `MINUTE` or `MONTH`

            '
          enum:
          - MINUTE
          - HOUR
          - DAY
          - WEEK
          - MONTH
          type: string
        value:
          description: 'The number of requests that can be made per time period.

            '
          format: int32
          minimum: 0
          type: integer
      required:
      - value
      - unit
      - resetPolicy
      - operationOnBreach
      type: object
    UpdateUsagePlanDetails:
      description: The information to be updated.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a

              namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see

            [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.


            Example: `My new resource`

            '
          type: string
        entitlements:
          description: 'A collection of entitlements to update the current usage plan with.

            '
          items:
            $ref: '#/components/schemas/Entitlement'
          maxItems: 400
          minItems: 1
          type: array
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair

            with no predefined name, type, or namespace. For more information, see

            [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Department": "Finance"}`

            '
          type: object
      type: object
    UsagePlanSummary:
      description: A summary of the usage plan.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the

            resource is created.

            '
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a

              namespace.


              Example: `{"CostCenter": "42"}`

              '
            type: object
          description: 'Defined tags for this resource. Each key is predefined and scoped to a

            namespace. For more information, see

            [Resource Tags](/Content/General/Concepts/resourcetags.htm).


            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name. Does not have to be unique, and it''s changeable.

            Avoid entering confidential information.


            Example: `My new resource`

            '
          type: string
        entitlements:
          description: 'A collection of entitlements applied by the usage plan.

            '
          items:
            $ref: '#/components/schemas/EntitlementSummary'
          maxItems: 400
          minItems: 0
          type: array
        freeformTags:
          additionalProperties:
            type: string
        

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