List eligible Subscriptions for upgrade

GET /v1/customers/{customerId}/subscriptions/{subscriptionId}/eligible-for-upgrade

Returns a list of eligible subscriptions for upgrade of 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.

Query parameters

  • offerId string(uuid) Required

    GUID Unique identifier for the offer.

  • resellerId string(uuid)

    GUID Unique identifier for the reseller. This identifier must match the origin subscription that is intended for upgrade.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • id string(uuid)

      The id of the subscription.

    • orderId string(uuid)

      The order id of the subscription.

    • offerId string(uuid)

      The offer id of the subscription.

    • customerId string(uuid)

      The customer id of the subscription.

    • providerInstanceId string(uuid)

      The provider instance id of the subscription.

    • resellerId string(uuid) | null

      The reseller id of the subscription.

    • subscriptionName string | null

      The friendly name of the subscription.

    • offerName string | null

      The name of the subscription.

    • offerType object

      The offer type. Possible values: License, LicenseLegacy, SoftwareSubscription, PerpetualSoftware, AzurePlan, AzureReservation, AzureLegacy or AzureSavingsPlan.

      Additional properties are NOT allowed.

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

        The name of the enumeration.

    • isAddonOffer boolean

      The value indicating if the subscription offer is addon.

    • isTrialOffer boolean

      The value indicating if the subscription offer is trial.

    • providerOfferId string | null

      The provider offer identifier.

    • subscriptionStatus object

      Additional properties are NOT allowed.

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

        The name of the enumeration.

    • startDate string(date-time)

      The start date of the subscription.

    • endDate string(date-time)

      The end date of the subscription.

    • cancellationAllowedUntil string(date-time) | null

      The limit date to cancelled the subscription.

    • quantity integer(int32)

      The quantity of the subscription.

    • assignedLicenses integer(int32) | null

      The quantity of the subscription.

    • listPrice object

      The list price of the subscription. This value represents the cost price for the whole term of the subscription.

      Additional properties are NOT allowed.

      Hide listPrice attributes Show listPrice 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

      The revenue price of the subscription. This value represents the revenue price for the whole term of the subscription.

      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

      The erp price of the subscription. This value represents the erp price for the whole term of the subscription.

      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.

    • customMargin object

      This value object contains the price margin for this entity.

      Additional properties are NOT allowed.

      Hide customMargin attributes Show customMargin attributes object
      • marginRule object Required

        The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount

        Additional properties are NOT allowed.

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

          The name of the enumeration.

      • value number(double) | null Required

        The value applied to this price margin. Should not be below 0 or above 999.

    • billingFrequency object

      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.

    • billingType object

      The billing type for the offer. Possible values: License, Usage or None

      Additional properties are NOT allowed.

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

        The name of the enumeration.

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

    • parentSubscriptionId string(uuid) | null

      The parent subscription identifier.

    • providerSubscriptionId string | null

      The provider's subscription identifier.

    • autoRenewal boolean

      Whether the subscription auto renews.

    • autoRenewSettings object

      Additional properties are NOT allowed.

      Hide autoRenewSettings attributes Show autoRenewSettings attributes object
      • term object Required

        The term duration for this entity. Possible values: NoTerm, OneMonth, OneYear, ThreeYears or FiveYears

        Additional properties are NOT allowed.

        Hide term attribute Show term 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.

      • quantity integer(int32) | null Required

        The quantity

      • customTermEndDate string(date-time) | null

        The custom term end date

    • providerData string | null

      The subscription provider data.

    • internalId string | null

      The internal identifier.
  • 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.

      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.

      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.

      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.

      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.

      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.

      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-for-upgrade 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/customers/{customerId}/subscriptions/{subscriptionId}/eligible-for-upgrade?offerId=string' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"