Update Plan

Details

API Details
Name

Update Plan

Description
MethodPUT
URIvi/tenants/tenantId/plans/planID
CloudCenter Release
  • Introduced in CloudCenter 4.0.
  • Enhanced in CloudCenter 4.2 to include the numberOfProjects attribute.
  • The paymentProfileRequired attribute is deprecated in CloudCenter 4.8.1 and later releases.

NotesFor additional context on <PORT> usage in the following example, see Base URI Format.
ESB Headeraction: update.tenants.tenantId.plans.planId 

Example

curl -k -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -u cliqradmin:40E45DBE57E35ECB "https://<HOST>:<PORT>/v1/tenants/1/plans/10" 

Request Body

Change the showOnlyToAdminfield to false.

{
  "id": "33",
  "resource": "https://<HOST>:<PORT>/v1/tenants/1/plans/33",
  "name": "10000 Dollars",
  "description": "",
  "tenantId": "1",
  "type": "BUDGET_BUNDLE_PREPAID_PLAN",
  "paymentProfileRequired": false,
  "showOnlyToAdmin": false
}

Response

{
  "id": "33",
  "resource": "https://<HOST>:<PORT>/v1/tenants/1/plans/33",
  "perms": [],
  "name": "10000 Dollars",
  "description": "",
  "tenantId": "1",
  "type": "BUDGET_BUNDLE_PREPAID_PLAN",
  "monthlyLimit": 0,
  "nodeHourIncrement": 0,
  "includedBundleId": null,
  "price": 0,
  "onetimeFee": 0,
  "annualFee": 0,
  "storageRate": 0,
  "hourlyRate": 0,
  "overageRate": 0,
  "overageLimit": null,
  "paymentProfileRequired": false,
  "restrictedToAppStoreOnly": false,
  "billToVendor": false,
  "enableRollover": false,
  "disabled": false,
  "showOnlyToAdmin": false,
  "numberOfUsers": 0,
  "numberOfProjects": 3
}

Request Attributes

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

planId 
  • DescriptionUnique, system-generated identifier for the plan belonging to this tenant. The default is Null.
  • Type: String
type

Description: The type of the plan. See Financial Overview for additional context.

Type: Enumeration

EnumerationDescription
VM_HOUR_SUBSCRIPTION_PLANLimited number of VM hours per month. See Financial Overview for additional information.
VM_SUBSCRIPTION_PLANThis plan allows a specified (limited) number of concurrent VMs across all supported clouds. See Financial Overview for additional information.
UNLIMITED_PLANContinues (unlimited) deployment regardless of cost, or VM limits, or time. See Financial Overview for additional information.
TIME_BUNDLE_PREPAID_PLANLimited deployment stops after a batch application job completes or the web deployment is complete. See Financial Overview for additional information.
BUDGET_BUNDLE_PREPAID_PLANAllows cost governance to admin and provides users/tenants with flexibility to run on any cloud until the $ limit (limited) is reached. See Financial Overview for additional information.
enableRollover
  • Type: Boolean
disabled
  • Description: Indicates whether this resource is disabled.
    • True = resource is disabled
    • false = resource is not disabled
  • Type: Boolean

showOnlyToAdmin
  • Description: Indicates whether this resource is visible only to an administrator.
    • true = visibility of the resource is restricted to an administrator
    • false = visibility of the resource is not restricted to an administrator
  • Type: Boolean

Response Attributes

id
  • DescriptionUnique, system-generated identifier for this CloudCenter Resource.

  • Type: String
resource
  • Description: Unique URL to access this resource.
  • Type: String
perms (click for additional details)

name
  • DescriptionThe name assigned for this CloudCenter ResourceValid characters are letters, numbers, underscores, and spaces.

  • Type: String

Required

description
  • DescriptionA brief description for this CloudCenter Resource.

  • Type: String

tenantId
  • DescriptionUnique, system-generated identifier for the tenant organization. A tenant admin must belong to this tenant to invoke any APIs for this tenant. See Add Sub-Tenants > Tenant ID and Tenant Name Dependency.

  • Type: String

Required

type

Description: The type of the plan. See Financial Overview for additional context.

Type: Enumeration

EnumerationDescription
VM_HOUR_SUBSCRIPTION_PLANLimited number of VM hours per month. See Financial Overview for additional information.
VM_SUBSCRIPTION_PLANThis plan allows a specified (limited) number of concurrent VMs across all supported clouds. See Financial Overview for additional information.
UNLIMITED_PLANContinues (unlimited) deployment regardless of cost, or VM limits, or time. See Financial Overview for additional information.
TIME_BUNDLE_PREPAID_PLANLimited deployment stops after a batch application job completes or the web deployment is complete. See Financial Overview for additional information.
BUDGET_BUNDLE_PREPAID_PLANAllows cost governance to admin and provides users/tenants with flexibility to run on any cloud until the $ limit (limited) is reached. See Financial Overview for additional information.

