List Subscription eligible offers for renewal.

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://developer.cloudcockpit.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "CloudCockpit MCP server": {
    "url": "https://developer.cloudcockpit.com/mcp"
  }
}

GET /v1/customers/{customerId}/subscriptions/{subscriptionId}/eligible-renewal-offers

Bearer auth

Returns a list of eligible offers for renewal for a specified subscription.

Headers

X-Tenant string Required

The domain used to access the portal.
Authorization string Required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Default value is Bearer eyJ0eXAiO....
X-Correlation-Id string(uuid)

This header is optional and by setting it you can correlate the audit logs made by this request.

Path parameters

customerId string(uuid) Required

GUID Unique identifier for the customer. The subscription must belong to this customer, otherwise this request will fail.
subscriptionId string(uuid) Required

GUID Unique identifier for the subscription.

Responses

200

text/plain

text/plain application/json text/json

OK
Hide response attributes Show response attributes object
- id string(uuid)
  
  The id of the offer.
- name string | null
  
  The name of the offer.
- providerOfferId string | null
  
  The provider's offer identifier, without the availability (productId:skuId). This is the identifier the offers are stored with.
- providerOfferIdWithAvailability string | null
  
  The provider's offer identifier including the availability (productId:skuId:availabilityId). This is the identifier the provider expects when scheduling a renewal.
- minQuantity integer(int32)
  
  The minimum quantity for this offer.
- maxQuantity integer(int32)
  
  The maximum quantity for this offer.
- prices array[object] | null
  
  The offer prices, used to derive the available terms, billing frequencies and renewal price.
  
  Hide prices attributes Show prices attributes object
  
  View model that represents an offer price.
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
Hide response attributes Show response attributes object
- id string(uuid)
  
  The id of the offer.
- name string | null
  
  The name of the offer.
- providerOfferId string | null
  
  The provider's offer identifier, without the availability (productId:skuId). This is the identifier the offers are stored with.
- providerOfferIdWithAvailability string | null
  
  The provider's offer identifier including the availability (productId:skuId:availabilityId). This is the identifier the provider expects when scheduling a renewal.
- minQuantity integer(int32)
  
  The minimum quantity for this offer.
- maxQuantity integer(int32)
  
  The maximum quantity for this offer.
- prices array[object] | null
  
  The offer prices, used to derive the available terms, billing frequencies and renewal price.
  
  Hide prices attributes Show prices attributes object
  
  View model that represents an offer price.
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
Hide response attributes Show response attributes object
- id string(uuid)
  
  The id of the offer.
- name string | null
  
  The name of the offer.
- providerOfferId string | null
  
  The provider's offer identifier, without the availability (productId:skuId). This is the identifier the offers are stored with.
- providerOfferIdWithAvailability string | null
  
  The provider's offer identifier including the availability (productId:skuId:availabilityId). This is the identifier the provider expects when scheduling a renewal.
- minQuantity integer(int32)
  
  The minimum quantity for this offer.
- maxQuantity integer(int32)
  
  The maximum quantity for this offer.
- prices array[object] | null
  
  The offer prices, used to derive the available terms, billing frequencies and renewal price.
  
  Hide prices attributes Show prices attributes object
  
  View model that represents an offer price.
  
  termDuration object
  
  The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears
  
  Additional properties are NOT allowed.
  
  Hide termDuration attribute Show termDuration attribute object
  
  name string | null
  
  The name of the enumeration.
  
  segment object
  
  The offer segment. Possible values: Commercial, Education, Government or NonProfit
  
  Additional properties are NOT allowed.
  
  Hide segment attribute Show segment attribute object
  
  name string | null
  
  The name of the enumeration.
  
  region object
  
  Additional properties are NOT allowed.
  
  Hide region attribute Show region attribute object
  
  value string | null
  
  The value that represents a country in standard ISO 3166-1 alpha-2. The value contains only two letters in uppercase format. This standard is available at https://www.iban.com/country-codes.
  
  billingFrequencies array[object] | null
  
  The offer price Billing Frequencies.
  
  Hide billingFrequencies attribute Show billingFrequencies attribute object
  
  The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None
  
  name string | null
  
  The name of the enumeration.
  
  costPrice object
  
  Additional properties are NOT allowed.
  
  Hide costPrice attributes Show costPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  revenuePrice object
  
  Additional properties are NOT allowed.
  
  Hide revenuePrice attributes Show revenuePrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
  
  erpPrice object
  
  Additional properties are NOT allowed.
  
  Hide erpPrice attributes Show erpPrice attributes object
  
  value number(double)
  
  The price value.
  
  currency object
  
  Additional properties are NOT allowed.
  
  Hide currency attribute Show currency attribute object
  
  name string | null
  
  The name of the currency.
400

text/plain

text/plain application/json text/json

Bad Request
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
401

Unauthorized
403

Forbidden
404

text/plain

text/plain application/json text/json

Not Found
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
500

text/plain

text/plain application/json text/json

Internal Server Error
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.

GET /v1/customers/{customerId}/subscriptions/{subscriptionId}/eligible-renewal-offers

curl \
 --request GET 'https://api.cloudcockpit.com/v1/customers/{customerId}/subscriptions/{subscriptionId}/eligible-renewal-offers' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"

Response examples (200)

[
  {
    "id": "string",
    "name": "string",
    "providerOfferId": "string",
    "providerOfferIdWithAvailability": "string",
    "minQuantity": 42,
    "maxQuantity": 42,
    "prices": [
      {
        "termDuration": {
          "name": "string"
        },
        "segment": {
          "name": "string"
        },
        "region": {
          "value": "string"
        },
        "billingFrequencies": [
          {
            "name": "string"
          }
        ],
        "costPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "revenuePrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "erpPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        }
      }
    ]
  }
]

Response examples (200)

[
  {
    "id": "string",
    "name": "string",
    "providerOfferId": "string",
    "providerOfferIdWithAvailability": "string",
    "minQuantity": 42,
    "maxQuantity": 42,
    "prices": [
      {
        "termDuration": {
          "name": "string"
        },
        "segment": {
          "name": "string"
        },
        "region": {
          "value": "string"
        },
        "billingFrequencies": [
          {
            "name": "string"
          }
        ],
        "costPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "revenuePrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        },
        "erpPrice": {
          "value": 42.0,
          "currency": {
            "name": "string"
          }
        }
      }
    ]
  }
]

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (404)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (404)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}