• Description: Identifies plan information to manage users
  • Type: Array of mapped attributes

    • Description: Information about the plan details for this user or tenant
    • Type: Array of mapped attributes

      • Description: Unique, system-generated identifier for a user
      • Type: String
      • DescriptionUnique, system-generated identifier for the plan belonging to this tenant. The default is Null.
      • Type: String
      • DescriptionUnique, system-generated identifier for a contract belonging to this tenant.
      • Type: String
      • Description: Options for monthly billing for deployments. See Tenant Billing for additional context.
      • Type: Enumeration

        CHANGE_PRORATEMonthly billing prorated for the current period.
        CHANGE_BACKDATEIf the plan started after the billing period start date, then this option allows users to be charged for the starting of the billing cycle. Subscription-based plans benefit from this option.
        CHANGE_NEXTBILLThe effective date of the plan charges users from the start date of the next billing cycle
      • Description: Indicates whether this contract should be renewed.
        • true = Contract should be renewed.
        • false = Default. Contract should not be renewed.
      • Type: Boolean


    Required if performing a user action and the action (userActionEnum) attribute value = MANAGE_PLANS


Terms & Conditions Privacy Statement Cookies Trademarks