Required

monthlyLimit
  • Description: The meaning  depends on the type of the plan:

    PlanmonthlyLimit Meaning

    VM Hour Subscription Plan

    The number of VM hours that can be used in a month before the overage kicks in.
    VM Subscription PlanThe maximum number of VMs that can be running simultaneously (at any given point of time in the month) before overage kicks in.

    Unlimited plan

    This attribute in not needed in the request for the following plan (the effective value defaults to 0 in the system and can be seen in the response when a plan of this type is created).
    Time Bundle Prepaid Plan
    Budget Bundle Prepaid Plan
  • Type: Integer

nodeHourIncrement
  • Description: The minimum number of minutes deducted from the user/tenant's plan whenever they run an application. Set this value by dividing the intended number of minutes by 60. For example, if your intended value is 20 minutes, then the value to be set is 20 / 60 = 0.33. This option is only applicable for the following plans:
    • VM_HOUR_SUBSCRIPTION_PLAN
    • TIME_BUNDLE_PREPAID_PLAN
  • Type: Float
includedBundleId
  • DescriptionUnique, system-generated identifier for a bundle that is included with this plan. Only applicable if the plan type is PREPAID:
    • TIME_BUNDLE_PREPAID_PLAN
    • BUDGET_BUNDLE_PREPAID_PLAN
  • Type: String
price
  • DescriptionThe base price for this bundle or plan. Required in the request only for the monthlyLimit plans:
    • UNLIMITED_PLAN
    • VM_HOUR_SUBSCRIPTION_PLAN
    • VM_SUBSCRIPTION_PLAN
    • For the remaining prepaid plan type (TIME_BUNDLE_PREPAID_PLAN and BUDGET_BUNDLE_PREPAID_PLAN), the value defaults to 0
  • Type: Float
onetimeFee
  • Description: The fee that is charged when a user/tenant is assigned this plan
  • Type: Float
overageRate
  • Description: The cost per VM if a user/tenant exceeds the subscription limit. Provide this amount in dollars per VM. The meaning differs based on the plan:

    plan typeoverageRate Meaning
    VM_HOUR_SUBSCRIPTION_PLANThe cost per extra VM hour consumed if the user/tenant exceeds the monthlyLimit:
    • Up to the overageLimit value 
    • Extra VM hours used 
    • Forever, if the overageLimit is unlimited
    VM_SUBSCRIPTION_PLAN

    The cost per extra VM running concurrently at any point, beyond the monthlyLimit:

    • Up to the limit of overageLimit number of concurrently running VMs
    • Forever, if the overageLimit is unlimited.
    UNLIMITED_PLAN

    Not applicable.

    BUDGET_BUNDLE_PREPAID_PLAN
    TIME_BUNDLE_PREPAID_PLAN
  • Type: Float
overageLimit
  • Description: The overage limit above the monthly limit for VMs allowed by this plan after all available credit has expired. See Financial Overview for additional details. Possible values are:
    • unlimited: Default. Continues deployment after overage fee kicks in for this tenant
    • limited: Stops deployment after reaching limit and has an associated cost based on the plan
  • Type: Float
paymentProfileRequired (deprecated)
  • Description: Specifies whether users/tenants must set up a payment profile before they are allowed to perform any operation.

    This attribute is deprecated in CloudCenter 4.8.1 and later releases.

  • Type: Boolean
    • true = payment profile is required
    • false = payment profile is not required
restrictedToAppStoreOnly
  • Description: Indicates whether users/tenants are restricted to performing tasks pertaining to the Application Marketplace.
    • true = restricted
    • false = not restricted (default)
  • Type: Boolean
billToVendor
  • Description: Indicates if the plan cloud cost is billed to the parent of the user/tenant. 
    If the plan's assignee is a user, the parent of the assignee is the user's tenant.
    If the plan's assignee is a tenant, the parent is the tenant's parent tenant.
    • true = Billed to the parent organization
    • false = Not billed to the parent organization
  • Type: Boolean
enableRollover
  • Type: Boolean
disabled
  • Description: Indicates whether this resource is disabled.
    • True = resource is disabled
    • false = resource is not disabled
  • Type: Boolean
showOnlyToAdmin
  • Description: Indicates whether this resource is visible only to an administrator.
    • true = visibility of the resource is restricted to an administrator
    • false = visibility of the resource is not restricted to an administrator
  • Type: Boolean
numberOfUsers
  • Description: Number of users that are currently using this resource
  • Type: Long
numberOfProjects
  • Description: Identifies the number of projects currently using this plan (see Manage Projects and Phases for additional context).
  • Type: Long