openapi: 3.2.0 info: description: Use the SELF Service API to manage Subscriptions in Oracle Cloud Infrastructure Marketplace. For more information, see [Overview of Marketplace](/Content/Marketplace/Concepts/marketoverview.htm) title: SELF Service Partner Integeration API version: '20260129' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/cfd2e0a7b06e7fe7f63b265844c1c5992d39e9c7460b8bb019b058fd9bbcd555.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the SELF Service API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/cfd2e0a7b06e7fe7f63b265844c1c5992d39e9c7460b8bb019b058fd9bbcd555.yaml what: the harvested document for SELF Service API servers: - url: http://127.0.0.1/20260129 - url: https://127.0.0.1/20260129 tags: - name: PartnerIntegeration paths: /partners: get: description: 'Lists marketplace publisher partner info for a compartment. ' operationId: ListPartners parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Lists marketplace publisher partners for the compartment. 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/PartnerCollection' 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: Lists partner info tags: - PartnerIntegeration x-related-resource: '#/definitions/Partner' /partners/actions/batchUsageRecords: post: description: 'Asynchronously submits a UTF-8 CSV usage file for marketplace offers. The file must not exceed 50 MB or 30,000 rows and must include required usage columns. ' operationId: SubmitSubscriptionUsageBatch parameters: - $ref: '#/components/parameters/CompartmentIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The usage batch was accepted for asynchronous processing. 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' 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: Submits a CSV batch of usage records for marketplace offers. tags: - PartnerIntegeration x-related-resource: '#/definitions/CreateSubscriptionUsageRecordDetails' requestBody: content: application/json: schema: format: binary type: string description: 'UTF-8 CSV file with no more than 30,000 usage records and a maximum size of 50 MB. Required columns are `MarketplaceOfferId`, `Id`, `Amount`, `CurrencyCode`, `UsageStartTime`, `UsageEndTime`, and `UsageDimensionName`. Optional columns are `ConsumedQuantity`, `CustomerTenancyId`, `BillingIdentifier`, `ProductSku`, `UnitOfMeasure`, `UnitPrice`, `ContractDuration`, and `AdditionalMetadata`. When provided in CSV, `AdditionalMetadata` must be a JSON array of `ExtendedMetadata` objects. `MarketplaceOfferId` must be a subscription or private offer OCID. ' required: true /partners/actions/submitUsageRecords: post: description: 'Synchronously submits usage records for marketplace offers. Each record must include `id`, `marketplaceOfferId`, `amount`, `currencyCode`, `timeUsageStarted`, `timeUsageEnded`, and `usageDimensionName`. ' operationId: SubmitSubscriptionUsageRecords parameters: - $ref: '#/components/parameters/CompartmentIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The usage records were validated and stored synchronously. 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' 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: Submits one or more usage records for marketplace offers. tags: - PartnerIntegeration x-related-resource: '#/definitions/CreateSubscriptionUsageRecordDetails' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitSubscriptionUsageRecordsDetails' description: 'Usage records to submit for marketplace offers. ' required: true /partners/subscriptions: get: description: Gets information about a Subscription. operationId: ListingSubscriptions parameters: - $ref: '#/components/parameters/ListingIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeaderParam' responses: 200: description: The Subscription 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/ListingSubscriptionsCollection' 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 the summary of subscriptions for a particular Listing. tags: - PartnerIntegeration x-related-resource: '#/definitions/ListingSubscriptionsCollection' /partners/subscriptions/actions/resolve: post: description: 'This API returns the subscription details by resolving JWT token to corresponding subscription and move its state to Pending Activation state. ' operationId: ResolveSubscription parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Returns the resolved subscription details. 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/PartnerSubscription' 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: Resolve a Subscription. tags: - PartnerIntegeration x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/PartnerSubscription' requestBody: content: application/json: schema: $ref: '#/components/schemas/ResolveSubscriptionDetails' description: Details for the new Subscription. required: true /partners/subscriptions/{subscriptionId}/actions/activate: post: description: 'Activates a subscription identified by the provided subscription ID and updates its status. ' operationId: ActivateSubscription parameters: - $ref: '#/components/parameters/SubscriptionIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The subscription was successfully activated. 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/ActivateSubscriptionResult' 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: Activates a Subscription. tags: - PartnerIntegeration x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/PartnerSubscription' requestBody: content: application/json: schema: $ref: '#/components/schemas/ActivateSubscriptionDetails' description: The details for activating the subscription. required: true components: parameters: PaginationTokenQueryParam: 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 SortByQueryParam: description: The field to sort by. Only one sort order may be provided. in: query name: sortBy required: false x-default-description: 'The field to sort by. Only one sort order may be provided. ' schema: type: string enum: - timeCreated - displayName - productId ListingIdQueryParam: description: The unique identifier for the listing. in: query name: listingId required: true schema: type: string SubscriptionIdPathParam: description: The unique identifier for the subscription. in: path name: subscriptionId required: true schema: type: string CompartmentIdQueryParam: 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 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 PaginationLimitQueryParam: 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 SortOrderQueryParam: 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 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 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 OpcRequestIdHeaderParam: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id required: false schema: type: string CompartmentIdHeader: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment associated with the usage records request. in: header name: compartment-id required: true schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the given name. in: query name: displayName required: false x-default-description: 'null' schema: type: string RequestIdHeader: 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 schemas: 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 message. type: string required: - code - message ListingSubscriptionSummary: description: 'The summary information about 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 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 state of the Subscription. enum: - ACTIVE - INACTIVE - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleStateEnum' productId: description: The unique identifier of marketplace listing in Oracle Cloud Infrastructure. maxLength: 255 minLength: 1 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 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 required: - displayName type: object CreateSubscriptionUsageRecordDetails: description: 'A single usage record to submit for a marketplace offer. The usage window must have `timeUsageStarted` before `timeUsageEnded`. ' properties: additionalMetadata: description: Additional key/value metadata associated with this usage record for extensibility. items: $ref: '#/components/schemas/ExtendedMetadata' type: array amount: description: The non-negative usage cost computed by the partner for the submitted usage quantity. format: double minimum: 0 type: number billingIdentifier: description: The partner billing identifier associated with this usage record. maxLength: 255 minLength: 1 type: string billingPeriod: description: The billing period associated with this usage record in `YYYY-MM` format. maxLength: 7 minLength: 7 pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$ type: string billingType: description: The billing type this usage record applies to. enum: - FLAT_RATE - USAGE_BASED type: string consumedQuantity: description: An optional non-negative usage quantity being reported. format: double minimum: 0 type: number contractDuration: description: The contract duration associated with this usage record. enum: - MONTHLY - QUARTERLY - SEMI_ANNUAL - ANNUAL - BIENNIAL - TRIENNIAL - YEARLY type: string x-obmcs-top-level-enum: '#/definitions/BillingFrequency' currencyCode: description: The ISO-4217 currency submitted for the computed usage cost. format: x-obmcs-currency-code maxLength: 3 minLength: 3 type: string customerTenancyId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the customer tenancy associated with this usage record. maxLength: 255 minLength: 1 type: string id: description: Partner-provided unique identifier for this usage record. This identifier must be unique per partner. maxLength: 255 minLength: 1 type: string marketplaceOfferId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the marketplace offer being billed. A submit request can contain records for multiple marketplace offers. maxLength: 255 minLength: 1 type: string productSku: description: The product SKU associated with this usage record. maxLength: 255 minLength: 1 type: string timeUsageEnded: description: The exclusive end timestamp for the usage window. This value must be after `timeUsageStarted`. format: date-time type: string timeUsageStarted: description: The inclusive start timestamp for the usage window. This value must be before `timeUsageEnded`. format: date-time type: string unitOfMeasure: description: The unit of measure associated with the reported usage quantity. maxLength: 255 minLength: 1 type: string unitPrice: description: The unit price associated with this usage record. format: double minimum: 0 type: number usageDimensionName: description: The pricing dimension against which usage is being reported. maxLength: 255 minLength: 1 type: string usageRecordId: description: Partner-provided usage record identifier for traceability. maxLength: 255 minLength: 1 type: string required: - id - marketplaceOfferId - usageDimensionName - amount - currencyCode - timeUsageStarted - timeUsageEnded type: object PartnerSummary: description: Summary of a marketplace publisher partner. properties: compartmentId: description: 'The unique identifier of the compartment of partner. ' 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 display name of marketplace publisher partner. 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 of the marketplace publisher partner. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The current lifecycle state of the marketplace publisher partner. type: string x-obmcs-enumref: '#/definitions/Partner/lifecycleState' 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 required: - id - compartmentId - lifecycleState type: object ActivateSubscriptionDetails: description: Request model for activating a subscription. Contains necessary details to perform the activation. 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 productId: description: 'The unique identifier of the marketplace product listing. ' maxLength: 255 minLength: 1 type: string required: - productId 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 PartnerSubscription: description: 'These api for partner to communicate to OCI. ' properties: additionalDetails: description: Additional details that are specific for this subscription such as activation details. items: $ref: '#/components/schemas/ExtendedMetadata' type: array displayName: description: The subscription name. Must be unique within the compartment. This value can be updated. maxLength: 1000 minLength: 1 type: string isAutoRenew: description: Whether subscription should be auto-renewed at the end of cycle. type: boolean 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 state of the Subscription. enum: - ACTIVE - INACTIVE - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleStateEnum' pricingPlan: $ref: '#/components/schemas/PricingPlan' productId: description: The unique OCID of the product, effectively functioning as the listing ID. 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' subscriptionId: description: The unique identifier of the Subscription. 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: - subscriptionId type: object ActivateSubscriptionResult: description: Response model for the activation of a subscription. Includes the details of the activated subscription. properties: displayName: description: The subscription name. Must be unique within the compartment. This value can be updated. example: Premium Cloud Subscription maxLength: 1000 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 state of the Subscription. enum: - ACTIVE - INACTIVE - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/LifecycleStateEnum' subscriptionId: description: The unique identifier of the activated subscription. type: string timeEnd: description: The end date of the subscription. example: '2025-01-01T00:00:00Z' format: date-time type: string timeStart: description: The start date of the subscription. example: '2024-01-01T00:00:00Z' format: date-time type: string required: - subscriptionId type: object ResolveSubscriptionDetails: description: Request model used to resolve and retrieve subscription details for a customer subscription, given a selfToken and the productId. 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 productId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the marketplace product listing. ' maxLength: 255 minLength: 1 type: string selfToken: description: The base 64 encoded JWT token which is mapped to a particular subscription type: string required: - selfToken - productId 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 PartnerCollection: description: Results of listing marketplace publisher partners. properties: items: description: The list of marketplace publisher partners. items: $ref: '#/components/schemas/PartnerSummary' type: array required: - items type: object SubmitSubscriptionUsageRecordsDetails: description: 'Request payload to submit one or more usage records for marketplace offers. ' properties: subscriptionUsageRecords: description: The usage records to submit. The array must contain at least one record and no more than 1,000 records. items: $ref: '#/components/schemas/CreateSubscriptionUsageRecordDetails' maxItems: 1000 minItems: 1 type: array required: - subscriptionUsageRecords 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 ListingSubscriptionsCollection: description: Results of a subscription search. Contains both SubscriptionSummary items and other information, such as metadata. properties: items: description: List of subscriptions for particular listing. items: $ref: '#/components/schemas/ListingSubscriptionSummary' type: array required: - items type: object 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 responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string 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). ' type: string opc-prev-page: description: For moving to previous page. 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-total-items: description: Total items on the page. type: integer 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. ' 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 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 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 x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.oci.self