openapi: 3.2.0
info:
  title: Oracle Subscription API
  version: '1.0'
  description: 'Operations tagged subscription across 4 of this provider''s published API definitions: oci-organizations-1-openapi.yaml, oci-organizations-openapi.yaml, oci-self-openapi.yaml, oci-usage-proxy-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://127.0.0.1/20220518
- url: https://127.0.0.1/20220518
tags:
- name: subscription
paths:
  /assignedSubscriptions:
    get:
      description: Lists subscriptions that are consumed by the compartment. Only the root compartment is allowed.
      operationId: ListAssignedSubscriptions
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/SubscriptionIdOptionalQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/EntityVersionOptionalQueryParam'
      responses:
        200:
          description: Retrieved the list of subscriptions.
          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:
                $ref: '#/components/schemas/AssignedSubscriptionCollection'
        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: Lists subscriptions that are consumed by the compartment. Only root compartment is allowed.
      tags:
      - subscription
      x-related-resource: '#/definitions/AssignedSubscription'
  /assignedSubscriptions/{assignedSubscriptionId}:
    get:
      description: Get the assigned subscription details by assigned subscription ID.
      operationId: GetAssignedSubscription
      parameters:
      - $ref: '#/components/parameters/AssignedSubscriptionIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Assigned subscription information retrieved successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/AssignedSubscription'
        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: Get assigned subscription details by assigned subscription ID.
      tags:
      - subscription
      x-related-resource: '#/definitions/AssignedSubscription'
  /assignedSubscriptions/{assignedSubscriptionId}/assignedSubscriptionLineItems:
    get:
      description: List line item summaries that a assigned subscription owns.
      operationId: ListAssignedSubscriptionLineItems
      parameters:
      - $ref: '#/components/parameters/AssignedSubscriptionIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: Retrieves a list of line items for the given assigned subscription.
          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:
                $ref: '#/components/schemas/AssignedSubscriptionLineItemCollection'
        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: List line item summaries that a assigned subscription owns.
      tags:
      - subscription
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/AssignedSubscriptionLineItemSummary'
  /subscriptionMappings:
    get:
      description: Lists the subscription mappings for all the subscriptions owned by a given compartmentId. Only the root compartment is allowed.
      operationId: ListSubscriptionMappings
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdQueryParam'
      - $ref: '#/components/parameters/SubscriptionMappingIdOptionalQueryParam'
      - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
      - $ref: '#/components/parameters/SubscriptionMappingLifecycleStateQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: Retrieved list of subscriptionMapping.
          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:
                $ref: '#/components/schemas/SubscriptionMappingCollection'
        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: List subscription mappings for all the subscriptions owned by a given compartmentId. Only root compartment is allowed.
      tags:
      - subscription
      x-related-resource: '#/definitions/SubscriptionMapping'
    post:
      description: Assign the tenancy record identified by the compartment ID to the given subscription ID.
      operationId: CreateSubscriptionMapping
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Tenancy assigned to subscription ID successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/SubscriptionMapping'
        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: Assign the tenancy record identified by the compartment ID to the given subscription ID.
      tags:
      - subscription
      x-related-resource: '#/definitions/SubscriptionMapping'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionMappingDetails'
        description: Compartment ID and Subscription ID details to create a subscription mapping.
        required: true
  /subscriptionMappings/{subscriptionMappingId}:
    delete:
      description: Delete the subscription mapping details by subscription mapping ID.
      operationId: DeleteSubscriptionMapping
      parameters:
      - description: OCID of the subscription mapping ID.
        in: path
        name: subscriptionMappingId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: Subscription mapping information deleted successfully.
          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
        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/default'
      summary: Delete subscription mapping details by subscription mapping ID.
      tags:
      - subscription
      x-related-resource: '#/definitions/SubscriptionMapping'
    get:
      description: Get the subscription mapping details by subscription mapping ID.
      operationId: GetSubscriptionMapping
      parameters:
      - description: OCID of the subscriptionMappingId.
        in: path
        name: subscriptionMappingId
        required: true
        schema:
          type: string
          maxLength: 255
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Subscription mapping information retrieved successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/SubscriptionMapping'
        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 the subscription mapping details by subscription mapping ID.
      tags:
      - subscription
      x-related-resource: '#/definitions/SubscriptionMapping'
  /subscriptions:
    get:
      description: List the subscriptions that a compartment owns. Only the root compartment is allowed.
      operationId: ListSubscriptions
      parameters:
      - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam'
      - $ref: '#/components/parameters/SubscriptionIdOptionalQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/EntityVersionOptionalQueryParam'
      responses:
        200:
          description: Retrieved list of subscriptions.
          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:
                $ref: '#/components/schemas/SubscriptionCollection'
        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: List subscriptions that a compartment owns. Only root compartment is allowed.
      tags:
      - subscription
      x-related-resource: '#/definitions/Subscription'
    post:
      description: 'Creates a Subscription.

        '
      operationId: CreateSubscription
      parameters:
      - $ref: '#/components/parameters/RetryTokenHeader_2'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        201:
          description: Accepted the request. The Subscription will be created.
          headers:
            content-location:
              description: Same as location.
              schema:
                type: string
                format: uri-reference
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URL for the created subscription. The subscription OCID is generated after this request is sent.
              schema:
                type: string
                format: uri-reference
            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
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subscription_3'
        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 Subscription.
      tags:
      - subscription
      x-related-resource: '#/definitions/Subscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSubscriptionDetails'
        description: Details for the new Subscription.
        required: true
  /subscriptions/{subscriptionId}:
    get:
      description: Gets the subscription details by subscription ID.
      operationId: GetSubscription
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: Subscription information retrieved successfully.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/Subscription'
        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: Get subscription details by subscriptionId. Returns either a ClassicSubscription resource or a Subscription resource.
      tags:
      - subscription
      x-related-resource: '#/definitions/Subscription'
    delete:
      description: Deletes a Subscription.
      operationId: DeleteSubscription
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdPathParam_3'
      - $ref: '#/components/parameters/IfMatchHeader_2'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        202:
          description: Accepted the request. The Subscription 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
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        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/default'
      summary: Deletes a Subscription.
      tags:
      - subscription
      x-related-resource: '#/definitions/Subscription'
    put:
      description: Updates a Subscription.
      operationId: UpdateSubscription
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdPathParam_3'
      - $ref: '#/components/parameters/IfMatchHeader_2'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        202:
          description: Accepted the request. The Subscription 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
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Updates a Subscription.
      tags:
      - subscription
      x-related-resource: '#/definitions/Subscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSubscriptionDetails'
        description: The information to be updated.
        required: true
  /subscriptions/{subscriptionId}/availableRegions:
    get:
      description: List the available regions based on subscription ID.
      operationId: ListAvailableRegions
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      responses:
        200:
          description: Retrieved the list of regions where the subscription is used.
          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:
                $ref: '#/components/schemas/AvailableRegionCollection'
        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: List available regions based on subscription ID.
      tags:
      - subscription
      x-related-resource: '#/definitions/Subscription'
  /subscriptions/{subscriptionId}/subscriptionLineItems:
    get:
      description: Lists the line items in a subscription.
      operationId: ListSubscriptionLineItems
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      responses:
        200:
          description: Retrieves a list of line items for the given subscription.
          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:
                $ref: '#/components/schemas/SubscriptionLineItemCollection'
        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: Lists the line items in a subscription.
      tags:
      - subscription
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/SubscriptionLineItemSummary'
  /subscriptions/{subscriptionId}/actions/cancel:
    post:
      description: 'Requests cancellation of a Subscription. The subscription transitions to PendingCancellation

        and remains active until the end of the current billing cycle, at which point it transitions

        to Canceled. The subscription must be in the Active state to be canceled.

        '
      operationId: CancelSubscription
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdPathParam_3'
      - $ref: '#/components/parameters/IfMatchHeader_2'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      - $ref: '#/components/parameters/RetryTokenHeader_2'
      responses:
        200:
          description: The Subscription cancellation was accepted. The Subscription is now in PendingCancellation state.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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/Subscription_3'
        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: Cancels a Subscription.
      tags:
      - subscription
      x-related-resource: '#/definitions/Subscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelSubscriptionDetails'
        description: Details for the cancellation request.
        required: true
  /subscriptions/{subscriptionId}/actions/changeCompartment:
    post:
      description: 'Moves a Subscription into a different compartment within the same tenancy. For information about moving resources between

        compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).

        '
      operationId: ChangeSubscriptionCompartment
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdPathParam_3'
      - $ref: '#/components/parameters/IfMatchHeader_2'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      - $ref: '#/components/parameters/RetryTokenHeader_2'
      responses:
        202:
          description: Accepted the request. The Subscription will be moved into a different compartment.
          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
            opc-work-request-id:
              description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.

                Use GetWorkRequest with this ID to track the status of the request.

                '
              schema:
                type: string
        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'
      summary: Moves a Subscription into a different compartment.
      tags:
      - subscription
      x-related-resource: '#/definitions/Subscription'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeSubscriptionCompartmentDetails'
        description: The information to be updated.
        required: true
  /subscriptions/{subscriptionId}/token:
    get:
      description: 'Gets a token of Subscriptions.

        '
      operationId: GetSubscriptionToken
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdPathParam_3'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        200:
          description: A page of SubscriptionSummary 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
            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/SubscriptionToken'
        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 token of Subscriptions.
      tags:
      - subscription
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam_3'
      - $ref: '#/components/parameters/WorkRequestIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestStatusQueryParam'
      - $ref: '#/components/parameters/ResourceIdentifierQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      - $ref: '#/components/parameters/PaginationTokenQueryParam_2'
      - $ref: '#/components/parameters/PaginationLimitQueryParam_2'
      - $ref: '#/components/parameters/SortOrderQueryParam_2'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      responses:
        200:
          description: The list of work requests was retrieved.
          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
            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/WorkRequestSummaryCollection'
        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: List work requests
      tags:
      - subscription
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    delete:
      description: Cancels a work request.
      operationId: CancelWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/IfMatchHeader_2'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        202:
          description: The work request will be canceled.
          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
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Cancel work request
      tags:
      - subscription
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets the details of a work request.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      responses:
        200:
          description: The work request was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: integer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        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 work request status
      tags:
      - subscription
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Lists the errors for a work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      - $ref: '#/components/parameters/PaginationTokenQueryParam_2'
      - $ref: '#/components/parameters/PaginationLimitQueryParam_2'
      - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam_2'
      responses:
        200:
          description: The list of work request errors was retrieved.
          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
            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/WorkRequestErrorCollection'
        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: List work request errors
      tags:
      - subscription
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Lists the logs for a work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader_2'
      - $ref: '#/components/parameters/PaginationTokenQueryParam_2'
      - $ref: '#/components/parameters/PaginationLimitQueryParam_2'
      - $ref: '#/components/parameters/WorkRequestLogAndErrorSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam_2'
      responses:
        200:
          description: The list of work request logs.
          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
            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/WorkRequestLogEntryCollection'
        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: List work request logs
      tags:
      - subscription
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  schemas:
    SubscriptionToken:
      description: The base 64 encoded JWT token which is mapped to a particular subscription.
      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](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        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](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        subscriptionId:
          description: The unique identifier for the subscription within a specific compartment.
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

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


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

              '
            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
        token:
          description: JWT token of subscriptions.
          type: string
      required:
      - token
      type: object
    SubscriptionMappingSummary:
      description: Subscription mapping information.
      properties:
        compartmentId:
          description: OCID of the compartment. Always a tenancy OCID.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: OCID of the mapping between subscription and compartment identified by the tenancy.
          maxLength: 255
          minLength: 1
          type: string
        isExplicitlyAssigned:
          default: false
          description: Denotes if the subscription is explicity assigned to the root compartment or tenancy.
          example: true
          type: boolean
        lifecycleState:
          description: Lifecycle state of the subscription mapping.
          example: ACTIVE
          type: string
          x-obmcs-enumref: '#/definitions/SubscriptionMapping/lifecycleState'
        subscriptionId:
          description: OCID of the subscription.
          maxLength: 255
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        timeCreated:
          description: Date-time when subscription mapping was created.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeTerminated:
          description: Date-time when subscription mapping was terminated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: Date-time when subscription mapping was updated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - id
      - subscriptionId
      - compartmentId
      - isExplicitlyAssigned
      - lifecycleState
      - timeCreated
      - timeUpdated
    AvailableRegionCollection:
      description: List of available regions.
      properties:
        items:
          description: Array containing available region items.
          items:
            $ref: '#/components/schemas/AvailableRegionSummary'
          type: array
      required:
      - items
      type: object
    AvailableRegionSummary:
      description: The summary of region availability for a subscription.
      properties:
        regionName:
          description: Region availability for the subscription.
          example: us-ashburn-1
          maxLength: 127
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
      required:
      - regionName
    SubscriptionMappingCollection:
      description: List of subscription mappings.
      properties:
        items:
          description: Array containing subscription mapping items.
          items:
            $ref: '#/components/schemas/SubscriptionMappingSummary'
          type: array
      required:
      - items
      type: object
    Error:
      description: Error information.
      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
    Meter:
      description: Details provide by seller for activation of its product.
      properties:
        extendedMetadata:
          description: Additional data give by sku.
          items:
            $ref: '#/components/schemas/ExtendedMetadata'
          type: array
        name:
          description: Name of meter.
          type: string
        rateAllocation:
          description: Tha rate of this sku meter.
          format: float
          maximum: 1
          minimum: 0
          type: number
      required:
      - name
      - rateAllocation
      type: object
    SubscriptionCollection:
      description: List of subscription summaries.
      properties:
        items:
          description: Array containing subscription summary items.
          items:
            $ref: '#/components/schemas/SubscriptionSummary'
          type: array
      required:
      - items
      type: object
    SubscriptionLineItemSummary:
      description: Summary of line items in a subscription.
      properties:
        billingModel:
          description: Billing model supported by the associated line item.
          enum:
          - COMMITMENT
          - PAYGO
          - PROMOTION
          type: string
          x-obmcs-top-level-enum: '#/definitions/BillingModel'
        id:
          description: Subscription line item identifier.
          maxLength: 256
          minLength: 1
          type: string
        productCode:
          description: Product code.
          maxLength: 256
          minLength: 1
          type: string
        quantity:
          description: Product number.
          format: float
          type: number
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        timeEnded:
          description: The time the subscription item and associated products should end. An RFC 3339 formatted date and time string.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeStarted:
          description: The time the subscription item and associated products should start. An RFC 3339 formatted date and time string.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - id
      - productCode
      - quantity
      - billingModel
      - timeStarted
      - timeEnded
    SubscriptionMapping:
      description: Subscription mapping information.
      properties:
        compartmentId:
          description: OCID of the compartment. Always a tenancy OCID.
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: OCID of the mapping between subscription and compartment identified by the tenancy.
          maxLength: 255
          minLength: 1
          type: string
        isExplicitlyAssigned:
          default: false
          description: Denotes if the subscription is explicity assigned to the root compartment or tenancy.
          example: true
          type: boolean
        lifecycleState:
          description: Lifecycle state of the subscriptionMapping.
          enum:
          - CREATING
          - ACTIVE
          - INACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - FAILED
          example: ACTIVE
          type: string
        subscriptionId:
          description: OCID of the subscription.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: Date-time when subscription mapping was created.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeTerminated:
          description: Date-time when subscription mapping was terminated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: Date-time when subscription mapping was updated.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - id
      - subscriptionId
      - compartmentId
      - timeCreated
      - timeUpdated
      - isExplicitlyAssigned
      - lifecycleState
    UpdateSubscriptionDetails:
      description: The data to update a Subscription.
      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](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        displayName:
          description: The subscription name. Must be unique within the compartment. This value can be updated.
          maxLength: 1000
          minLength: 1
          type: string
        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](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
      type: object
    PricingRate:
      description: A pricing plan rate provided by the Publisher.
      properties:
        currency:
          description: The currency supported, in the format specified by ISO-4217
          example: USD
          maxLength: 3
          minLength: 3
          type: string
        rate:
          description: The amount charged for the plan in the specified currency.
          format: float
          type: number
      required:
      - currency
      - rate
      type: object
    SubscriptionDetails:
      description: The details of a subscription
      properties:
        amount:
          description: Tha amount for the currency type.
          format: float
          type: number
        billingDetails:
          description: Billing details associated with the subscription plan and its usage dimensions.
          example:
          - billingModel: USAGE_BASED
            hasGovSku: false
            meters:
            - name: API_CALLS
              rateAllocation: 1
            - name: STORAGE_USAGE
              rateAllocation: 1
            metricType: EACH
            pricingPlanKey: USAGE_BASED
            rateAllocation: 1
            sku: USAGE-001
          items:
            $ref: '#/components/schemas/BillingDetails'
          maxItems: 10
          type: array
        currency:
          description: The currency supported, in the format specified by ISO-4217
          example: USD
          maxLength: 3
          minLength: 3
          type: string
        isAutoRenew:
          description: Whether subscription should be auto-renewed at the end of cycle.
          type: boolean
        partnerRegistrationUrl:
          description: The activation link given by the partner.
          maxLength: 255
          minLength: 1
          type: string
        pricingPlan:
          $ref: '#/components/schemas/PricingPlan'
      required:
      - pricingPlan
      - partnerRegistrationUrl
      - billingDetails
      type: object
    AssignedSubscriptionLineItemSummary:
      description: Summary of the line item in an assigned subscription.
      properties:
        billingModel:
          description: Billing model supported by the associated line item.
          enum:
          - COMMITMENT
          - PAYGO
          - PROMOTION
          type: string
          x-obmcs-top-level-enum: '#/definitions/BillingModel'
        id:
          description: Subscription line item identifier.
          maxLength: 256
          minLength: 1
          type: string
        productCode:
          description: Product code.
          maxLength: 256
          minLength: 1
          type: string
        quantity:
          description: Product number.
          format: float
          type: number
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        timeEnded:
          description: The time the subscription item and associated products should end. An RFC 3339 formatted date and time string.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeStarted:
          description: The time the subscription item and associated products should start. An RFC 3339 formatted date and time string.
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - id
      - productCode
      - quantity
      - billingModel
      - timeStarted
      - timeEnded
    WorkRequestResource:
      description: A resource created or operated on by a work request.
      properties:
        actionType:
          description: 'The way in which this resource is affected by the operation tracked in the work request.

            A resource being created, updated, or deleted remains in the IN_PROGRESS state until

            work is complete for that resource, at which point it transitions to CREATED, UPDATED,

            or DELETED, respectively.

            '
          enum:
          - CREATED
          - UPDATED
          - DELETED
          - IN_PROGRESS
          - RELATED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ActionType'
        entityType:
          description: The resource type that the work request affects.
          type: string
        entityUri:
          description: The URI path that you can use for a GET request to access the resource metadata.
          type: string
        identifier:
          description: An [OCID](/iaas/Content/General/Concepts/identifiers.htm) or other unique identifier for the resource.
          type: string
        metadata:
          additionalProperties:
            type: string
          description: Additional information that helps to explain the resource.
          enum:
          - IS_DRY_RUN
          type: object
          x-obmcs-top-level-enum: '#/definitions/WorkRequestResourceMetadataKey'
      required:
      - actionType
      - entityType
      - identifier
    WorkRequestSummaryCollection:
      description: A list of work requests. Can contain both work requests and other information, such as metadata.
      properties:
        items:
          description: A list of work requests.
          items:
            $ref: '#/components/schemas/WorkRequestSummary'
          type: array
      required:
      - items
      type: object
    SubscriptionSummary:
      description: Base subscription summary type, which carries shared properties for any subscription summary version.
      discriminator:
        propertyName: entityVersion
      properties:
        compartmentId:
          description: The Oracle ID ([OCID](/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
          example: ocid1.tenancy.oc1..exampleuniqueID
          maxLength: 256
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

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

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

            '
          type: object
        entityVersion:
          description: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
          enum:
          - V1
          - V2
          example: V2
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The Oracle ID ([OCID](/Content/General/Concepts/identifiers.htm)) of the subscription.
          example: ocid1.organizationssubscription.oc1..exampleuniqueID
          maxLength: 255
          minLength: 1
          type: string
        serviceName:
          description: The type of subscription, such as 'CLOUDCM', 'AUTOANALYTICS', 'ERP', 'CRM'.
          example: CLOUDCM
          maxLength: 256
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        timeCreated:
          description: 'The date and time of creation, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time of update, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - entityVersion
      - id
      - compartmentId
      - serviceName
      - timeCreated
      - timeUpdated
      - freeformTags
      - definedTags
    AssignedSubscriptionCollection:
      description: Collection of assigned subscription summaries.
      properties:
        items:
          description: Array containing assigned subscription summary items.
          items:
            $ref: '#/components/schemas/AssignedSubscriptionSummary'
          type: array
      required:
      - items
      type: object
    AssignedSubscription:
      description: Assigned subscription type, which carries shared properties for any assigned subscription version.
      discriminator:
        propertyName: entityVersion
      properties:
        compartmentId:
          description: The Oracle ID ([OCID](/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
          example: ocid1.tenancy.oc1..exampleuniqueID
          maxLength: 256
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

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

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

            '
          type: object
        entityVersion:
          description: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
          enum:
          - V1
          - V2
          example: V2
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The Oracle ID ([OCID](/Content/General/Concepts/identifiers.htm)) of the subscription.
          example: ocid1.organizationssubscription.oc1..exampleuniqueID
          maxLength: 255
          minLength: 1
          type: string
        serviceName:
          description: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
          example: UCM
          maxLength: 256
          minLength: 1
          type: string
        timeCreated:
          description: 'The date and time of creation, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time of update, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - entityVersion
      - id
      - compartmentId
      - serviceName
      - timeCreated
      - timeUpdated
      - freeformTags
      - definedTags
    WorkRequestErrorCollection:
      description: A list of work request errors. Can contain both errors and other information, such as metadata.
      properties:
        items:
          description: A list of work request errors.
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
    CreateSubscriptionDetails:
      description: The data to create a Subscription.
      properties:
        additionalDetails:
          description: Additional details that are specific for this subscription such as activation details.
          items:
            $ref: '#/components/schemas/ExtendedMetadata'
          type: array
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to create the subscription in.

            '
          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](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        displayName:
          description: 'The subscription name. Must be unique within the compartment. This value can be updated.

            '
          maxLength: 1000
          minLength: 1
          type: string
        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](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        productId:
          description: The unique identifier of the marketplace listing in Oracle Cloud Infrastructure.
          maxLength: 255
          minLength: 1
          type: string
        realm:
          description: The realm from where customer is buying the subscription.
          maxLength: 255
          type: string
        region:
          description: The region from where customer is buying the subscription.
          maxLength: 255
          type: string
        sellerId:
          description: The OCID for the seller in SELF Service.
          maxLength: 255
          minLength: 1
          type: string
        sourceType:
          description: The type of seller in SELF Service.
          enum:
          - OCI_NATIVE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SourceType'
        subscriptionDetails:
          $ref: '#/components/schemas/SubscriptionDetails'
        tenantId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tenant to create the subscription in.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      - subscriptionDetails
      - sellerId
      - productId
      - tenantId
      type: object
    ExtendedMetadata:
      description: Additional metadata key/value pairs.
      properties:
        key:
          description: Additional attribute for extendedMetadata.
          type: string
        value:
          description: It contains the value of above key.
          type: string
      required:
      - key
      - value
      type: object
    CancelSubscriptionDetails:
      description: The data to cancel a Subscription.
      properties:
        reason:
          description: Optional reason provided by the customer for the cancellation.
          maxLength: 1000
          type: string
      type: object
    SubscriptionLineItemCollection:
      description: Collection of line item summaries in a subscription.
      properties:
        items:
          description: Array containing line item summaries in a subscription.
          items:
            $ref: '#/components/schemas/SubscriptionLineItemSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestSummary:
      description: Summary information about an asynchronous work request.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.

            '
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
          type: string
        operationType:
          description: The asynchronous operation tracked by this work request.
          enum:
          - CREATE_SUBSCRIPTION
          - UPDATE_SUBSCRIPTION
          - DELETE_SUBSCRIPTION
          - MOVE_SUBSCRIPTION
          - SUBMIT_SUBSCRIPTION_USAGE_BATCH
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work

            that must be performed.

            '
          format: float
          type: number
        resources:
          description: The resources that are affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: The status of the work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - WAITING
          - NEEDS_ATTENTION
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the work request was created, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the work request was finished, in the format defined by

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the work request was started, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the work request was updated, in the format defined by

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    WorkRequestError:
      description: An error encountered while performing an operation that is tracked by a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occurred. For a list of error codes, see

            [API Errors](/iaas/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error message.
          type: string
        timestamp:
          description: 'The date and time the error occurred, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    BillingDetails:
      description: Billing detail entry associated with a subscription.
      properties:
        billingModel:
          description: The billing model this billing detail applies to.
          enum:
          - FLAT_RATE
          - USAGE_BASED
          type: string
        hasGovSku:
          description: Whether this sku is assign to gov product.
          type: boolean
        meters:
          description: The meters associated with sku.
          items:
            $ref: '#/components/schemas/Meter'
          type: array
        metricType:
          description: The part's metric.
          enum:
          - OCPU_HOURS
          - INSTANCE_HOURS
          - CORE_HOURS
          - EACH
          type: string
          x-obmcs-top-level-enum: '#/definitions/MetricType'
        pricingPlanKey:
          description: Unique key used to map this SKU to the pricing plan.
          type: string
        rateAllocation:
          description: Tha rate of this sku meter.
          format: float
          maximum: 1
          minimum: 0
          type: number
        sku:
          description: Sku for service.
          type: string
      required:
      - pricingPlanKey
      - billingModel
      - sku
      - metricType
      - rateAllocation
      - meters
      type: object
    AssignedSubscriptionLineItemCollection:
      description: Collection of line item summaries in an assigned subscription.
      properties:
        items:
          description: Array containing line item summaries in an assigned subscription.
          items:
            $ref: '#/components/schemas/AssignedSubscriptionLineItemSummary'
          type: array
      required:
      - items
      type: object
    UsageDimension:
      description: A metered usage dimension associated with a usage-based or hybrid pricing plan.
      properties:
        dimensionBillingFrequency:
          description: Specifies the interval at which the usage dimension is billed.
          enum:
          - MONTHLY
          - QUARTERLY
          - SEMI_ANNUAL
          - ANNUAL
          - BIENNIAL
          - TRIENNIAL
          - YEARLY
          type: string
          x-obmcs-top-level-enum: '#/definitions/BillingFrequency'
        dimensionDescription:
          description: A detailed explanation of the usage dimension.
          maxLength: 4000
          minLength: 1
          type: string
        dimensionKey:
          description: The stable key used internally to map this usage dimension to billing details.
          maxLength: 255
          minLength: 1
          type: string
        dimensionName:
          description: The name of the usage dimension.
          maxLength: 1000
          minLength: 1
          type: string
        includedQuantity:
          description: Quantity included in the base fee for hybrid plans.
          format: float
          minimum: 0
          type: number
        metricType:
          description: The metric type in which usage is measured.
          enum:
          - OCPU_HOURS
          - INSTANCE_HOURS
          - CORE_HOURS
          - EACH
          type: string
          x-obmcs-top-level-enum: '#/definitions/MetricType'
        rates:
          description: Dimension-level rates in various supported currencies.
          items:
            $ref: '#/components/schemas/PricingRate'
          maxItems: 50
          type: array
      required:
      - dimensionName
      - dimensionKey
      - dimensionDescription
      - metricType
      - dimensionBillingFrequency
      - rates
      type: object
    ChangeSubscriptionCompartmentDetails:
      description: The configuration details for the move operation.
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the Subscription to.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
    Subscription:
      description: Base subscription type, which carries shared properties for any subscription version.
      discriminator:
        propertyName: entityVersion
      properties:
        compartmentId:
          description: The Oracle ID ([OCID](/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
          example: ocid1.tenancy.oc1..exampleuniqueID
          maxLength: 256
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

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

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

            '
          type: object
        entityVersion:
          description: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
          enum:
          - V1
          - V2
          example: V2
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The Oracle ID ([OCID](/Content/General/Concepts/identifiers.htm)) of the subscription.
          example: ocid1.organizationssubscription.oc1..exampleuniqueID
          maxLength: 256
          minLength: 1
          type: string
        serviceName:
          description: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
          example: UCM
          maxLength: 256
          minLength: 1
          type: string
        timeCreated:
          description: 'The date and time of creation, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time of update, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - entityVersion
      - id
      - compartmentId
      - serviceName
      - timeCreated
      - timeUpdated
      - freeformTags
      - definedTags
    Subscription_3:
      description: The model for a listing subscription.
      properties:
        additionalDetails:
          description: Additional details that are specific for this subscription such as activation details.
          items:
            $ref: '#/components/schemas/ExtendedMetadata'
          type: array
        compartmentId:
          description: The unique identifier for the compartment where the subscription was purchased.
          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](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        displayName:
          description: The subscription name. Must be unique within the compartment. This value can be updated.
          maxLength: 1000
          minLength: 1
          type: string
        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](/iaas/Content/General/Concepts/resourcetags.htm).


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

            '
          type: object
        id:
          description: The unique identifier for the subscription within a specific compartment.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleDetails:
          description: 'A message that describes the current state of the Subscription in more detail. For example,

            can be used to provide actionable information for a resource in the Failed state.

            '
          enum:
          - CREATED
          - PENDING_ACTIVATION
          - PROVISIONING_STARTED
          - PROVISIONING_COMPLETED
          - PROVISIONING_FAILED
          - ACTIVE
          - EXPIRED
          - TERMINATED
          - FAILED
          - DELETING
          - UPDATING
          - DELETED
          - PENDING_CANCELLATION
          - SUSPENDED
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleDetailsEnum'
        lifecycleState:
          description: The current lifecycle state of the Subscription.
          enum:
          - ACTIVE
          - INACTIVE
          - DELETED
          - FAILED
          type: string
          x-obmcs-top-level-enum: '#/definitions/LifecycleStateEnum'
        productId:
          description: The unique OCID of the product, effectively functioning as the listing ID.
          maxLength: 255
          minLength: 1
          type: string
        realm:
          description: The realm from where customer is buying the subscription.
          maxLength: 255
          type: string
        region:
          description: The region from where customer is buying the subscription.
          maxLength: 255
          type: string
        sellerId:
          description: The OCID that identifies the seller within the platform.
          maxLength: 255
          minLength: 1
          type: string
        sourceType:
          description: The type of seller in SELF Service.
          enum:
          - OCI_NATIVE
          - THIRD_PARTY
          type: string
          x-obmcs-top-level-enum: '#/definitions/SourceType'
        subscriptionDetails:
          $ref: '#/components/schemas/SubscriptionDetails'
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

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


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

              '
            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
        tenantId:
          description: The unique identifier for the tenant where the subscription was purchased.
          type: string
        timeCreated:
          description: 'The date and time the Subscription was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeEnded:
          description: 'The date and time the Subscription was ended, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the Subscription was started, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the Subscription was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).


            Example: `2016-08-25T21:10:29.600Z`

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - lifecycleState
      - timeCreated
      - displayName
      - freeformTags
      - definedTags
      - tenantId
      type: object
    WorkRequestLogEntry:
      description: A log message from performing an operation that is tracked by a work request.
      properties:
        message:
          description: A human-readable log message.
          type: string
        timestamp:
          description: 'The date and time the log message was written, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - message
      - timestamp
    PricingPlan:
      description: A pricing plan details provided by the Publisher.
      properties:
        billingFrequency:
          description: Specifies the interval at which billing occurs for the subscription plan or usage dimension.
          enum:
          - MONTHLY
          - QUARTERLY
          - SEMI_ANNUAL
          - ANNUAL
          - BIENNIAL
          - TRIENNIAL
          - YEARLY
          type: string
          x-obmcs-top-level-enum: '#/definitions/BillingFrequency'
        dimensions:
          description: Metered usage dimensions associated with the pricing plan.
          example:
          - dimensionBillingFrequency: MONTHLY
            dimensionDescription: Requests included in the base plan.
            dimensionKey: included_api_requests
            dimensionName: Included API Requests
            includedQuantity: 10000
            metricType: EACH
            rates:
            - currency: USD
              rate: 0.1
          - dimensionBillingFrequency: MONTHLY
            dimensionDescription: Requests billed beyond the included quantity.
            dimensionKey: overage_api_requests
            dimensionName: Overage API Requests
            metricType: EACH
            rates:
            - currency: USD
              rate: 0.02
          items:
            $ref: '#/components/schemas/UsageDimension'
          maxItems: 10
          type: array
        planDescription:
          description: A detailed explanation of the subscription plan.
          maxLength: 4000
          minLength: 1
          type: string
        planDuration:
          description: Specifies the duration of the subscription plan.
          enum:
          - MONTHLY
          - QUARTERLY
          - SEMI_ANNUAL
          - ANNUAL
          - BIENNIAL
          - TRIENNIAL
          type: string
        planName:
          description: The name of the subscription plan used to identify the plan.
          maxLength: 255
          minLength: 1
          type: string
        planType:
          description: The type of the subscription plan.
          enum:
          - FIXED
          - USAGE_BASED
          - HYBRID
          type: string
        rates:
          description: The pricing details of the subscription plan in various supported currencies.
          items:
            $ref: '#/components/schemas/PricingRate'
          type: array
      required:
      - planType
      - planName
      - billingFrequency
      - rates
      type: object
    CreateSubscriptionMappingDetails:
      description: CreateSubscriptionMappingDetails contains subscription and compartment identified by the tenancy, and OCID information.
      properties:
        compartmentId:
          description: OCID of the compartment. Always a tenancy OCID.
          maxLength: 255
          minLength: 1
          type: string
        subscriptionId:
          description: OCID of Subscription.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      - subscriptionId
    AssignedSubscriptionSummary:
      description: Assigned subscription summary type, which carries shared properties for any assigned subscription summary version.
      discriminator:
        propertyName: entityVersion
      properties:
        compartmentId:
          description: The Oracle ID ([OCID](/Content/General/Concepts/identifiers.htm)) of the owning compartment. Always a tenancy OCID.
          example: ocid1.tenancy.oc1..exampleuniqueID
          maxLength: 256
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

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

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

            '
          type: object
        entityVersion:
          description: The entity version of the subscription, whether V1 (the legacy schema version), or V2 (the latest 20230401 API version).
          enum:
          - V1
          - V2
          example: V2
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

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

            '
          type: object
        id:
          description: The Oracle ID ([OCID](/Content/General/Concepts/identifiers.htm)) of the subscription.
          example: ocid1.organizationssubscription.oc1..exampleuniqueID
          maxLength: 255
          minLength: 1
          type: string
        serviceName:
          description: The type of subscription, such as 'UCM', 'SAAS', 'ERP', 'CRM'.
          example: UCM
          maxLength: 256
          minLength: 1
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only string, integer, and boolean types are supported.

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

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

              '
            type: object
          description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

            '
          type: object
        timeCreated:
          description: 'The date and time of creation, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time of update, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29.

            '
          example: 2016-08-29 09:12:33.001000+00:00
          format: date-time
          type: string
      required:
      - entityVersion
      - id
      - compartmentId
      - serviceName
      - timeCreated
      - timeUpdated
      - freeformTags
      - definedTags
    WorkRequestLogEntryCollection:
      description: A list of work request logs. Can contain both logs and other information, such as metadata.
      properties:
        items:
          description: A list of work request log entries.
          items:
            $ref: '#/components/schemas/WorkRequestLogEntry'
          type: array
      required:
      - items
      type: object
    WorkRequest:
      description: 'An asynchronous work request. Work requests help you monitor long-running operations. When you start a long-running operation,

        the service creates a work request. A work request is an activity log that lets you track each step in the operation''s

        progress. Each work request has an OCID that lets you interact with it programmatically and use it for automation.

        '
      properties:
        compartmentId:
          description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.

            '
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
          type: string
        operationType:
          description: The asynchronous operation tracked by this work request.
          enum:
          - CREATE_SUBSCRIPTION
          - UPDATE_SUBSCRIPTION
          - DELETE_SUBSCRIPTION
          - MOVE_SUBSCRIPTION
          - SUBMIT_SUBSCRIPTION_USAGE_BATCH
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: 'Shows the progress of the operation tracked by the work request, as a percentage of the total work

            that must be performed.

            '
          format: float
          type: number
        resources:
          description: The resources that are affected by the work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: The status of the work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - WAITING
          - NEEDS_ATTENTION
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: 'The date and time the work request was created, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the work request was finished, in the format defined by

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the work request was started, in the format defined by

            [RFC 3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the work request was updated, in the format defined by

            [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
  parameters:
    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
      x-default-description: 'null'
      schema:
        type: string
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order can be provided.

        * The default order for timeCreated is descending.

        * The default order for displayName is ascending.

        * If no value is specified, timeCreated is the default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    ResourceIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request.
      in: query
      name: resourceId
      x-default-description: 'null'
      schema:
        type: string
    SubscriptionMappingLifecycleStateQueryParam:
      description: The lifecycle state of the resource.
      in: query
      name: lifecycleState
      x-default-description: 'null'
      x-obmcs-enumref: '#/definitions/SubscriptionMapping/lifecycleState'
      schema:
        type: string
    SubscriptionIdPathParam:
      description: OCID of the subscription.
      in: path
      name: subscriptionId
      required: true
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        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
      required: false
      schema:
        type: string
    WorkRequestStatusQueryParam:
      description: A filter to return only the resources that match the given lifecycle state.
      in: query
      name: status
      required: false
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/OperationStatus'
      schema:
        type: string
        enum:
        - ACCEPTED
        - IN_PROGRESS
        - WAITING
        - NEEDS_ATTENTION
        - FAILED
        - SUCCEEDED
        - CANCELING
        - CANCELED
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
    SortOrderQueryParam_2:
      description: The sort order to use, either ascending (`ASC`) or descending (`DESC`).
      in: query
      name: sortOrder
      x-default-description: 'The default value depends upon `sortBy`, and

        in general is `DESC` when sorting by time and `ASC` otherwise.

        '
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    EntityVersionOptionalQueryParam:
      description: The version of the subscription entity.
      in: query
      name: entityVersion
      x-default-description: 'null'
      x-obmcs-top-level-enum: '#/definitions/EntityVersion'
      schema:
        type: string
        enum:
        - V1
        - V2
    SubscriptionMappingIdOptionalQueryParam:
      description: A unique ID for subscription and tenancy mapping.
      in: query
      name: subscriptionMappingId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    AssignedSubscriptionIdPathParam:
      description: OCID of the assigned Oracle Cloud Subscription.
      in: path
      name: assignedSubscriptionId
      required: true
      x-default-description: 'null'
      schema:
        type: string
        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
    WorkRequestIdPathParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    WorkRequestIdQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request.
      in: query
      name: workRequestId
      x-default-description: 'null'
      schema:
        type: string
    SubscriptionIdOptionalQueryParam:
      description: The ID of the subscription to which the tenancy is associated.
      in: query
      name: subscriptionId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    SortOrderQueryParam:
      description: The sort order to use, whether 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-default-description: The default order depends on what parameter is being sorted by.
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
    SubscriptionIdQueryParam:
      description: OCID of the subscription.
      in: query
      name: subscriptionId
      required: true
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    WorkRequestLogAndErrorSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timestamp
        default: timestamp
    RequestIdHeader_2:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        The only valid characters for request IDs are letters, numbers,

        underscore, and dash.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
    IfMatchHeader_2:
      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
      required: false
      schema:
        type: string
    PaginationTokenQueryParam_2:
      description: 'For list pagination. The value of the opc-next-page response header from the previous

        "List" call. For important details about how pagination works, see

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

        '
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    PaginationLimitQueryParam_2:
      description: 'For list pagination. The maximum number of results per page, or items to return in a

        paginated "List" call. For important details about how pagination works, see

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

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    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

        will be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    RetryTokenHeader_2:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of running 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 removed from the system, then a retry of the original creation request

        might be rejected.

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    SubscriptionIdPathParam_3:
      description: The unique identifier for the subscription.
      in: path
      name: subscriptionId
      required: true
      schema:
        type: string
    WorkRequestSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeAccepted
        default: timeAccepted
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    CompartmentIdOptionalQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: false
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
    CompartmentIdQueryParam_3:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.
      in: query
      name: compartmentId
      x-default-description: 'null'
      schema:
        type: string
  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-refined-from:
- oci-organizations-1-openapi.yaml
- oci-organizations-openapi.yaml
- oci-self-openapi.yaml
- oci-usage-proxy-openapi.yaml
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    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
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      type: integer
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

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

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

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

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

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

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

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

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

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

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.idm.agcs.cp