List Subscription eligible transitions

GET /v1/customers/{customerId}/subscriptions/{subscriptionId}/eligible-transitions

Returns a list of eligible transitions 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

    OK

    Hide response attributes Show response attributes object
    • destinationSubscriptionId string(uuid) | null

      The destination subscription identifier.

    • destinationProviderSubscriptionId string | null

      The destination subscription provider identifer.

    • offerName string | null

      The name of the offer.

    • offerId string(uuid)

      The name of the offer.

    • providerOfferId string | null Required

      The provider offer identifier.

    • providerOfferIdWithAvailability string | null Required

      The provider offer identifier.

    • imageUrl string | null

      The offer image URL.

    • quantity integer(int32) Required

      The quantity.

    • termDuration object Required

      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.

    • billingFrequency object Required

      The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None

      Additional properties are NOT allowed.

      Hide billingFrequency attribute Show billingFrequency attribute object
      • name string | null

        The name of the enumeration.

    • transitionType string | null Required

      The type of transition ('transition_only','transition_with_license_transfer').

    • transitionEvents array[object] | null

      A list with the events related to a transition.

      Hide transitionEvents attributes Show transitionEvents attributes object
      • name string | null

        The trasition event name.

      • status string | null

        The trasition event status.

    Hide response attributes Show response attributes object
    • destinationSubscriptionId string(uuid) | null

      The destination subscription identifier.

    • destinationProviderSubscriptionId string | null

      The destination subscription provider identifer.

    • offerName string | null

      The name of the offer.

    • offerId string(uuid)

      The name of the offer.

    • providerOfferId string | null Required

      The provider offer identifier.

    • providerOfferIdWithAvailability string | null Required

      The provider offer identifier.

    • imageUrl string | null

      The offer image URL.

    • quantity integer(int32) Required

      The quantity.

    • termDuration object Required

      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.

    • billingFrequency object Required

      The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None

      Additional properties are NOT allowed.

      Hide billingFrequency attribute Show billingFrequency attribute object
      • name string | null

        The name of the enumeration.

    • transitionType string | null Required

      The type of transition ('transition_only','transition_with_license_transfer').

    • transitionEvents array[object] | null

      A list with the events related to a transition.

      Hide transitionEvents attributes Show transitionEvents attributes object
      • name string | null

        The trasition event name.

      • status string | null

        The trasition event status.

    Hide response attributes Show response attributes object
    • destinationSubscriptionId string(uuid) | null

      The destination subscription identifier.

    • destinationProviderSubscriptionId string | null

      The destination subscription provider identifer.

    • offerName string | null

      The name of the offer.

    • offerId string(uuid)

      The name of the offer.

    • providerOfferId string | null Required

      The provider offer identifier.

    • providerOfferIdWithAvailability string | null Required

      The provider offer identifier.

    • imageUrl string | null

      The offer image URL.

    • quantity integer(int32) Required

      The quantity.

    • termDuration object Required

      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.

    • billingFrequency object Required

      The billing frequency for this entity. Possible values: OneTime, Monthly, Annual, Triennial or None

      Additional properties are NOT allowed.

      Hide billingFrequency attribute Show billingFrequency attribute object
      • name string | null

        The name of the enumeration.

    • transitionType string | null Required

      The type of transition ('transition_only','transition_with_license_transfer').

    • transitionEvents array[object] | null

      A list with the events related to a transition.

      Hide transitionEvents attributes Show transitionEvents attributes object
      • name string | null

        The trasition event name.

      • status string | null

        The trasition event status.
  • 400

    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
      • 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
      • 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
      • 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

    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
      • 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
      • 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
      • 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

    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
      • 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
      • 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
      • 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-transitions 
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/customers/{customerId}/subscriptions/{subscriptionId}/eligible-transitions \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200) 
[
  {
    "destinationSubscriptionId": "string",
    "destinationProviderSubscriptionId": "string",
    "offerName": "string",
    "offerId": "string",
    "providerOfferId": "string",
    "providerOfferIdWithAvailability": "string",
    "imageUrl": "string",
    "quantity": 42,
    "termDuration": {
      "name": "string"
    },
    "billingFrequency": {
      "name": "string"
    },
    "transitionType": "string",
    "transitionEvents": [
      {
        "name": "string",
        "status": "string"
      }
    ]
  }
]
Response examples (200) 
[
  {
    "destinationSubscriptionId": "string",
    "destinationProviderSubscriptionId": "string",
    "offerName": "string",
    "offerId": "string",
    "providerOfferId": "string",
    "providerOfferIdWithAvailability": "string",
    "imageUrl": "string",
    "quantity": 42,
    "termDuration": {
      "name": "string"
    },
    "billingFrequency": {
      "name": "string"
    },
    "transitionType": "string",
    "transitionEvents": [
      {
        "name": "string",
        "status": "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"
      ]
    }
  ]
}