ServiceDefinitionUpdateRequest

ServiceDefinitionUpdateRequest
ServiceDefinitionUpdateRequest
JSON Example
{
    "subscriptionLifecycleEventHandlers": {
        "onFulfillment": "string",
        "onExpiration": "string",
        "onCancellation": "string"
    },
    "serviceUrls": {
        "offerConfiguration": "string",
        "serviceHome": "string",
        "requestAccess": "string",
        "pricingInformation": "string",
        "marketing": "string"
    },
    "visible": false,
    "campaignId": "string",
    "displayName": "string",
    "descriptionLong": "string",
    "productIdentifier": "string",
    "serviceIcon": "string",
    "serviceNavBarIcon": "string",
    "serviceSvgIcon": "string",
    "subscriptionStatusChangeNotificationUrl": "string",
    "orderCreatedNotifyUrl": "string",
    "supportedBillingEngines": [
        {
            "name": "string",
            "isDefault": false
        }
    ],
    "sellers": [
        {
            "seller": "string",
            "enabled": false
        }
    ],
    "trialPeriod": 0,
    "serviceTicker": "string",
    "salesLedOnly": false,
    "endTrialConfiguration": {
        "postTrialConfiguration": {
            "roles": [
                "string"
            ],
            "duration": 0,
            "notifyPostTrialEnded": false
        },
        "serviceEndTrialBehaviour": {
            "endTrialBehaviourType": "string",
            "endTrialOnPaymentConfirmation": false,
            "subscriptionType": [
                "string"
            ]
        }
    },
    "shouldSendEmailUponGrantedAccess": false,
    "customEmail": {
        "customEmailSubject": "string",
        "customEmailBody": "string"
    },
    "hideServiceTile": false,
    "setupNeeded": false,
    "maxOrgServiceAccess": 0,
    "isCloudPackHelper": false,
    "isComposite": false,
    "isBeta": false,
    "isPrimary": false,
    "isCheckoutEnabled": false,
    "isSelfSubscriptionCreationEnabled": false,
    "isBinaryDownloadsAllowed": false,
    "isInstanceScopedRolesSupported": false
}
SubscriptionLifecycleEventHandlersDto
subscriptionLifecycleEventHandlers
Optional

Subscription lifecycle event handlers

ServiceUrlsDto
serviceUrls
Optional

Service Urls

boolean
visible
Optional

Determine whether the service is visible or not

string
campaignId
Optional

Marketing Campaign ID for the service

string
displayName
Optional

Service display name

string
descriptionLong
Optional

Longer description of the service

string
productIdentifier
Optional

The product identifier in the Billing Provider

string
serviceIcon
Optional

The service icon URL

string
serviceNavBarIcon
Optional

The service nav bar icon URL

string
serviceSvgIcon
Optional

The service SVG icon string. UI will prefer this icon over others

string
subscriptionStatusChangeNotificationUrl
Optional

Subscription status change notification URL

string
orderCreatedNotifyUrl
Optional

Order created notify url

array of BillingEngineDto
supportedBillingEngines
Optional

This field is no longer used and values are historical only

array of ServiceSeller
sellers
Optional

This field is no longer used and values are historical only

integer As int32 As int32
trialPeriod
Optional

Set default trial period in days.

string
serviceTicker
Optional

Service ticker

boolean
salesLedOnly
Optional

Set True if the service should be handled as using only sales-led flow when creating subscriptions

EndTrialConfiguration
endTrialConfiguration
Optional

End trial configuration properties

boolean
shouldSendEmailUponGrantedAccess
Optional

Determine whether a message email upon access to the service granted to an org

CustomEmailDto
customEmail
Optional

Determine whether and how a notification email should be sent to org owner when access is given to this service

boolean
hideServiceTile
Optional

Set True if the service tile should be hidden from the list of the org services in the MyService UI tab

boolean
setupNeeded
Optional

Set True to display 'set up service' on the CSP service tile for any new service from initial purchase. Default: false

integer As int32 As int32
maxOrgServiceAccess
Optional

Set max number of organizations that can have access to this service. Null if unlimited

boolean
isCloudPackHelper
Optional

Set True to mark the service as cloud pack helper. The service will be hidden from service tiles and dedicated only for cloud packs. Default: false

boolean
isComposite
Optional

Set True to mark the service as a composite service. A composite service is otherwise known as the lead of an offer bundle. Default: false

boolean
isBeta
Optional

Determine whether the service is beta or not

boolean
isPrimary
Optional

Determine whether the service is primary for its product

boolean
isCheckoutEnabled
Optional

Determine whether the service has integrated with checkout flow. Offer configuration URL must not be null to enable checkout flow

boolean
isSelfSubscriptionCreationEnabled
Optional

Determine whether the service supports self subscription creation.

boolean
isBinaryDownloadsAllowed
Optional

Determine whether the service has binary downloads available

boolean
isInstanceScopedRolesSupported
Optional

Determine whether the service supports instance scoped role assignments

Parameter To