Skip to content

Custom Properties

Custom Properties allows tenants to create custom fields to gather and store structured data together with organizations, users, services, or subscriptions. These custom fields can collect additional data at the point of creation or be hidden to store identifiers or extra information.

The custom properties can be exposed to users as ordinary text fields, dropdowns, or checkboxes. Name, identifier, and a default value can be specified for each property. Properties can also be marked as mandatory or hidden from the user.

The custom properties are available both through the UI and in API responses and can also be included in billing reports.

JSON Example

"customProperties": [
        {
            "type": "TextBox",
            "propertyId": "account_id",
            "name": "Account Id",
            "defaultValue": "",
            "visible": true,
            "mandatory": true,
            "allowedValues": [
                ""
            ],
            "appliesToOrganizations": false,
            "appliesToBrokers": true,
            "appliesToSeller": false
        },
        {
            "type": "CheckBox",
            "propertyId": "cloudIdentityExists",
            "name": "Cloud Identity Exists",
            "defaultValue": "",
            "visible": false,
            "mandatory": false,
            "allowedValues": [
                ""
            ],
            "appliesToOrganizations": false,
            "appliesToBrokers": true,
            "appliesToSeller": false
        }
    ]

Field Definitions

FieldDescription
typeThe type of property to be used for the custom propertyTextBoxDropDownCheckBox
id*The identifier of the custom property.Valid characters are ‘A-Z’, ‘a-z’, ‘0-9’, and ‘_’. Cannot start with a number. Valid examples: customer_value1, Customer2_Value3
name*The name of the property.
defaultValueThe default value of the property.
visibleIndicates whether the property should be visible when creating the subscription.
mandatoryDetermines whether the property is mandatoryMandatory can only be set only if visible=true.
dropDownValuesValues of the DropDownList control.Can only be set if type=DropDown.
appliesToSellerDetermines if the custom property would apply to seller.Field only applies to custom properties on a service level.
appliesToBrokersDetermines if the custom property would apply to resellers and be set when a reseller adds the service.Field only applies to custom properties on a service level.
appliesToOrganizationsDetermines if the custom property would apply to organizations and be set when the organization adds the service.Field only applies to custom properties on a service level.