CloudBlue Commerce API
Last updated 30-Sep-2025
Application¶
The APS resource of this APS type represents the application of the Product Lifecycle Management (PLM) component.
In this document:
Schema¶
The considered APS type (download)
extends the Application,
InitWizardVendorCatalogConfig,
InitWizardConfig APS type(s) and looks as follows:
{
"name": "Application",
"id": "http://com.odin.platform/inhouse-products/application/1.0",
"apsVersion": "2.0",
"implements": [
"http://aps-standard.org/types/core/application/1.0",
"http://aps-standard.org/types/core/external/metadata/1.0",
"http://odin.com/init-wizard-vendor-catalog/config/1.0",
"http://odin.com/init-wizard/config/1.0",
"http://ingrammicro.com/cb/types/astrum/client/1.0"
],
"access": {
"global": true
},
"properties": {
"config": {
"type": "array",
"title": "In-house application configuration",
"items": {
"type": "Property"
}
}
},
"operations": {
"getOperationsByOrderId": {
"path": "/fulfillment/operations",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"orderId": {
"kind": "query",
"type": "integer"
}
}
},
"createComposite": {
"path": "/createComposite",
"verb": "POST",
"errorResponse": {
"type": "object"
}
},
"parseConfig": {
"path": "/parseConfig",
"verb": "POST",
"response": {
"type": "ConfigurationInfo"
},
"errorResponse": {
"type": "object"
}
},
"applyConfig": {
"path": "/applyConfig",
"verb": "POST",
"errorResponse": {
"type": "object"
}
},
"downloadConfig": {
"path": "/downloadConfig",
"verb": "GET",
"response": {
"type": "ExcelConfigData"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"appId": {
"kind": "query",
"type": "string"
},
"bssServiceTemplateId": {
"kind": "query",
"type": "string"
}
}
},
"downloadBundleConfig": {
"path": "/downloadBundleConfig",
"verb": "GET",
"response": {
"type": "ExcelConfigData"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"productLineUid": {
"kind": "query",
"type": "string"
}
}
},
"getCamundaServices": {
"path": "camundaServices",
"verb": "GET",
"response": {
"type": "array",
"items": {
"type": "CamundaService"
}
},
"errorResponse": {
"type": "object"
},
"access": {
"referrer": false,
"public": false
}
},
"getProductLineByServiceTemplateId": {
"path": "productLine/{stId}",
"verb": "GET",
"response": {
"type": "ProductLine"
},
"errorResponse": {
"type": "object"
},
"access": {
"public": false
},
"parameters": {
"stId": {
"kind": "path",
"type": "string"
}
}
},
"getProductsByProductLine": {
"path": "productLineProducts/{plUuid}",
"verb": "GET",
"response": {
"type": "array",
"items": {
"type": "PdiProduct"
}
},
"errorResponse": {
"type": "object"
},
"access": {
"public": false
},
"parameters": {
"plUuid": {
"kind": "path",
"type": "string"
}
}
},
"getProductLineByServicePlanApsId": {
"path": "productLineByServicePlan/{servicePlanApsId}",
"verb": "GET",
"response": {
"type": "ProductLine"
},
"errorResponse": {
"type": "object"
},
"access": {
"public": false
},
"parameters": {
"servicePlanApsId": {
"kind": "path",
"type": "string"
}
}
},
"getProductLinesByServicePlanApsId": {
"path": "/productLinesByServicePlan/{servicePlanApsId}",
"verb": "GET",
"response": {
"type": "array",
"items": {
"type": "ProductLine"
}
},
"errorResponse": {
"type": "object"
},
"access": {
"public": false
},
"parameters": {
"servicePlanApsId": {
"kind": "path",
"type": "string"
}
}
},
"getProductLineByApsId": {
"path": "productLineByApsId/{productLineApsId}",
"verb": "GET",
"response": {
"type": "ProductLine"
},
"errorResponse": {
"type": "object"
},
"access": {
"public": false
},
"parameters": {
"productLineApsId": {
"kind": "path",
"type": "string"
}
}
},
"getProductLineByServiceTemplateApsId": {
"path": "/productLineByServiceTemplate/{serviceTemplateApsId}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"serviceTemplateApsId": {
"kind": "path",
"type": "string"
}
}
},
"getProductLinesByServiceTemplateApsId": {
"path": "/productLinesByServiceTemplate/{serviceTemplateApsId}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"serviceTemplateApsId": {
"kind": "path",
"type": "string"
}
}
},
"getOrCreateProductLineByAppId": {
"path": "/productLineByAppId",
"verb": "GET",
"response": {
"type": "ProductLine"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"subscriptionId": {
"kind": "query",
"type": "string"
},
"appId": {
"kind": "query",
"type": "string"
},
"connectProductName": {
"kind": "query",
"type": "string"
}
}
},
"getProcessInstances": {
"path": "processInstance/{apsEntityId}",
"verb": "GET",
"response": {
"type": "ProcessInstanceDTO"
},
"errorResponse": {
"type": "object"
},
"access": {
"public": false
},
"parameters": {
"apsEntityId": {
"kind": "path",
"type": "string"
}
}
},
"completeProcessInstance": {
"path": "processInstance/{apsEntityId}/complete",
"verb": "PUT",
"response": {
"type": "ProcessInstanceDTO"
},
"errorResponse": {
"type": "object"
},
"access": {
"public": false
},
"parameters": {
"apsEntityId": {
"kind": "path",
"type": "string"
}
}
},
"cancelProcessInstance": {
"path": "processInstance/{apsEntityId}/cancel",
"verb": "PUT",
"response": {
"type": "ProcessInstanceDTO"
},
"errorResponse": {
"type": "object"
},
"access": {
"public": false
},
"parameters": {
"apsEntityId": {
"kind": "path",
"type": "string"
}
}
},
"appsList": {
"path": "/appsList",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"name": {
"kind": "query",
"type": "string"
},
"limit": {
"kind": "query",
"type": "integer"
},
"offset": {
"kind": "query",
"type": "integer"
},
"fulfillmentSystem": {
"kind": "query",
"type": "string"
},
"model": {
"kind": "query",
"type": "string"
}
}
},
"getUpgradePaths": {
"path": "/upgradePaths",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"planId": {
"kind": "query",
"type": "integer"
}
}
},
"appDetails": {
"path": "/appDetails/{appId}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"appId": {
"kind": "path",
"type": "string"
},
"withItems": {
"kind": "query",
"type": "boolean"
},
"fulfillmentSystem": {
"kind": "query",
"type": "string"
}
}
},
"appItems": {
"path": "/appDetails/{appId}/items",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"appId": {
"kind": "path",
"type": "string"
},
"fulfillmentSystem": {
"kind": "query",
"type": "string"
}
}
},
"importItems": {
"path": "/appDetails/{appId}/import",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"appId": {
"kind": "path",
"type": "string"
}
}
},
"upgradeItems": {
"path": "/appDetails/{appId}/upgrade",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"appId": {
"kind": "path",
"type": "string"
}
}
},
"processUsageChunks": {
"path": "/processUsageChunks",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"getProductInfo": {
"path": "/productInfoByBssPlan/{planApsId}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"planApsId": {
"kind": "path",
"type": "string"
}
}
},
"getProductInfoByApsId": {
"path": "productInfoByApsId/{productLineApsId}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"productLineApsId": {
"kind": "path",
"type": "string"
}
}
},
"getTierConfigRequest": {
"path": "/tierConfig/{billingPlanApsId}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"billingPlanApsId": {
"kind": "path",
"type": "string"
}
}
},
"getTierRequest": {
"path": "getTierRequest/{productLineApsId}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"productLineApsId": {
"kind": "path",
"type": "string"
}
}
},
"getTierConfigs": {
"path": "getTierConfigs",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"getConnectProductActionLink": {
"path": "tier/action/{productLineApsId}/{actionId}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"productLineApsId": {
"kind": "path",
"type": "string"
},
"actionId": {
"kind": "path",
"type": "string"
}
}
},
"getBusinessMetrics": {
"path": "/business-metrics",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"createTierConfigRequest": {
"path": "/tierConfigRequest",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"bssPlanUuid": {
"kind": "query",
"type": "string"
}
}
},
"createTierRequest": {
"path": "tierRequest/{productLineApsId}",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"productLineApsId": {
"kind": "path",
"type": "string"
}
}
},
"validateTierConfigRequest": {
"path": "/validateTierConfigRequest",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"bssPlanUuid": {
"kind": "query",
"type": "string"
}
}
},
"submitTierConfigRequest": {
"path": "/submitTierConfigRequest",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"bssPlanUuid": {
"kind": "query",
"type": "string"
}
}
},
"validate": {
"path": "/validate",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"waitBssPlansSync": {
"path": "waitBssPlansSync",
"verb": "POST",
"errorResponse": {
"type": "object"
}
},
"delegate": {
"path": "delegate",
"verb": "POST",
"errorResponse": {
"type": "object"
},
"parameters": {
"memberId": {
"kind": "query",
"type": "integer"
}
}
},
"waitSync": {
"path": "waitSync",
"verb": "POST",
"errorResponse": {
"type": "object"
},
"parameters": {
"memberId": {
"kind": "query",
"type": "integer"
}
}
},
"selfManage": {
"path": "selfManage",
"verb": "POST",
"errorResponse": {
"type": "object"
},
"parameters": {
"memberId": {
"kind": "query",
"type": "integer"
}
}
},
"customize": {
"path": "customize",
"verb": "POST",
"errorResponse": {
"type": "object"
},
"parameters": {
"memberId": {
"kind": "query",
"type": "integer"
}
}
},
"getCBTimezone": {
"path": "/cbTimezone",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"getVersions": {
"path": "/versions",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"getFulfillmentSystems": {
"path": "/fulfillmentSystems",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"upgradeApplication": {
"path": "/upgradeApplication",
"verb": "POST",
"errorResponse": {
"type": "object"
},
"access": {
"owner": false,
"referrer": false
}
},
"attributes": {
"path": "attributes",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"attributeValues": {
"path": "attributevalues",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"request": {
"kind": "body",
"type": "AttributeValueRequest"
}
}
},
"getResourceCategories": {
"path": "getResourceCategories",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"getUnitsOfMeasure": {
"path": "getUnitsOfMeasure",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"getServiceTerms": {
"path": "/serviceTerms",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"getConnectOffers": {
"path": "/appDetails/{appId}/offers",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"appId": {
"kind": "path",
"type": "string"
}
}
},
"getOfferDetails": {
"path": "/appDetails/{appId}/offers/{offerId}",
"verb": "GET",
"errorResponse": {
"type": "object"
},
"parameters": {
"offerId": {
"kind": "path",
"type": "string"
},
"appId": {
"kind": "path",
"type": "string"
}
}
},
"getCapabilities": {
"path": "/serviceTemplates/{id}/capabilities",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"id": {
"kind": "path",
"type": "integer"
}
}
},
"getTermsAndConditions": {
"path": "/termsAndConditions",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"createPreset": {
"path": "/presets",
"verb": "POST",
"errorResponse": {
"type": "object"
}
},
"updatePreset": {
"path": "/presets/{id}",
"verb": "PUT",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"id": {
"kind": "path",
"type": "integer"
}
}
},
"syncProductLine": {
"path": "/presets/{id}/syncProductLine/{uid}",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"id": {
"kind": "path",
"type": "integer"
},
"uid": {
"kind": "path",
"type": "string"
}
}
},
"syncPreset": {
"path": "/presets/{id}/syncPreset",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"id": {
"kind": "path",
"type": "integer"
}
}
},
"clonePreset": {
"path": "/presets/{id}/clone",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"id": {
"kind": "path",
"type": "integer"
}
}
},
"getPresetById": {
"path": "/presets/{id}",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"id": {
"kind": "path",
"type": "integer"
}
}
},
"getAllPresets": {
"path": "presets",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"type": {
"kind": "query",
"type": "PresetType"
},
"limit": {
"kind": "query",
"type": "integer"
},
"offset": {
"kind": "query",
"type": "integer"
},
"sortBy": {
"kind": "query",
"type": "string"
},
"asc": {
"kind": "query",
"type": "boolean"
}
}
},
"getPresetCreateFormData": {
"path": "/presets/formData",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
}
},
"getAvailability": {
"path": "/appDetails/{appId}/availability",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"appId": {
"kind": "path",
"type": "string"
}
}
},
"getListings": {
"path": "/listings",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"productId": {
"kind": "query",
"type": "string"
},
"accountId": {
"kind": "query",
"type": "string"
}
}
},
"updateAvailability": {
"path": "/appDetails/{appId}/availability",
"verb": "POST",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"appId": {
"kind": "path",
"type": "string"
},
"request": {
"kind": "body",
"type": "AvailabilityRequestDTO",
"required": true
}
}
},
"listPlans": {
"path": "/plans",
"verb": "GET",
"response": {
"type": "array",
"items": {
"type": "PlanDTO"
}
},
"errorResponse": {
"type": "object"
},
"parameters": {
"limit": {
"kind": "query",
"type": "integer"
},
"offset": {
"kind": "query",
"type": "integer"
},
"sortBy": {
"kind": "query",
"type": "string"
},
"asc": {
"kind": "query",
"type": "boolean"
},
"serviceTemplateId": {
"kind": "query",
"type": "integer"
},
"serviceTemplateName": {
"kind": "query",
"type": "string"
},
"servicePlanId": {
"kind": "query",
"type": "integer"
},
"servicePlanName": {
"kind": "query",
"type": "string"
},
"billingPeriodType": {
"kind": "query",
"type": "string"
},
"billingPeriod": {
"kind": "query",
"type": "integer"
},
"published": {
"kind": "query",
"type": "boolean"
},
"includeDelegated": {
"kind": "query",
"type": "boolean"
}
}
},
"listPlansDetailed": {
"path": "/plans-detailed",
"verb": "GET",
"response": {
"type": "array",
"items": {
"type": "PlanDetailedDTO"
}
},
"errorResponse": {
"type": "object"
},
"parameters": {
"limit": {
"kind": "query",
"type": "integer"
},
"offset": {
"kind": "query",
"type": "integer"
},
"sortBy": {
"kind": "query",
"type": "string"
},
"asc": {
"kind": "query",
"type": "boolean"
}
}
},
"getPlan": {
"path": "/plans/{planId}",
"verb": "GET",
"response": {
"type": "PlanDetailedDTO"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"planId": {
"kind": "path",
"type": "integer"
}
}
},
"updatePlan": {
"path": "/plans/{planId}",
"verb": "PUT",
"response": {
"type": "PlanDTO"
},
"errorResponse": {
"type": "object"
},
"access": {},
"parameters": {
"planId": {
"kind": "path",
"type": "integer"
}
}
},
"delegation": {
"path": "plans/delegation",
"verb": "POST",
"errorResponse": {
"type": "object"
},
"access": {
"privilege": "http://com.odin.platform/inhouse-products#plans-management"
}
},
"publication": {
"path": "plans/publication",
"verb": "POST",
"errorResponse": {
"type": "object"
},
"access": {
"privilege": "http://com.odin.platform/inhouse-products#plans-management"
}
},
"getResellerGroups": {
"path": "resellerGroups",
"verb": "GET",
"response": {
"type": "array",
"items": {
"type": "ResellerGroup"
}
},
"errorResponse": {
"type": "object"
}
},
"getSubsResellerGroup": {
"path": "subsResellerGroup",
"verb": "GET",
"response": {
"type": "ResellerGroup"
},
"errorResponse": {
"type": "object"
}
},
"getTenantsByServiceTemplate": {
"path": "tenants",
"verb": "GET",
"response": {
"type": "object"
},
"errorResponse": {
"type": "object"
},
"parameters": {
"serviceTemplateId": {
"kind": "query",
"type": "array"
}
}
}
},
"structures": {
"Property": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"PlanIdentity": {
"type": "object"
},
"TargetAccount": {
"type": "object",
"properties": {
"accountId": {
"type": "integer"
},
"memberId": {
"type": "integer"
},
"companyName": {
"type": "string"
}
}
},
"ExcelConfig": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"items": {
"type": "ExcelResource"
}
},
"serviceTemplates": {
"type": "array",
"items": {
"type": "ExcelServiceTemplate"
}
},
"servicePlans": {
"type": "array",
"items": {
"type": "ExcelServicePlan"
}
},
"termsConditionsDetails": {
"type": "TermsConditions"
},
"subscriptionNotificationTemplates": {
"type": "array",
"items": {
"type": "ExcelSubscriptionNotificationTemplate"
}
},
"resourceDependencies": {
"type": "array",
"items": {
"type": "ExcelResourceDependency"
}
},
"opUnitResourceCategories": {
"type": "array",
"items": {
"type": "ExcelOpUnitResourceCategory"
}
},
"tcs": {
"type": "object"
}
}
},
"ExcelSubscriptionNotificationTemplate": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"locale": {
"type": "string"
},
"messageCategory": {
"type": "MessageCategory"
},
"htmlText": {
"type": "string"
},
"plainText": {
"type": "string"
},
"subject": {
"type": "string"
},
"toAddress": {
"type": "string"
},
"toName": {
"type": "string"
},
"bccAddress": {
"type": "string"
},
"fromAddress": {
"type": "string"
},
"fromName": {
"type": "string"
},
"pdfAttachmentName": {
"type": "string"
},
"active": {
"type": "boolean"
},
"condition": {
"type": "string"
},
"visibleToResellers": {
"type": "boolean"
},
"secureBody": {
"type": "boolean"
}
}
},
"MessageCategory": {
"type": "object"
},
"AppInfo": {
"type": "object",
"properties": {
"appCustomIconUrl": {
"type": "string"
},
"impersonationUid": {
"type": "string"
},
"productLineInfo": {
"type": "ProductLineInfo"
}
}
},
"ProductLineInfo": {
"type": "object",
"properties": {
"productLineUUID": {
"type": "string"
},
"name": {
"type": "string"
},
"productLineType": {
"type": "ProductLineType"
},
"parameters": {
"type": "array",
"items": {
"type": "FulfillmentParameter"
}
},
"baseProductLine": {
"type": "ProductLineInfo"
},
"ownProductLines": {
"type": "array",
"items": {
"type": "ProductLineInfo"
}
},
"isConnect": {
"type": "boolean"
}
}
},
"ProductLineType": {
"type": "object"
},
"FulfillmentParameter": {
"type": "object",
"properties": {
"id": {
"type": "string",
"required": true
},
"label": {
"type": "string"
},
"labelLoc": {
"type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
"title": "Parameter Label"
},
"defaultValue": {
"type": "string",
"default": ""
},
"description": {
"type": "string",
"default": ""
},
"descriptionLoc": {
"type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
"title": "Parameter Description"
},
"phase": {
"type": "string",
"required": true,
"default": "activation",
"title": "Phase",
"enum": [
"activation",
"fulfillment",
"reseller"
],
"enumTitles": [
"Activation",
"Fulfillment",
"Reseller"
]
},
"type": {
"type": "string",
"required": true,
"default": "text",
"title": "Type",
"enum": [
"text",
"dropdown",
"password",
"email",
"checkbox",
"subdomain",
"domain",
"address",
"phone",
"url",
"choice",
"object"
],
"enumTitles": [
"Text",
"Dropdown",
"Password",
"Email",
"Checkbox",
"Subdomain",
"Domain",
"Address",
"Phone",
"URL",
"Choice",
"Object"
]
},
"choices": {
"type": "array",
"items": {
"type": "ParameterChoice"
}
},
"minLength": {
"type": "integer"
},
"maxLength": {
"type": "integer"
},
"isRequired": {
"type": "boolean"
},
"showToCustomer": {
"type": "boolean"
},
"placeholder": {
"type": "string",
"default": ""
},
"hint": {
"type": "string",
"default": ""
},
"placeholderLoc": {
"type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
"title": "Parameter Placeholder"
},
"hintLoc": {
"type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
"title": "Parameter Hint"
}
}
},
"MLString": {
"type": "object",
"properties": {
"ar_AE": {
"type": "string",
"description": "Arabic, Standard - United Arab Emirates"
},
"bg_BG": {
"type": "string",
"description": "Bulgarian - Bulgaria"
},
"cs_CZ": {
"type": "string",
"description": "Czech - Czech Republic"
},
"da_DK": {
"type": "string",
"description": "Danish - Denmark"
},
"de_DE": {
"type": "string",
"description": "German - Germany"
},
"el_GR": {
"type": "string",
"description": "Greek - Greece"
},
"en_US": {
"type": "string",
"description": "English - United States"
},
"es_ES": {
"type": "string",
"description": "Spanish - Spain"
},
"fr_FR": {
"type": "string",
"description": "French - France"
},
"he_IL": {
"type": "string",
"description": "Hebrew - Israel"
},
"iw_IL": {
"type": "string",
"description": "Iwrit - Israel"
},
"hr_HR": {
"type": "string",
"description": "Croatian - Croatia"
},
"hu_HU": {
"type": "string",
"description": "Hungarian - Hungary"
},
"id_ID": {
"type": "string",
"description": "Indonesian - Indonesia"
},
"it_IT": {
"type": "string",
"description": "Italian - Italy"
},
"ja_JP": {
"type": "string",
"description": "Japanese - Japan"
},
"ko_KR": {
"type": "string",
"description": "Korean - Korea"
},
"kz_KZ": {
"type": "string",
"description": "Kazakh - Kazakhstan"
},
"mk_MK": {
"type": "string",
"description": "Macedonian - Macedonia"
},
"nl_NL": {
"type": "string",
"description": "Dutch - The Netherlands"
},
"no_NO": {
"type": "string",
"description": "Norwegian - Norway"
},
"pl_PL": {
"type": "string",
"description": "Polish - Poland"
},
"pt_BR": {
"type": "string",
"description": "Portuguese - Brazil"
},
"pt_PT": {
"type": "string",
"description": "Portuguese - Portugal"
},
"ro_RO": {
"type": "string",
"description": "Romanian - Romania"
},
"ru_RU": {
"type": "string",
"description": "Russian - Russia"
},
"sv_SE": {
"type": "string",
"description": "Swedish - Sweden"
},
"th_TH": {
"type": "string",
"description": "Thai - Thailand"
},
"tr_TR": {
"type": "string",
"description": "Turkish - Turkey"
},
"zh_CN": {
"type": "string",
"description": "Chinese, Simplified - China"
},
"sl_SI": {
"type": "string",
"description": "Slovenian - Slovenia"
},
"sr_RS": {
"type": "string",
"description": "Serbian - Serbia"
},
"xx_XA": {
"type": "string",
"description": "Reserved 1"
},
"xx_XB": {
"type": "string",
"description": "Reserved 2"
},
"xx_XC": {
"type": "string",
"description": "Reserved 3"
},
"xx_XD": {
"type": "string",
"description": "Reserved 4"
},
"xx_XE": {
"type": "string",
"description": "Reserved 5"
},
"xx_XF": {
"type": "string",
"description": "Reserved 6"
},
"xx_XG": {
"type": "string",
"description": "Reserved 7"
},
"xx_XH": {
"type": "string",
"description": "Reserved 8"
},
"xx_XI": {
"type": "string",
"description": "Reserved 9"
},
"xx_XJ": {
"type": "string",
"description": "Reserved 10"
}
}
},
"ParameterChoice": {
"type": "object",
"properties": {
"isDefault": {
"type": "boolean"
},
"label": {
"type": "string"
},
"labelLoc": {
"type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
"title": "Choice label"
},
"value": {
"type": "string"
}
}
},
"ConfigOrigination": {
"type": "object",
"properties": {
"configAPI": {
"type": "ConfigAPI"
}
}
},
"ConfigAPI": {
"type": "object",
"properties": {
"PPR_UPLOAD": {
"type": "ConfigAPI"
}
}
},
"ConfigurationInfo": {
"type": "object",
"properties": {
"planIdentity": {
"type": "PlanIdentity",
"default": "name"
},
"owner": {
"type": "TargetAccount"
},
"serviceTemplateId": {
"type": "integer"
},
"serviceTerms": {
"type": "object"
},
"termsAndConditions": {
"type": "object"
},
"existingPdiPlans": {
"type": "object"
},
"excelConfig": {
"type": "ExcelConfig"
},
"appInfo": {
"type": "AppInfo"
},
"configOrigination": {
"type": "ConfigOrigination"
},
"isDelegatedPL": {
"type": "boolean",
"default": "false"
}
}
},
"ExcelConfigData": {
"type": "object",
"properties": {
"data": {
"type": "string",
"title": "data"
}
}
},
"CamundaService": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"url": {
"type": "string",
"title": "Name"
},
"login": {
"type": "string"
}
}
},
"ProcessInstanceDTO": {
"type": "object",
"properties": {
"apsId": {
"type": "string"
},
"processInstanceId": {
"type": "string"
},
"businessKey": {
"type": "string"
},
"accountUid": {
"type": "string"
},
"productName": {
"type": "string"
},
"accountName": {
"type": "string"
}
}
},
"AttributeValuesDTO": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"appId": {
"type": "string"
},
"mpn": {
"type": "string"
},
"itemId": {
"type": "string"
},
"value": {
"type": "string"
}
}
},
"AttributeValueRequest": {
"type": "object",
"properties": {
"attributeValues": {
"type": "array",
"items": {
"type": "AttributeValuesDTO"
}
}
}
},
"PresetType": {
"type": "object"
},
"AvailabilityRequestDTO": {
"type": "object"
},
"BillingModel": {
"type": "object"
},
"PricePeriodType": {
"type": "object"
},
"SubscriptionPeriod": {
"type": "object",
"properties": {
"bssId": {
"type": "integer",
"default": "",
"title": "BSS Subscription Period Id"
},
"active": {
"type": "boolean",
"default": "true",
"title": "Is Active"
},
"period": {
"type": "integer",
"default": "1",
"title": "Subscription Period Duration"
},
"periodType": {
"type": "string",
"default": "month",
"title": "Subscription Period Type",
"enum": [
"month",
"year"
]
},
"cancellationFeeType": {
"type": "string",
"default": "none",
"title": "Subscription Cancellation Fee Type",
"enum": [
"none",
"until_expiration",
"custom"
]
},
"cancellationFeeValue": {
"type": "sting",
"default": "",
"title": "Cancellation Fee Formula"
},
"isTrial": {
"type": "boolean",
"default": "false",
"title": "Is Trial"
},
"afterRefundPeriod": {
"type": "string",
"default": "no_refund",
"title": "After Refund Period",
"enum": [
"no_refund",
"refund_prorated_recurring_fee"
]
},
"fullRefundPeriod": {
"type": "integer",
"default": "0",
"title": "Full Refund Period"
},
"cancelationPolicies": {
"type": "array",
"title": "Cancelation Policies",
"items": {
"type": "PlanPeriodPolicy"
}
},
"downsizePolicies": {
"type": "array",
"title": "Downsize Policies",
"items": {
"type": "PlanPeriodPolicy"
}
},
"upsizePolicies": {
"type": "array",
"title": "Upsize Policies",
"items": {
"type": "PlanPeriodPolicy"
}
},
"revertOrderPolicies": {
"type": "array",
"title": "Revert Order Policies",
"items": {
"type": "PlanPeriodPolicy"
}
}
}
},
"SubscriptionPeriodType": {
"type": "object"
},
"SubscriptionCancellationFeeType": {
"type": "object"
},
"SubscriptionAfterRefundPeriod": {
"type": "object"
},
"PlanPeriodPolicy": {
"type": "object",
"properties": {
"action": {
"type": "string",
"title": "Action",
"enum": [
"full_refund",
"prorated_refund",
"no_refund",
"prohibited",
"penalty",
"not_allowed_except_for_after_upsize",
"prorated_charge"
]
},
"actionPeriod": {
"type": "integer",
"title": "Action Period"
},
"actionPeriodTimezone": {
"type": "string",
"title": "Action Period Timezone",
"enum": [
"customer",
"from_plan"
]
},
"applicableTo": {
"type": "string",
"title": "Applicable To",
"enum": [
"first_subscription_period",
"next_subscription_periods",
"all_subscription_periods"
]
}
}
},
"Action": {
"type": "object"
},
"ActionPeriodTimezone": {
"type": "object"
},
"ApplicableTo": {
"type": "object"
},
"AutoRenewType": {
"type": "object"
},
"SalesCategory": {
"type": "object",
"properties": {
"expand": {
"type": "boolean"
},
"inCCP": {
"type": "boolean"
}
}
},
"ServiceTerms": {
"type": "object",
"properties": {
"bssId": {
"type": "integer"
},
"serviceTermsName": {
"type": "string"
},
"destroyAfterHold": {
"type": "boolean",
"required": true,
"default": "false"
},
"holdPeriodInDays": {
"type": "integer",
"required": true,
"default": "0"
},
"gracePeriodInDays": {
"type": "integer",
"required": true,
"default": "0"
},
"trialDestroyAfterHold": {
"type": "boolean",
"required": true,
"default": "false"
},
"trialHoldPeriodInDays": {
"type": "integer",
"required": true,
"default": "0"
},
"trialGracePeriodInDays": {
"type": "integer",
"required": true,
"default": "0"
}
}
},
"TermsAndConditions": {
"type": "object",
"properties": {
"id": {
"type": "string",
"required": true
},
"bssId": {
"type": "integer",
"required": true
},
"name": {
"type": "string",
"title": "Name of term"
},
"value": {
"type": "string",
"title": "Value of term"
},
"isDeleted": {
"type": "boolean",
"default": "false",
"title": "Flag for Terms that needed to be removed"
},
"type": {
"type": "string",
"title": "Term Type",
"enum": [
"plain_text",
"link"
]
},
"ownerAccountId": {
"type": "integer",
"title": "Owner account id"
},
"acceptType": {
"type": "string",
"title": "Acceptance",
"enum": [
"Always, on every purchase",
"On first purchase and after every T\u0026C change",
"Only on a first purchase",
"On every purchase and after every T\u0026C change"
]
}
}
},
"NotificationTemplateMapping": {
"type": "object",
"properties": {
"templateType": {
"type": "string",
"title": "Notification Template Type",
"enum": [
"welcome_email",
"expiration_email"
]
},
"templateName": {
"type": "string",
"title": "Notification Template Name"
}
}
},
"TemplateType": {
"type": "object"
},
"RatingMode": {
"type": "object"
},
"BillingPeriodAlignment": {
"type": "object"
},
"CoTermingPossibilities": {
"type": "object"
},
"Preset": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"title": "Preset id"
},
"onVersion": {
"type": "integer",
"title": "Preset version"
}
}
},
"PlanDetailedDTO": {
"type": "object",
"properties": {
"description": {
"type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
"title": "Product Description"
},
"billingModel": {
"type": "string",
"default": "Charge Before Billing Period",
"title": "Billing Model",
"enum": [
"Charge Before Billing Period",
"Charge After Billing Period",
"Charge Before Subscription Period",
"Use External Rating",
"One Time"
]
},
"pricePeriodType": {
"type": "string",
"default": "billing period",
"title": "Price Period Type",
"enum": [
"Billing Period",
"Month"
]
},
"alignWithStatementDay": {
"type": "boolean",
"default": "false",
"title": "Align Billing Order with Statement Day"
},
"isSalesOrderProrated": {
"type": "boolean",
"default": "false",
"title": "Is Billing Sales Order prorated"
},
"isFirstPeriodForFree": {
"type": "boolean",
"default": "false",
"title": "First Billing Period For Free"
},
"isOneTimeFeePlan": {
"type": "boolean",
"default": "true",
"title": "Is product the One-Time fee plan?"
},
"subscriptionPeriods": {
"type": "array",
"title": "Subscription Periods",
"items": {
"type": "SubscriptionPeriod"
}
},
"vendorTimezone": {
"type": "string",
"title": "Vendor Timezone"
},
"autoRenewType": {
"type": "string",
"default": "Before Expiration",
"title": "Auto Renew Type",
"enum": [
"Disabled",
"On Last Statement Day",
"Before Expiration"
]
},
"renewOrderInterval": {
"type": "integer",
"title": "Renew Order Interval"
},
"autoRenewPlanPeriodId": {
"type": "integer",
"title": "Auto renew period id"
},
"autoRenewPlanId": {
"type": "integer",
"title": "Auto renew plan id"
},
"planCategory": {
"type": "string",
"title": "Plan Category"
},
"salesCategories": {
"type": "array",
"title": "Sales Categories",
"items": {
"type": "SalesCategory"
}
},
"serviceTerms": {
"type": "ServiceTerms",
"title": "Subscription Service Terms"
},
"termsAndConditions": {
"type": "array",
"title": "Terms",
"items": {
"type": "TermsAndConditions"
}
},
"availableNotifications": {
"type": "array",
"title": "Notifications available for product",
"items": {
"type": "NotificationTemplateMapping"
}
},
"enabledNotifications": {
"type": "array",
"title": "Notifications enabled for product",
"items": {
"type": "NotificationTemplateMapping"
}
},
"customStatementDay": {
"type": "integer",
"default": "0",
"title": "New Day of Statement"
},
"isAllowedScheduledChanges": {
"type": "boolean",
"default": "false",
"title": "Is Allowed Scheduled Changes?"
},
"ratingMode": {
"type": "string",
"title": "Rating Integration Mode",
"enum": [
"Costs only",
"Revenue only",
"Revenue and Costs"
]
},
"billingPeriodAlignment": {
"type": "string",
"default": "Subscription Period Start",
"title": "Billing Period Alignment",
"enum": [
"Subscription Period Start",
"Subscription Period Expiration"
]
},
"expDateAlignedWithEndOfMonth": {
"type": "boolean",
"default": "false",
"title": "Is Expiration Date Aligned With End of Month?"
},
"expDateAlignedWithSubscr": {
"type": "boolean",
"default": "false",
"title": "Is Expiration Date Aligned With Subscription?"
},
"coTermingPossibilities": {
"type": "string",
"default": "Restricted",
"title": "Coterming Possibilities",
"enum": [
"Restricted",
"Allowed",
"Fixed Date Provided by Vendor"
]
},
"coTermOnCustomDate": {
"type": "boolean",
"default": "false",
"title": "Is Custom Date to Co Term with?"
},
"preset": {
"type": "Preset",
"title": "Preset id and version"
},
"connectOfferId": {
"type": "string"
},
"connectOfferPlanId": {
"type": "string"
},
"connectOfferVersion": {
"type": "integer"
}
}
},
"Period": {
"type": "object"
},
"PlanDTO": {
"type": "object",
"properties": {
"planId": {
"type": "integer",
"title": "BSS Service Plan Identity"
},
"uid": {
"type": "string",
"title": "Unique plan identifier"
},
"ownerAccountId": {
"type": "integer",
"description": "Identifier of the account of the plan owner",
"readonly": true
},
"billingPeriodType": {
"type": "string",
"default": "month",
"title": "Billing Period Type",
"enum": [
"month",
"year",
"psd"
]
},
"billingPeriod": {
"type": "integer",
"default": "1",
"title": "Billing Period duration"
},
"name": {
"type": "http://aps-standard.org/types/core/i18n/1.3#MLString",
"title": "Service Plan Name"
},
"parentPlanId": {
"type": "integer",
"title": "BSS Service Plan Identity"
},
"serviceTemplateId": {
"type": "integer",
"title": "BSS Service Plan Identity"
},
"serviceTemplateName": {
"type": "integer",
"title": "BSS Service Plan Identity"
},
"iconUrl": {
"type": "string",
"title": "Service plan custom icon url"
},
"published": {
"type": "boolean",
"default": "false",
"title": "Is the plan published for customers?"
},
"delegated": {
"type": "boolean",
"default": "false",
"title": "Is the plan delegated?"
},
"updateDate": {
"type": "string",
"format": "date-time",
"title": "Service Plan modification date"
}
}
},
"ResellerGroup": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "MLString"
}
}
}
}
}
The APS type is used to manage a collection of APS resources. To get a list of resources from that collection, use the following API call:
GET /aps/2/collections/applications?<RQL-filter>
Properties¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
config |
Array of Property |
Not Required |
Custom Operations¶
OPERATION |
VERB |
PATH |
RETURNS |
Description |
|---|---|---|---|---|
GET |
/fulfillment/operations |
|||
POST |
/createComposite |
|||
POST |
/parseConfig |
If successful, this method returns a ConfigurationInfo JSON object. That object must then be used in the applyConfig method to transform the current plan configuration of the product line into the target plan configuration. |
Parse a Base64-encoded Excel file that contains a target plan configuration of a product line. The format of that Excel file is provided at https://docs.cloudblue.com/cbc/21.0/Product-Lifecycle-Management/File-Requirements.htm. |
|
POST |
/applyConfig |
JAX-RS response |
Apply a target plan configuration specified in a ConfigurationInfo JSON object. A ConfigurationInfo JSON object can obtained with the parseConfig method or prepared manually. |
|
GET |
/downloadConfig |
Reserved for future use |
||
GET |
/downloadBundleConfig |
|||
GET |
/camundaServices |
Reserved for future use |
||
GET |
/productLine/{stId} |
|||
GET |
/productLineProducts/{plUuid} |
|||
GET |
/productLineByServicePlan/{servicePlanApsId} |
|||
GET |
/productLinesByServicePlan/{servicePlanApsId} |
List of ProductLine |
Get all ProductLine resources linked to specified Service Plan |
|
GET |
/productLineByApsId/{productLineApsId} |
Get ProductLine by aps id |
||
GET |
/productLineByServiceTemplate/{serviceTemplateApsId} |
|||
GET |
/productLinesByServiceTemplate/{serviceTemplateApsId} |
{@link List<ProductLine>} |
Get list of ProductLines by serviceTemplate aps id |
|
GET |
/productLineByAppId |
|||
GET |
/processInstance/{apsEntityId} |
Reserved for future use |
||
PUT |
/processInstance/{apsEntityId}/complete |
Reserved for future use |
||
PUT |
/processInstance/{apsEntityId}/cancel |
|||
GET |
/appsList |
Reserved for future use |
||
GET |
/upgradePaths |
|||
GET |
/appDetails/{appId} |
Reserved for future use |
||
GET |
/appDetails/{appId}/items |
Reserved for future use |
||
POST |
/appDetails/{appId}/import |
Reserved for future use |
||
POST |
/appDetails/{appId}/upgrade |
Reserved for future use |
||
POST |
/processUsageChunks |
Reserved for future use |
||
GET |
/productInfoByBssPlan/{planApsId} |
|||
GET |
/productInfoByApsId/{productLineApsId} |
Instance of ProductInfoDTO |
Get product info of Connect product by product line. |
|
GET |
/tierConfig/{billingPlanApsId} |
TierConfigResponseDTO. |
||
GET |
/getTierRequest/{productLineApsId} |
TierConfigResponseDTO. |
Get tier config of Connect product by product line. |
|
GET |
/getTierConfigs |
Instance of List<TierConfigurationDTO> |
Get list of tier configs |
|
GET |
/tier/action/{productLineApsId}/{actionId} |
Instance of ProductActionLink |
Get action link for Connect product by product line and action id |
|
GET |
/business-metrics |
Reserved for future use |
||
POST |
/tierConfigRequest |
Reserved for future use |
||
POST |
/tierRequest/{productLineApsId} |
TierConfigurationRequest. |
Create tier request |
|
POST |
/validateTierConfigRequest |
Reserved for future use |
||
POST |
/submitTierConfigRequest |
Reserved for future use |
||
POST |
/validate |
Reserved for future use |
||
POST |
/waitBssPlansSync |
Reserved for future use |
||
POST |
/delegate |
Reserved for future use |
||
POST |
/waitSync |
Reserved for future use |
||
POST |
/selfManage |
Reserved for future use |
||
POST |
/customize |
Reserved for future use |
||
GET |
/cbTimezone |
Reserved for future use |
||
GET |
/versions |
Return component versions |
||
GET |
/fulfillmentSystems |
Reserved for future use |
||
POST |
/upgradeApplication |
Reserved for future use |
||
GET |
/attributes |
|||
POST |
/attributevalues |
|||
GET |
/getResourceCategories |
|||
GET |
/getUnitsOfMeasure |
UOMs. |
List of UOMs available to a user. |
|
GET |
/serviceTerms |
|||
GET |
/appDetails/{appId}/offers |
|||
GET |
/appDetails/{appId}/offers/{offerId} |
|||
GET |
/serviceTemplates/{id}/capabilities |
|||
GET |
/termsAndConditions |
|||
POST |
/presets |
|||
PUT |
/presets/{id} |
|||
POST |
/presets/{id}/syncProductLine/{uid} |
|||
POST |
/presets/{id}/syncPreset |
|||
POST |
/presets/{id}/clone |
|||
GET |
/presets/{id} |
|||
GET |
/presets |
|||
GET |
/presets/formData |
|||
GET |
/appDetails/{appId}/availability |
|||
GET |
/listings |
|||
POST |
/appDetails/{appId}/availability |
|||
GET |
/plans |
|||
GET |
/plans-detailed |
|||
GET |
/plans/{planId} |
|||
PUT |
/plans/{planId} |
|||
POST |
/plans/delegation |
|||
POST |
/plans/publication |
|||
GET |
/resellerGroups |
|||
GET |
/subsResellerGroup |
|||
GET |
/tenants |
getOperationsByOrderId¶
HTTP Request
GET /aps/2/resources/{aps-id}/fulfillment/operations
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
orderId |
Integer |
Returns
parseConfig¶
HTTP Request
POST /aps/2/resources/{aps-id}/parseConfig
Description
Parse a Base64-encoded Excel file that contains a target plan configuration of a product line. The format of that Excel file is provided at https://docs.cloudblue.com/cbc/21.0/Product-Lifecycle-Management/File-Requirements.htm.
Returns
If successful, this method returns a ConfigurationInfo JSON object. That object must then be used in the applyConfig method to transform the current plan configuration of the product line into the target plan configuration.
applyConfig¶
HTTP Request
POST /aps/2/resources/{aps-id}/applyConfig
Description
Apply a target plan configuration specified in a ConfigurationInfo JSON object. A ConfigurationInfo JSON object can obtained with the parseConfig method or prepared manually.
Returns
JAX-RS response
downloadConfig¶
HTTP Request
GET /aps/2/resources/{aps-id}/downloadConfig
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
appId |
String |
|
bssServiceTemplateId |
String |
Returns
downloadBundleConfig¶
HTTP Request
GET /aps/2/resources/{aps-id}/downloadBundleConfig
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
productLineUid |
String |
Returns
getCamundaServices¶
HTTP Request
GET /aps/2/resources/{aps-id}/camundaServices
Description
Reserved for future use
Returns
getProductLineByServiceTemplateId¶
HTTP Request
GET /aps/2/resources/{aps-id}/productLine/{stId}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
stId |
String |
Returns
getProductsByProductLine¶
HTTP Request
GET /aps/2/resources/{aps-id}/productLineProducts/{plUuid}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
plUuid |
String |
Returns
getProductLineByServicePlanApsId¶
HTTP Request
GET /aps/2/resources/{aps-id}/productLineByServicePlan/{servicePlanApsId}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
servicePlanApsId |
String |
Returns
getProductLinesByServicePlanApsId¶
HTTP Request
GET /aps/2/resources/{aps-id}/productLinesByServicePlan/{servicePlanApsId}
Description
Get all ProductLine resources linked to specified Service Plan
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
servicePlanApsId |
String |
Service Plan UID |
Returns
List of ProductLine
getProductLineByApsId¶
HTTP Request
GET /aps/2/resources/{aps-id}/productLineByApsId/{productLineApsId}
Description
Get ProductLine by aps id
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
productLineApsId |
String |
Aps id of productLine |
Returns
getProductLineByServiceTemplateApsId¶
HTTP Request
GET /aps/2/resources/{aps-id}/productLineByServiceTemplate/{serviceTemplateApsId}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
serviceTemplateApsId |
String |
Returns
getProductLinesByServiceTemplateApsId¶
HTTP Request
GET /aps/2/resources/{aps-id}/productLinesByServiceTemplate/{serviceTemplateApsId}
Description
Get list of ProductLines by serviceTemplate aps id
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
serviceTemplateApsId |
String |
Aps id of serviceTemplate |
Returns
{@link List<ProductLine>}
getOrCreateProductLineByAppId¶
HTTP Request
GET /aps/2/resources/{aps-id}/productLineByAppId
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
subscriptionId |
String |
|
appId |
String |
|
connectProductName |
String |
Returns
getProcessInstances¶
HTTP Request
GET /aps/2/resources/{aps-id}/processInstance/{apsEntityId}
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
apsEntityId |
String |
Returns
completeProcessInstance¶
HTTP Request
PUT /aps/2/resources/{aps-id}/processInstance/{apsEntityId}/complete
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
apsEntityId |
String |
Returns
cancelProcessInstance¶
HTTP Request
PUT /aps/2/resources/{aps-id}/processInstance/{apsEntityId}/cancel
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
apsEntityId |
String |
Returns
appsList¶
HTTP Request
GET /aps/2/resources/{aps-id}/appsList
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
name |
String |
|
limit |
Integer |
|
offset |
Integer |
|
fulfillmentSystem |
String |
|
model |
String |
Returns
getUpgradePaths¶
HTTP Request
GET /aps/2/resources/{aps-id}/upgradePaths
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
planId |
Integer |
Returns
appDetails¶
HTTP Request
GET /aps/2/resources/{aps-id}/appDetails/{appId}
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
appId |
String |
|
withItems |
Boolean |
|
fulfillmentSystem |
String |
Returns
appItems¶
HTTP Request
GET /aps/2/resources/{aps-id}/appDetails/{appId}/items
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
appId |
String |
|
fulfillmentSystem |
String |
Returns
importItems¶
HTTP Request
POST /aps/2/resources/{aps-id}/appDetails/{appId}/import
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
appId |
String |
Returns
upgradeItems¶
HTTP Request
POST /aps/2/resources/{aps-id}/appDetails/{appId}/upgrade
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
appId |
String |
Returns
processUsageChunks¶
HTTP Request
POST /aps/2/resources/{aps-id}/processUsageChunks
Description
Reserved for future use
Returns
getProductInfo¶
HTTP Request
GET /aps/2/resources/{aps-id}/productInfoByBssPlan/{planApsId}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
planApsId |
String |
Returns
getProductInfoByApsId¶
HTTP Request
GET /aps/2/resources/{aps-id}/productInfoByApsId/{productLineApsId}
Description
Get product info of Connect product by product line.
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
productLineApsId |
String |
ProductLine UUID |
Returns
Instance of ProductInfoDTO
getTierConfigRequest¶
HTTP Request
GET /aps/2/resources/{aps-id}/tierConfig/{billingPlanApsId}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
billingPlanApsId |
String |
BillingPlanApsId. |
Returns
TierConfigResponseDTO.
getTierRequest¶
HTTP Request
GET /aps/2/resources/{aps-id}/getTierRequest/{productLineApsId}
Description
Get tier config of Connect product by product line.
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
productLineApsId |
String |
ProductLine UUID |
Returns
TierConfigResponseDTO.
getTierConfigs¶
HTTP Request
GET /aps/2/resources/{aps-id}/getTierConfigs
Description
Get list of tier configs
Returns
Instance of List<TierConfigurationDTO>
getConnectProductActionLink¶
HTTP Request
GET /aps/2/resources/{aps-id}/tier/action/{productLineApsId}/{actionId}
Description
Get action link for Connect product by product line and action id
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
productLineApsId |
String |
ProductLine UUID |
actionId |
String |
Action id |
Returns
Instance of ProductActionLink
getBusinessMetrics¶
HTTP Request
GET /aps/2/resources/{aps-id}/business-metrics
Description
Reserved for future use
Returns
createTierConfigRequest¶
HTTP Request
POST /aps/2/resources/{aps-id}/tierConfigRequest
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
bssPlanUuid |
String |
Returns
createTierRequest¶
HTTP Request
POST /aps/2/resources/{aps-id}/tierRequest/{productLineApsId}
Description
Create tier request
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
productLineApsId |
String |
ProductLineApsId. |
Returns
TierConfigurationRequest.
validateTierConfigRequest¶
HTTP Request
POST /aps/2/resources/{aps-id}/validateTierConfigRequest
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
bssPlanUuid |
String |
Returns
submitTierConfigRequest¶
HTTP Request
POST /aps/2/resources/{aps-id}/submitTierConfigRequest
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
bssPlanUuid |
String |
Returns
validate¶
HTTP Request
POST /aps/2/resources/{aps-id}/validate
Description
Reserved for future use
Returns
waitBssPlansSync¶
HTTP Request
POST /aps/2/resources/{aps-id}/waitBssPlansSync
Description
Reserved for future use
Returns
delegate¶
HTTP Request
POST /aps/2/resources/{aps-id}/delegate
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
memberId |
Integer |
Returns
waitSync¶
HTTP Request
POST /aps/2/resources/{aps-id}/waitSync
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
memberId |
Integer |
Returns
selfManage¶
HTTP Request
POST /aps/2/resources/{aps-id}/selfManage
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
memberId |
Integer |
Returns
customize¶
HTTP Request
POST /aps/2/resources/{aps-id}/customize
Description
Reserved for future use
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
memberId |
Integer |
Returns
getCBTimezone¶
HTTP Request
GET /aps/2/resources/{aps-id}/cbTimezone
Description
Reserved for future use
Returns
getVersions¶
HTTP Request
GET /aps/2/resources/{aps-id}/versions
Description
Return component versions
Returns
getFulfillmentSystems¶
HTTP Request
GET /aps/2/resources/{aps-id}/fulfillmentSystems
Description
Reserved for future use
Returns
upgradeApplication¶
HTTP Request
POST /aps/2/resources/{aps-id}/upgradeApplication
Description
Reserved for future use
Returns
attributeValues¶
HTTP Request
POST /aps/2/resources/{aps-id}/attributevalues
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
request |
Returns
getResourceCategories¶
HTTP Request
GET /aps/2/resources/{aps-id}/getResourceCategories
Description
Returns
getUnitsOfMeasure¶
HTTP Request
GET /aps/2/resources/{aps-id}/getUnitsOfMeasure
Description
List of UOMs available to a user.
Returns
UOMs.
getConnectOffers¶
HTTP Request
GET /aps/2/resources/{aps-id}/appDetails/{appId}/offers
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
appId |
String |
Returns
getOfferDetails¶
HTTP Request
GET /aps/2/resources/{aps-id}/appDetails/{appId}/offers/{offerId}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
offerId |
String |
|
appId |
String |
Returns
getCapabilities¶
HTTP Request
GET /aps/2/resources/{aps-id}/serviceTemplates/{id}/capabilities
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
id |
Integer |
Returns
getTermsAndConditions¶
HTTP Request
GET /aps/2/resources/{aps-id}/termsAndConditions
Description
Returns
updatePreset¶
HTTP Request
PUT /aps/2/resources/{aps-id}/presets/{id}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
id |
Integer |
Returns
syncProductLine¶
HTTP Request
POST /aps/2/resources/{aps-id}/presets/{id}/syncProductLine/{uid}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
id |
Integer |
|
uid |
String |
Returns
syncPreset¶
HTTP Request
POST /aps/2/resources/{aps-id}/presets/{id}/syncPreset
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
id |
Integer |
Returns
clonePreset¶
HTTP Request
POST /aps/2/resources/{aps-id}/presets/{id}/clone
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
id |
Integer |
Returns
getPresetById¶
HTTP Request
GET /aps/2/resources/{aps-id}/presets/{id}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
id |
Integer |
Returns
getAllPresets¶
HTTP Request
GET /aps/2/resources/{aps-id}/presets
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
type |
||
limit |
Integer |
|
offset |
Integer |
|
sortBy |
String |
|
asc |
Boolean |
Returns
getPresetCreateFormData¶
HTTP Request
GET /aps/2/resources/{aps-id}/presets/formData
Description
Returns
getAvailability¶
HTTP Request
GET /aps/2/resources/{aps-id}/appDetails/{appId}/availability
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
appId |
String |
Returns
getListings¶
HTTP Request
GET /aps/2/resources/{aps-id}/listings
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
productId |
String |
|
accountId |
String |
Returns
updateAvailability¶
HTTP Request
POST /aps/2/resources/{aps-id}/appDetails/{appId}/availability
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
appId |
String |
|
request |
Returns
listPlans¶
HTTP Request
GET /aps/2/resources/{aps-id}/plans
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
limit |
Integer |
|
offset |
Integer |
|
sortBy |
String |
|
asc |
Boolean |
|
serviceTemplateId |
Integer |
|
serviceTemplateName |
String |
|
servicePlanId |
Integer |
|
servicePlanName |
String |
|
billingPeriodType |
String |
|
billingPeriod |
Integer |
|
published |
Boolean |
|
includeDelegated |
Boolean |
Returns
listPlansDetailed¶
HTTP Request
GET /aps/2/resources/{aps-id}/plans-detailed
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
limit |
Integer |
|
offset |
Integer |
|
sortBy |
String |
|
asc |
Boolean |
Returns
getPlan¶
HTTP Request
GET /aps/2/resources/{aps-id}/plans/{planId}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
planId |
Integer |
Returns
updatePlan¶
HTTP Request
PUT /aps/2/resources/{aps-id}/plans/{planId}
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
planId |
Integer |
Returns
getSubsResellerGroup¶
HTTP Request
GET /aps/2/resources/{aps-id}/subsResellerGroup
Description
Returns
getTenantsByServiceTemplate¶
HTTP Request
GET /aps/2/resources/{aps-id}/tenants
Description
Parameters
PARAMETER |
TYPE |
DESCRIPTION |
|---|---|---|
serviceTemplateId |
Array |
Returns
Structures¶
Property¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
key |
String |
Not Required |
||
value |
String |
Not Required |
PlanIdentity¶
TargetAccount¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
accountId |
Integer |
Not Required |
||
memberId |
Integer |
Not Required |
||
companyName |
String |
Not Required |
ExcelConfig¶
A structure of this kind represents an Excel configuration.
An Excel configuration contains the differences between the current plan configuration of a product line and a target plan configuration. Each difference is an item such as a resource, service template, service plan, a resource dependency, and so on that must be created or updated.
Differences are represented with Diff structures. This kind of structure is described in the Examples section below.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
resources |
Array of ExcelResource |
Not Required |
The resource differences to be applied to the current plan configuration |
|
serviceTemplates |
Array of ExcelServiceTemplate |
Not Required |
The service template differences to be applied to the current plan configuration |
|
servicePlans |
Array of ExcelServicePlan |
Not Required |
The service plan differences to be applied to the current plan configuration |
|
termsConditionsDetails |
TermsConditions |
Not Required |
The Terms and Conditions items of the Excel configuration
Those items are specified as a JSON object that consists of key-value pairs. A key is the en_US name of an item, and the value is the item in the JSON format.
|
|
subscriptionNotificationTemplates |
Not Required |
The subscription notification templates of the Excel configuration. |
||
resourceDependencies |
Array of ExcelResourceDependency |
Not Required |
The resource dependency differences to be applied to the current plan configuration |
|
opUnitResourceCategories |
Array of ExcelOpUnitResourceCategory |
Not Required |
||
tcs |
Object |
Not Required |
ExcelSubscriptionNotificationTemplate¶
A structure of this kind represents a subscription notification template in an Excel configuration.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
name |
String |
Not Required |
The name of the template |
|
locale |
String |
Not Required |
The locale of the template |
|
messageCategory |
Not Required |
The message category of the template
The supported values are:
RENEWAL_AND_EXPIRATION_NOTICES - The Renewal and Expiration Notices category |
||
htmlText |
String |
Not Required |
The HTML text of the template |
|
plainText |
String |
Not Required |
The plain text of the template |
|
subject |
String |
Not Required |
The subject of the template |
|
toAddress |
String |
Not Required |
The recipients of the template |
|
toName |
String |
Not Required |
The recipient names of the template |
|
bccAddress |
String |
Not Required |
The BCC recipients of the template |
|
fromAddress |
String |
Not Required |
The address of the sender of the template |
|
fromName |
String |
Not Required |
The name of the sender of the template |
|
pdfAttachmentName |
String |
Not Required |
The name of a PDF attachment of the template |
|
active |
Boolean |
Not Required |
Defines whether the template is active. |
|
condition |
String |
Not Required |
The condition of the template |
|
visibleToResellers |
Boolean |
Not Required |
Defines whether the template is visible to resellers. |
|
secureBody |
Boolean |
Not Required |
Defines whether to secure the body of the template. |
MessageCategory¶
Message category
RENEWAL_AND_EXPIRATION_NOTICES - Renewal and Expiration NoticesAppInfo¶
This is an auxiliary structure. It is used in a target plan configuration and contains information on any of the products of that target plan configuration.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
appCustomIconUrl |
String |
Not Required |
The custom icon URL of the product |
|
impersonationUid |
String |
Not Required |
The APS identifier of the product |
|
productLineInfo |
Not Required |
ProductLineInfo¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
productLineUUID |
String |
Not Required |
||
name |
String |
Not Required |
||
productLineType |
Not Required |
|||
parameters |
Array of FulfillmentParameter |
Not Required |
||
baseProductLine |
Not Required |
|||
ownProductLines |
Array of ProductLineInfo |
Not Required |
||
isConnect |
Boolean |
Not Required |
ProductLineType¶
FulfillmentParameter¶
A structure of this kind represents a fulfillment parameter of a product line.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
id |
String |
Required |
The identifier of the fulfillment parameter |
|
label |
String |
Not Required |
The label of the fulfillment parameter |
|
labelLoc |
I18n |
Not Required |
The label of the fulfillment parameter in different languages
The type of this parameter is MLString.
|
|
defaultValue |
String |
Not Required |
The default value of the fulfillment parameter |
|
description |
String |
Not Required |
The description of the fulfillment parameter |
|
descriptionLoc |
I18n |
Not Required |
The description of the fulfillment parameter in different languages
The type of this parameter is MLString.
|
|
phase |
Enum |
Required |
activation |
The phase of the fulfillment parameter
The supported values are:
activation - The Activation phasefulfillment - The Fulfillment phasereseller - The Reseller phase |
type |
Enum |
Required |
text |
| The type of the fulfillment parameter
The supported values are:
text - The Text typedropdown - The Dropdown typepassword - The Password typeemail - The Email typecheckbox - The Checkbox typesubdomain - The Subdomain typedomain - The Domain typeaddress - The Address typephone - The Phone typeurl - The URL typechoice - The Choice typeobject - The Object type |
choices |
Array of ParameterChoice |
Not Required |
The choices of the fulfillment parameter |
|
minLength |
Integer |
Not Required |
The minimum length of the fulfillment parameter |
|
maxLength |
Integer |
Not Required |
The maximum length of the fulfillment parameter |
|
isRequired |
Boolean |
Not Required |
Defines whether the fulfillment parameter is required. |
|
showToCustomer |
Boolean |
Not Required |
Defines whether the fulfillment parameter is shown to customers. |
|
placeholder |
String |
Not Required |
The placeholder of the fulfillment parameter |
|
hint |
String |
Not Required |
The hint of the fulfillment parameter |
|
placeholderLoc |
I18n |
Not Required |
The placeholder of the fulfillment parameter in different languages
The type of this parameter is MLString.
|
|
hintLoc |
I18n |
Not Required |
The hint of the fulfillment parameter in different languages
The type of this parameter is MLString.
|
MLString¶
A structure of this kind represents a multi-language string.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
ar_AE |
String |
Not Required |
The value of the string for Arabic, Standard - United Arab Emirates |
|
bg_BG |
String |
Not Required |
The value of the string for Bulgarian - Bulgaria |
|
cs_CZ |
String |
Not Required |
The value of the string for Czech - Czech Republic |
|
da_DK |
String |
Not Required |
The value of the string for Danish - Denmark |
|
de_DE |
String |
Not Required |
The value of the string for German - Germany |
|
el_GR |
String |
Not Required |
The value of the string for Greek - Greece |
|
en_US |
String |
Not Required |
The value of the string for English - United States |
|
es_ES |
String |
Not Required |
The value of the string for Spanish - Spain |
|
fr_FR |
String |
Not Required |
The value of the string for French - France |
|
he_IL |
String |
Not Required |
The value of the string for Hebrew - Israel |
|
iw_IL |
String |
Not Required |
The value of the string for Iwrit - Israel |
|
hr_HR |
String |
Not Required |
The value of the string for Croatian - Croatia |
|
hu_HU |
String |
Not Required |
The value of the string for Hungarian - Hungary |
|
id_ID |
String |
Not Required |
The value of the string for Indonesian - Indonesia |
|
it_IT |
String |
Not Required |
The value of the string for Italian - Italy |
|
ja_JP |
String |
Not Required |
The value of the string for Japanese - Japan |
|
ko_KR |
String |
Not Required |
The value of the string for Korean - Korea |
|
kz_KZ |
String |
Not Required |
The value of the string for Kazakh - Kazakhstan |
|
mk_MK |
String |
Not Required |
The value of the string for Macedonian - Macedonia |
|
nl_NL |
String |
Not Required |
The value of the string for Dutch - The Netherlands |
|
no_NO |
String |
Not Required |
The value of the string for Norwegian - Norway |
|
pl_PL |
String |
Not Required |
The value of the string for Polish - Poland |
|
pt_BR |
String |
Not Required |
The value of the string for Portuguese - Brazil |
|
pt_PT |
String |
Not Required |
The value of the string for Portuguese - Portugal |
|
ro_RO |
String |
Not Required |
The value of the string for Romanian - Romania |
|
ru_RU |
String |
Not Required |
The value of the string for Russian - Russia |
|
sv_SE |
String |
Not Required |
The value of the string for Swedish - Sweden |
|
th_TH |
String |
Not Required |
The value of the string for Thai - Thailand |
|
tr_TR |
String |
Not Required |
The value of the string for Turkish - Turkey |
|
zh_CN |
String |
Not Required |
The value of the string for Chinese, Simplified - China |
|
sl_SI |
String |
Not Required |
The value of the string for Slovenian - Slovenia |
|
sr_RS |
String |
Not Required |
The value of the string for Serbian - Serbia |
|
xx_XA |
String |
Not Required |
Reserved for future use |
|
xx_XB |
String |
Not Required |
Reserved for future use |
|
xx_XC |
String |
Not Required |
Reserved for future use |
|
xx_XD |
String |
Not Required |
Reserved for future use |
|
xx_XE |
String |
Not Required |
Reserved for future use |
|
xx_XF |
String |
Not Required |
Reserved for future use |
|
xx_XG |
String |
Not Required |
Reserved for future use |
|
xx_XH |
String |
Not Required |
Reserved for future use |
|
xx_XI |
String |
Not Required |
Reserved for future use |
|
xx_XJ |
String |
Not Required |
Reserved for future use |
ParameterChoice¶
A structure of this kind represents a choice of a fulfillment parameter.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
isDefault |
Boolean |
Not Required |
Defines whether the choice is default. |
|
label |
String |
Not Required |
The label of the choice |
|
labelLoc |
I18n |
Not Required |
The label of the choice |
|
value |
String |
Not Required |
The value of the choice |
ConfigurationInfo¶
The structure represents a set of changes to be applied for the product line after the PPR file was uploaded for that product line. <p/> This structure MUST NOT be filled by users of /applyConfig because its format WILL change over time. <p/> Instead, use /parseConfig endpoint and upload a PPR file in JSON or Excel format, and then POST the output of /parseConfig to /applyConfig. The format of /parseConfig is a contract with users, and backward compatibility is guaranteed. The compatibility between /parseConfig and /applyConfig within a single release is also guaranteed. <p/> If you still think you need to use /applyConfig without /parseConfig, you’re wrong. If you still manually construct data for POSTing to /applyConfig in your code (business logic, tests, internal tools, etc.), you accept the responsibility of regularly adapting that code to changes in this structure’s format.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
planIdentity |
Not Required |
name |
||
owner |
Not Required |
|||
serviceTemplateId |
Integer |
Not Required |
||
serviceTerms |
Object |
Not Required |
||
termsAndConditions |
Object |
Not Required |
||
existingPdiPlans |
Object |
Not Required |
||
excelConfig |
Not Required |
|||
appInfo |
Not Required |
|||
configOrigination |
Not Required |
|||
isDelegatedPL |
Boolean |
Not Required |
false |
ExcelConfigData¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
data |
String |
Not Required |
CamundaService¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
name |
String |
Not Required |
||
url |
String |
Not Required |
||
login |
String |
Not Required |
ProcessInstanceDTO¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
apsId |
String |
Not Required |
||
processInstanceId |
String |
Not Required |
||
businessKey |
String |
Not Required |
||
accountUid |
String |
Not Required |
||
productName |
String |
Not Required |
||
accountName |
String |
Not Required |
AttributeValuesDTO¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
id |
String |
Not Required |
||
appId |
String |
Not Required |
||
mpn |
String |
Not Required |
||
itemId |
String |
Not Required |
||
value |
String |
Not Required |
AttributeValueRequest¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
attributeValues |
Array of AttributeValuesDTO |
Not Required |
PresetType¶
AvailabilityRequestDTO¶
BillingModel¶
charge before billing period - The Charge Before Billing Period (BBP) billing modelcharge after billing period - The Charge After Billing Period (ABP) billing modelcharge before subscription period - The Charge Before Subscription Period (BSP) billing modeluse external rating - The Use External Rating billing modelPricePeriodType¶
billing period - The Billing Period typemonth - The Month typeSubscriptionPeriod¶
Billing subscription period
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
bssId |
Integer |
Not Required |
||
active |
Boolean |
Not Required |
true |
|
period |
Integer |
Not Required |
1 |
|
periodType |
Enum |
Not Required |
month |
|
cancellationFeeType |
Enum |
Not Required |
none |
|
cancellationFeeValue |
Sting |
Not Required |
||
isTrial |
Boolean |
Not Required |
false |
|
afterRefundPeriod |
Enum |
Not Required |
no_refund |
|
fullRefundPeriod |
Integer |
Not Required |
0 |
|
cancelationPolicies |
Array of PlanPeriodPolicy |
Not Required |
||
downsizePolicies |
Array of PlanPeriodPolicy |
Not Required |
||
upsizePolicies |
Array of PlanPeriodPolicy |
Not Required |
||
revertOrderPolicies |
Array of PlanPeriodPolicy |
Not Required |
SubscriptionPeriodType¶
Period:
month - Monthyear - YearSubscriptionCancellationFeeType¶
Subscription Cancellation Fee Type
none - none until_expiration - until expiration custom - customSubscriptionAfterRefundPeriod¶
SubscriptionAfterRefundPeriod
no_refund - no refundrefund_prorated_recurring_fee - refund prorated recurring feePlanPeriodPolicy¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
action |
Enum |
Not Required |
||
actionPeriod |
Integer |
Not Required |
||
actionPeriodTimezone |
Enum |
Not Required |
||
applicableTo |
Enum |
Not Required |
Action¶
Action Policy
full_refund - full refundprorated_refund - prorated refundno_refund - no refundprohibited - prohibitedpenalty - penaltynot_allowed_except_for_after_upsize - not allowed except for after upsizeActionPeriodTimezone¶
Action Period Timezone
customer - customerfrom_plan - from planApplicableTo¶
Applicable To
first_subscription_period - first subscription periodnext_subscription_periods - next subscription periodsall_subscription_periods - all subscription periodsAutoRenewType¶
Disabled - The Disabled typeOn Last Statement Day - The On Last Statement Day typeBefore Expiration - The Before Expiration typeSalesCategory¶
A structure of this kind represents a sales category.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
expand |
Boolean |
Not Required |
Defines whether to expand the sales category in the marketplace and the customer control panel. |
|
inCCP |
Boolean |
Not Required |
Defines whether to show the sales category in the customer control panel. |
ServiceTerms¶
A structure of this kind represents a Service Terms item.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
bssId |
Integer |
Not Required |
||
serviceTermsName |
String |
Not Required |
||
destroyAfterHold |
Boolean |
Required |
false |
|
holdPeriodInDays |
Integer |
Required |
0 |
|
gracePeriodInDays |
Integer |
Required |
0 |
|
trialDestroyAfterHold |
Boolean |
Required |
false |
|
trialHoldPeriodInDays |
Integer |
Required |
0 |
|
trialGracePeriodInDays |
Integer |
Required |
0 |
TermsAndConditions¶
A structure of this kind represents a Terms and Conditions item.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
id |
String |
Required |
The identifier of the item |
|
bssId |
Integer |
Required |
The CloudBlue Commerce identifier of the item |
|
name |
String |
Not Required |
The name of the item |
|
value |
String |
Not Required |
The value of the item |
|
isDeleted |
Boolean |
Not Required |
false |
Defines whether the item is deleted. |
type |
Enum |
Not Required |
| The type of the item:
The supported values are:
plain_text - The item contains the text of terms and conditions.link - The item contains a URL of terms and conditions. |
|
ownerAccountId |
Integer |
Not Required |
The CloudBlue Commerce identifier of the account that the item belongs to |
|
acceptType |
Enum |
Not Required |
| The acceptance type of the item:
The supported values are:
Always, on every purchase - Always, on every purchaseOn first purchase and after every T&C change - On the first purchase and after every change of terms and conditionsOnly on a first purchase - Only on the first purchaseOn every purchase and after every T&C change - On every purchase and after every change of terms and conditions |
NotificationTemplateMapping¶
A structure of this kind represents a mapping between a notification template and a notification type.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
templateType |
Enum |
Not Required |
| The notification type of the template
The supported values are:
welcome_email - The Welcome Email typeexpiration_email - The Expiration Email type |
|
templateName |
String |
Not Required |
The name of the template |
TemplateType¶
welcome_email - The Welcome Email typeexpiration_email - The Expiration Email typeRatingMode¶
Rating mode
Costs only - Costs onlyRevenue only - Revenue onlyRevenue and Costs - Revenue and CostsBillingPeriodAlignment¶
CoTermingPossibilities¶
Preset¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
id |
Integer |
Not Required |
||
onVersion |
Integer |
Not Required |
PlanDetailedDTO¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
description |
I18n |
Not Required |
||
billingModel |
Enum |
Not Required |
Charge Before Billing Period |
|
pricePeriodType |
Enum |
Not Required |
billing period |
|
alignWithStatementDay |
Boolean |
Not Required |
false |
|
isSalesOrderProrated |
Boolean |
Not Required |
false |
|
isFirstPeriodForFree |
Boolean |
Not Required |
false |
|
isOneTimeFeePlan |
Boolean |
Not Required |
true |
|
subscriptionPeriods |
Array of SubscriptionPeriod |
Not Required |
||
vendorTimezone |
String |
Not Required |
||
autoRenewType |
Enum |
Not Required |
Before Expiration |
|
renewOrderInterval |
Integer |
Not Required |
||
autoRenewPlanPeriodId |
Integer |
Not Required |
||
autoRenewPlanId |
Integer |
Not Required |
||
planCategory |
String |
Not Required |
||
salesCategories |
Array of SalesCategory |
Not Required |
||
serviceTerms |
Not Required |
|||
termsAndConditions |
Array of TermsAndConditions |
Not Required |
||
availableNotifications |
Array of NotificationTemplateMapping |
Not Required |
||
enabledNotifications |
Array of NotificationTemplateMapping |
Not Required |
||
customStatementDay |
Integer |
Not Required |
0 |
|
isAllowedScheduledChanges |
Boolean |
Not Required |
false |
|
ratingMode |
Enum |
Not Required |
||
billingPeriodAlignment |
Enum |
Not Required |
Subscription Period Start |
|
expDateAlignedWithEndOfMonth |
Boolean |
Not Required |
false |
|
expDateAlignedWithSubscr |
Boolean |
Not Required |
false |
|
coTermingPossibilities |
Enum |
Not Required |
Restricted |
|
coTermOnCustomDate |
Boolean |
Not Required |
false |
|
preset |
Not Required |
|||
connectOfferId |
String |
Not Required |
||
connectOfferPlanId |
String |
Not Required |
||
connectOfferVersion |
Integer |
Not Required |
Period¶
PlanDTO¶
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
planId |
Integer |
Not Required |
||
uid |
String |
Not Required |
||
ownerAccountId |
Integer |
Not Required Read Only |
||
billingPeriodType |
Enum |
Not Required |
month |
|
billingPeriod |
Integer |
Not Required |
1 |
|
name |
I18n |
Not Required |
||
parentPlanId |
Integer |
Not Required |
||
serviceTemplateId |
Integer |
Not Required |
||
serviceTemplateName |
Integer |
Not Required |
||
iconUrl |
String |
Not Required |
||
published |
Boolean |
Not Required |
false |
|
delegated |
Boolean |
Not Required |
false |
|
updateDate |
String |
Not Required |
ResellerGroup¶
A structure of this kind represents a group of resellers that is based on a reseller service template.
NAME |
TYPE |
ATTRIBUTES |
DEFAULT |
DESCRIPTION |
|---|---|---|---|---|
id |
Integer |
Not Required |
The CloudBlue Commerce identifier of the reseller service template that the reseller group is based on. |
|
name |
Not Required |
The name of the reseller service template
The type of this parameter is MLString.
|
Examples¶
In this section:
The Diff Structure¶
A Diff structure is an auxiliary structure that contains an item such as a resource, service template, service plan,
a resource dependency, and so on that must be created or updated in the current plan configuration of a product line.
The value property of a Diff structure contains an item to be created or updated.
The other fields of a Diff structure define which action must be performed in the current plan configuration.
This Diff structure is used to update an existing item:
{
"value": {
...
},
"action": "EDIT",
"edit": true,
"add": false
}
This Diff structure is used to create an item:
{
"value": {
...
},
"action": "ADD",
"edit": false,
"add": true
}
Updating the Plan Configuration of a Product Line¶
You can update the current plan configuration of a product line by using any of the following approaches:
Approach 1
Prepare an Excel file with the target plan configuration. When preparing that Excel file, you must use the format provided at https://docs.cloudblue.com/cbc/21.0/Product-Lifecycle-Management/File-Requirements.htm.
Call the
parseConfigcustom operation of the PLM component’s APS application and pass that Excel file in the Base64 format. As a result, you receive aConfigurationInfoJSON object.Call the
applyConfigcustom operation of the PLM component’s APS application and pass thatConfigurationInfoJSON object. As a result, the current plan configuration is transformed into the target plan configuration.
Approach 2
Prepare a
ConfigurationInfoJSON object with the target plan configuration.Call the
applyConfigcustom operation of the PLM component’s APS application and pass thatConfigurationInfoJSON object. As a result, the current plan configuration is transformed into the target plan configuration.
Here is an example of the first approach:
Prepare an Excel file with the target plan configuration. When preparing that Excel file, use the format provided at https://docs.cloudblue.com/cbc/21.0/Product-Lifecycle-Management/File-Requirements.htm.
Note
In the example,
this fileis used as an Excel file with a target plan configuration.Call the
parseConfigcustom operation of the PLM component’s APS application and pass that Excel file in the Base64 format. To do that, make a request like this:POST /aps/2/resources/ca9685cb-d067-441b-b14d-146325aa2e53/parseConfig { "excelConfig": "UEs...AAA=" }
Note
To prepare a value for the
excelConfigproperty, you can use the base64 -w 0 YOUR_EXCEL_FILE command.As a result, you will receive a response like this:
HTTP/1.1 200 OK { "owner": { "accountId": 1, "memberId": 1 }, "serviceTemplateId": 9, "serviceTerms": { "0/0 Service Terms": { "bssId": 6, "serviceTermsName": "0/0 Service Terms", "holdPeriodInDays": 0, "gracePeriodInDays": 0 }, "Default": { "bssId": 0, "serviceTermsName": "Default", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "Domain Service Terms": { "bssId": 3, "serviceTermsName": "Domain Service Terms", "holdPeriodInDays": 0, "gracePeriodInDays": 30 }, "Hosting Service Terms": { "bssId": 2, "serviceTermsName": "Hosting Service Terms", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "In-House Products for Resellers": { "bssId": 4, "serviceTermsName": "In-House Products for Resellers", "holdPeriodInDays": 0, "gracePeriodInDays": 0 } }, "existingPdiPlans": { "teamleader eu (monthly plan)": { "aps": { "id": "01431d51-b012-4558-91b1-468f7326531d", "type": "http://com.odin.platform/inhouse-products/pdiPlan/1.0", "status": "aps:ready", "subscription": null, "revision": 2, "modified": 1649431014000, "schema": null, "package": null }, "products": null, "operatingUnits": null, "account": null, "productLine": null, "name": { "de_DE": "Teamleader EU (Monatsplan)", "en_US": "Teamleader EU (Monthly Plan)", "es_ES": "Teamleader EU (Monthly Plan)", "fr_FR": "Teamleader EU (Monthly Plan)", "it_IT": "Teamleader EU (Monthly Plan)", "nl_NL": "Teamleader EU (Monthly Plan)", "pt_BR": "Teamleader EU (Monthly Plan)", "pt_PT": "Teamleader EU (Monthly Plan)", "tr_TR": "Teamleader EU (Monthly Plan)" }, "description": { "de_DE": "Der monatliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "en_US": "The monthly service gives companies a majority of the same benefits that on-premises deployments provide.", "es_ES": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr_FR": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it_IT": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl_NL": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt_BR": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "pt_PT": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr_TR": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "bssServicePlanId": 12, "serviceTemplateId": 9, "isDefault": false, "customIconUrl": null, "billingPeriod": 3, "billingPeriodType": "psd", "pricePeriodType": "billing period", "planCategory": "Software & Licenses", "appId": null, "billingModel": "charge before billing period", "autoRenewType": "Before Expiration", "renewOrderInterval": 1, "vendorTimezone": null, "subscriptionPeriods": [ { "bssId": 16, "period": 6, "periodType": "month", "cancellationFeeType": "none", "cancellationFeeValue": "10", "afterRefundPeriod": "refund_prorated_recurring_fee", "fullRefundPeriod": 1, "cancelationPolicies": null, "downsizePolicies": null, "autoRenewPeriod": true, "trial": false }, { "bssId": 17, "period": 12, "periodType": "month", "cancellationFeeType": "none", "cancellationFeeValue": "", "afterRefundPeriod": "no_refund", "fullRefundPeriod": 3, "cancelationPolicies": null, "downsizePolicies": null, "autoRenewPeriod": false, "trial": false } ], "salesCategories": [ { "id": 10, "name": { "de": "TeamleaderEU", "en": "TeamleaderEU", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "Der Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten. Durch die Integration in den Cloud-Service können Unternehmen ihren Marktanteil ausbauen, wiederkehrende Umsätze automatisieren und steigern, die Kundenzufriedenheit steigern und gleichzeitig die Betriebskosten senken.", "en": "The service gives companies a majority of the same benefits that on-premises deployments provide. By integrating with the cloud service, companies can expand their market share, automate and grow recurring revenue, increase customer satisfaction, and cut operational costs at the same time.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "parent": { "id": 9, "name": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "parent": null, "expand": true, "inCCP": true }, "expand": true, "inCCP": true } ], "serviceTerms": { "bssId": 0, "serviceTermsName": "Default", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "termsAndConditions": [ { "id": null, "bssId": 7, "name": "Teamleader EU Additional Terms", "value": "Teamleader EU Additional Terms Content", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "On first purchase and after every T&C change" }, { "id": null, "bssId": 6, "name": "Common", "value": "Common", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "On first purchase and after every T&C change" }, { "id": null, "bssId": 4, "name": "Provider pre-existing TC", "value": "kp8CVlZAOc", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "Always, on every purchase" } ], "availableNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome e-mail - Business Class Mail" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "enabledNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome e-mail - Business Class Mail" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "servicePlanUpdateNotificationId": null, "alignWithStatementDay": true, "isSalesOrderProrated": true, "isFirstPeriodForFree": true, "customStatementDay": 2, "notificationScheduleId": 12, "resellerGroups": [], "volumePricingRatingMode": true, "ratingMode": "Revenue only", "default": false, "isOneTimeFeeProduct": false, "oneTimeFeePlan": false, "salesOrderProrated": true, "firstPeriodForFree": true, "published": true, "isPublished": true }, "teamleader eu (yearly plan 2)": { "aps": { "id": "7f80c0a3-301e-4b1d-9dd2-09af4719f456", "type": "http://com.odin.platform/inhouse-products/pdiPlan/1.0", "status": "aps:ready", "subscription": null, "revision": 2, "modified": 1649431015000, "schema": null, "package": null }, "products": null, "operatingUnits": null, "account": null, "productLine": null, "name": { "de_DE": "Teamleader EU (Jahresplan)", "en_US": "Teamleader EU (Yearly Plan 2)", "es_ES": "Teamleader EU (Yearly Plan 2)", "fr_FR": "Teamleader EU (Yearly Plan 2)", "it_IT": "Teamleader EU (Yearly Plan 2)", "nl_NL": "Teamleader EU (Yearly Plan 2)", "pt_BR": "Teamleader EU (Yearly Plan 2)", "pt_PT": "Teamleader EU (Yearly Plan 2)", "tr_TR": "Teamleader EU (Yearly Plan 2)" }, "description": { "de_DE": "Der jährliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "en_US": "The yearly service gives companies a majority of the same benefits that on-premises deployments provide.", "es_ES": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr_FR": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it_IT": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl_NL": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt_BR": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "pt_PT": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr_TR": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "bssServicePlanId": 14, "serviceTemplateId": 9, "isDefault": false, "customIconUrl": null, "billingPeriod": 12, "billingPeriodType": "psd", "pricePeriodType": "month", "planCategory": "Software & Licenses", "appId": null, "billingModel": "charge before billing period", "autoRenewType": "On Last Statement Day", "renewOrderInterval": 1, "vendorTimezone": null, "subscriptionPeriods": [ { "bssId": 19, "period": 5, "periodType": "year", "cancellationFeeType": "none", "cancellationFeeValue": "", "afterRefundPeriod": "no_refund", "fullRefundPeriod": 4, "cancelationPolicies": null, "downsizePolicies": null, "autoRenewPeriod": true, "trial": false } ], "salesCategories": [ { "id": 10, "name": { "de": "TeamleaderEU", "en": "TeamleaderEU", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "Der Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten. Durch die Integration in den Cloud-Service können Unternehmen ihren Marktanteil ausbauen, wiederkehrende Umsätze automatisieren und steigern, die Kundenzufriedenheit steigern und gleichzeitig die Betriebskosten senken.", "en": "The service gives companies a majority of the same benefits that on-premises deployments provide. By integrating with the cloud service, companies can expand their market share, automate and grow recurring revenue, increase customer satisfaction, and cut operational costs at the same time.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "parent": { "id": 9, "name": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "parent": null, "expand": true, "inCCP": true }, "expand": true, "inCCP": true } ], "serviceTerms": { "bssId": 0, "serviceTermsName": "Default", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "termsAndConditions": [ { "id": null, "bssId": 7, "name": "Teamleader EU Additional Terms", "value": "Teamleader EU Additional Terms Content", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "On first purchase and after every T&C change" } ], "availableNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome Email - Wedge Networks" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "enabledNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome Email - Wedge Networks" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "servicePlanUpdateNotificationId": null, "alignWithStatementDay": true, "isSalesOrderProrated": false, "isFirstPeriodForFree": false, "customStatementDay": 1, "notificationScheduleId": 12, "resellerGroups": [], "volumePricingRatingMode": false, "ratingMode": null, "default": false, "isOneTimeFeeProduct": false, "oneTimeFeePlan": false, "salesOrderProrated": false, "firstPeriodForFree": false, "published": true, "isPublished": true }, "teamleader eu (yearly plan)": { "aps": { "id": "6b52c392-82e4-44f4-b0b8-4abb7ca0b082", "type": "http://com.odin.platform/inhouse-products/pdiPlan/1.0", "status": "aps:ready", "subscription": null, "revision": 2, "modified": 1649431015000, "schema": null, "package": null }, "products": null, "operatingUnits": null, "account": null, "productLine": null, "name": { "de_DE": "Teamleader EU (Jahresplan)", "en_US": "Teamleader EU (Yearly Plan)", "es_ES": "Teamleader EU (Yearly Plan)", "fr_FR": "Teamleader EU (Yearly Plan)", "it_IT": "Teamleader EU (Yearly Plan)", "nl_NL": "Teamleader EU (Yearly Plan)", "pt_BR": "Teamleader EU (Yearly Plan)", "pt_PT": "Teamleader EU (Yearly Plan)", "tr_TR": "Teamleader EU (Yearly Plan)" }, "description": { "de_DE": "Der jährliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "en_US": "The yearly service gives companies a majority of the same benefits that on-premises deployments provide.", "es_ES": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr_FR": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it_IT": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl_NL": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt_BR": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "pt_PT": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr_TR": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "bssServicePlanId": 13, "serviceTemplateId": 9, "isDefault": false, "customIconUrl": null, "billingPeriod": 12, "billingPeriodType": "psd", "pricePeriodType": "month", "planCategory": "Software & Licenses", "appId": null, "billingModel": "charge before billing period", "autoRenewType": "On Last Statement Day", "renewOrderInterval": 1, "vendorTimezone": null, "subscriptionPeriods": [ { "bssId": 18, "period": 4, "periodType": "year", "cancellationFeeType": "none", "cancellationFeeValue": "", "afterRefundPeriod": "no_refund", "fullRefundPeriod": 2, "cancelationPolicies": null, "downsizePolicies": null, "autoRenewPeriod": true, "trial": true } ], "salesCategories": [ { "id": 10, "name": { "de": "TeamleaderEU", "en": "TeamleaderEU", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "Der Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten. Durch die Integration in den Cloud-Service können Unternehmen ihren Marktanteil ausbauen, wiederkehrende Umsätze automatisieren und steigern, die Kundenzufriedenheit steigern und gleichzeitig die Betriebskosten senken.", "en": "The service gives companies a majority of the same benefits that on-premises deployments provide. By integrating with the cloud service, companies can expand their market share, automate and grow recurring revenue, increase customer satisfaction, and cut operational costs at the same time.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "parent": { "id": 9, "name": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "parent": null, "expand": true, "inCCP": true }, "expand": true, "inCCP": true } ], "serviceTerms": { "bssId": 0, "serviceTermsName": "Default", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "termsAndConditions": [ { "id": null, "bssId": 7, "name": "Teamleader EU Additional Terms", "value": "Teamleader EU Additional Terms Content", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "On first purchase and after every T&C change" } ], "availableNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome Email - Wedge Networks" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "enabledNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome Email - Wedge Networks" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "servicePlanUpdateNotificationId": null, "alignWithStatementDay": true, "isSalesOrderProrated": false, "isFirstPeriodForFree": false, "customStatementDay": 1, "notificationScheduleId": 12, "resellerGroups": [], "volumePricingRatingMode": false, "ratingMode": null, "default": false, "isOneTimeFeeProduct": false, "oneTimeFeePlan": false, "salesOrderProrated": false, "firstPeriodForFree": false, "published": true, "isPublished": true } }, "excelConfig": { "resources": [ { "value": { "resourceType": { "name": { "en": "Teamleader EU: Teamleader - monthly billing" }, "resClass": null, "actParams": null, "description": {} }, "resourceCategory": { "id": 1, "name": { "de": "", "pt": "", "en": "Additional Resources", "it": "", "fr": "", "es": "", "nl": "", "tr": "" }, "description": { "de": "", "pt": "", "en": "Additional Resources", "it": "", "fr": "Additional Resources", "nl": "", "tr": "", "es": "" }, "parent": null, "taxCatId": "All products" }, "uom": "unit", "measurable": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "resourceType": { "name": { "en": "Teamleader EU: Teamleader - yearly billing" }, "resClass": null, "actParams": null, "description": {} }, "resourceCategory": { "id": 11, "name": { "de": "", "pt": "", "en": "Other Resources", "it": "", "fr": "", "es": "", "nl": "", "tr": "" }, "description": { "de": "", "pt": "", "en": "Other Resources", "it": "", "fr": "Other Resources", "nl": "", "tr": "", "es": "" }, "parent": { "id": 5, "name": { "en": "Other Products" }, "description": null, "parent": null, "taxCatId": null }, "taxCatId": "All products" }, "uom": "unit", "measurable": null }, "action": "EDIT", "edit": true, "add": false } ], "serviceTemplates": [], "servicePlans": [ { "value": { "name": { "de": "Teamleader EU (Monatsplan)", "pt": "Teamleader EU (Monthly Plan)", "en": "Teamleader EU (Monthly Plan)", "it": "Teamleader EU (Monthly Plan)", "fr": "Teamleader EU (Monthly Plan)", "tr": "Teamleader EU (Monthly Plan)", "nl": "Teamleader EU (Monthly Plan)", "es": "Teamleader EU (Monthly Plan)" }, "planBillingPeriod": null, "planBillingPeriodType": null, "pricePeriodType": "billing period", "autoRenewType": null, "renewOrderInterval": null, "vendorTimezone": null, "billingModel": null, "serviceTemplateId": null, "serviceTemplateName": null, "description": { "de": "Der monatliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "en": "Testing renamed description", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo." }, "resources": [], "subscriptionPeriods": [ { "value": { "trial": false, "periodType": "month", "refundType": "refund_prorated_recurring_fee", "period": 6, "fullRefundPeriod": 1, "renewalFee": 0, "recurringFee": 0, "depositFee": 0, "setupFee": 0, "transferFee": 0, "cancellationFeeType": "none", "cancellationFeeValue": "10", "msrpSetupFee": null, "msrpRecurringFee": null, "msrpRenewalFee": null, "msrpTransferFee": null, "isAutoRenewPeriod": true, "cancelationPolicies": null, "downsizePolicies": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "trial": false, "periodType": "month", "refundType": "no_refund", "period": 12, "fullRefundPeriod": 3, "renewalFee": 0, "recurringFee": 0, "depositFee": 0, "setupFee": 0, "transferFee": 0, "cancellationFeeType": "none", "cancellationFeeValue": "", "msrpSetupFee": null, "msrpRecurringFee": null, "msrpRenewalFee": null, "msrpTransferFee": null, "isAutoRenewPeriod": false, "cancelationPolicies": null, "downsizePolicies": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "trial": true, "periodType": "month", "refundType": "refund_prorated_recurring_fee", "period": 9, "fullRefundPeriod": 6, "renewalFee": 0, "recurringFee": 0, "depositFee": 0, "setupFee": 0, "transferFee": 0, "cancellationFeeType": "none", "cancellationFeeValue": "10", "msrpSetupFee": null, "msrpRecurringFee": null, "msrpRenewalFee": null, "msrpTransferFee": null, "isAutoRenewPeriod": false, "cancelationPolicies": null, "downsizePolicies": null }, "action": "ADD", "edit": false, "add": true } ], "planCategory": null, "salesCategories": [], "serviceTerms": "Default", "welcomeNotificationTemplate": "Welcome Email - Wedge Networks2", "expirationNotificationTemplate": "Subscription has Expired - Wedge Networks2", "notificationScheduleId": null, "termsConditions": [], "vendorId": 1, "vendorName": null, "isAvailableForSale": null, "cloneFrom": null, "delegatedServicePlans": [ { "value": { "name": { "en": "Teamleader EU (Monthly Plan)" }, "planBillingPeriod": null, "planBillingPeriodType": null, "pricePeriodType": null, "autoRenewType": null, "renewOrderInterval": null, "vendorTimezone": null, "billingModel": null, "serviceTemplateId": null, "serviceTemplateName": null, "description": null, "resources": [], "subscriptionPeriods": [], "planCategory": null, "salesCategories": [], "serviceTerms": null, "welcomeNotificationTemplate": null, "expirationNotificationTemplate": null, "notificationScheduleId": null, "termsConditions": [], "vendorId": 1000002, "vendorName": "MICHAEL Legros, Crona", "isAvailableForSale": null, "cloneFrom": null, "delegatedServicePlans": [], "isEnableVolumePricingModel": null, "ratingMode": null, "alignWithStatementDay": null, "isSalesOrderProrated": null, "isFirstPeriodForFree": null, "customStatementDay": null, "upgrades": [], "isPublished": null, "resellerGroups": [], "enName": "Teamleader EU (Monthly Plan)" }, "action": "EDIT", "edit": true, "add": false } ], "isEnableVolumePricingModel": true, "ratingMode": null, "alignWithStatementDay": null, "isSalesOrderProrated": null, "isFirstPeriodForFree": null, "customStatementDay": null, "upgrades": [ { "value": { "toServicePlanId": null, "toServicePlanName": "Teamleader EU (Yearly Plan)", "remainCurrentSubscriptionStartDate": true }, "action": "ADD", "edit": false, "add": true } ], "isPublished": null, "resellerGroups": [], "enName": "Teamleader EU (Monthly Plan)" }, "action": "EDIT", "edit": true, "add": false }, { "value": { "name": { "de": "Teamleader EU (Jahresplan)", "pt": "Teamleader EU (Yearly Plan)", "en": "Teamleader EU (Yearly Plan)", "it": "Teamleader EU (Yearly Plan)", "fr": "Teamleader EU (Yearly Plan)", "tr": "Teamleader EU (Yearly Plan)", "nl": "Teamleader EU (Yearly Plan)", "es": "Teamleader EU (Yearly Plan)" }, "planBillingPeriod": null, "planBillingPeriodType": null, "pricePeriodType": "month", "autoRenewType": null, "renewOrderInterval": null, "vendorTimezone": null, "billingModel": null, "serviceTemplateId": null, "serviceTemplateName": null, "description": { "de": "Der jährliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "en": "Testing renamed description", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo." }, "resources": [ { "value": { "name": { "en": "Teamleader EU: Teamleader - monthly billing" }, "description": null, "composite": false, "createPlanRatePeriods": false, "unitOfMeasure": "unit", "inCP": true, "published": null, "setupFee": null, "overFee": null, "rtID": null, "resourceType": { "name": { "en": "Teamleader EU: Teamleader - monthly billing" }, "resClass": "rc.saas.countedlenk", "actParams": null, "description": null }, "billingResourceID": null, "externalBillingResourceID": null, "max": 5000, "min": 1, "measurable": false, "instore": true, "recFee": null, "resourceCategory": { "id": 1, "name": { "de": "", "pt": "", "en": "Additional Resources", "it": "", "fr": "", "es": "", "nl": "", "tr": "" }, "description": { "de": "", "pt": "", "en": "Additional Resources", "it": "", "fr": "Additional Resources", "nl": "", "tr": "", "es": "" }, "parent": null, "taxCatId": "All products" }, "periods": [], "msrpSetupFee": null, "msrpRecurringFee": null, "msrpOveruseFee": null, "rfeeShowZeroPrice": false, "rfeePerUnit": false, "ofeeShowZeroPrice": false, "sfeePerUnit": false, "sfeeShowZeroPrice": false }, "action": "ADD", "edit": false, "add": true } ], "subscriptionPeriods": [ { "value": { "trial": true, "periodType": "year", "refundType": "no_refund", "period": 4, "fullRefundPeriod": 2, "renewalFee": 0, "recurringFee": 0, "depositFee": 0, "setupFee": 0, "transferFee": 0, "cancellationFeeType": "none", "cancellationFeeValue": "", "msrpSetupFee": null, "msrpRecurringFee": null, "msrpRenewalFee": null, "msrpTransferFee": null, "isAutoRenewPeriod": true, "cancelationPolicies": null, "downsizePolicies": null }, "action": "EDIT", "edit": true, "add": false } ], "planCategory": null, "salesCategories": [], "serviceTerms": "Default", "welcomeNotificationTemplate": "Welcome Email - Wedge Networks2", "expirationNotificationTemplate": "Subscription has Expired - Wedge Networks2", "notificationScheduleId": null, "termsConditions": [], "vendorId": 1, "vendorName": null, "isAvailableForSale": null, "cloneFrom": null, "delegatedServicePlans": [ { "value": { "name": { "en": "Teamleader EU (Yearly Plan)" }, "planBillingPeriod": null, "planBillingPeriodType": null, "pricePeriodType": null, "autoRenewType": null, "renewOrderInterval": null, "vendorTimezone": null, "billingModel": null, "serviceTemplateId": null, "serviceTemplateName": null, "description": null, "resources": [], "subscriptionPeriods": [], "planCategory": null, "salesCategories": [], "serviceTerms": null, "welcomeNotificationTemplate": null, "expirationNotificationTemplate": null, "notificationScheduleId": null, "termsConditions": [], "vendorId": 1000002, "vendorName": "MICHAEL Legros, Crona", "isAvailableForSale": null, "cloneFrom": null, "delegatedServicePlans": [], "isEnableVolumePricingModel": null, "ratingMode": null, "alignWithStatementDay": null, "isSalesOrderProrated": null, "isFirstPeriodForFree": null, "customStatementDay": null, "upgrades": [], "isPublished": null, "resellerGroups": [], "enName": "Teamleader EU (Yearly Plan)" }, "action": "EDIT", "edit": true, "add": false } ], "isEnableVolumePricingModel": true, "ratingMode": null, "alignWithStatementDay": null, "isSalesOrderProrated": null, "isFirstPeriodForFree": null, "customStatementDay": null, "upgrades": [ { "value": { "toServicePlanId": null, "toServicePlanName": "Teamleader EU (Yearly Plan 2)", "remainCurrentSubscriptionStartDate": false }, "action": "EDIT", "edit": true, "add": false } ], "isPublished": null, "resellerGroups": [], "enName": "Teamleader EU (Yearly Plan)" }, "action": "EDIT", "edit": true, "add": false } ], "termsConditionsDetails": { "Teamleader EU Additional Terms": { "id": -2147483648, "name": "Teamleader EU Additional Terms", "acceptType": "On first purchase and after every T&C change", "active": true, "text": "<p><strong>Additional Terms and Conditions for TeamleaderEU Subscriptions</strong></p>\n<p><strong> </strong></p>\n<p>The following additional terms and conditions apply to Your purchase of WedgeARP™ Secure Home Office (“Vendor”) subscriptions and to the use of such Services by You and Your customers.</p>\n<p> </p>\n<h2><a name=\"_Toc381085506\"></a><a name=\"_Toc342658188\"></a>1. Term and Termination</h2>\n<h2> </h2>\n<p><a name=\"_Toc294012771\"></a><a name=\"_Toc285537541\"></a>Services start once provisioned through the marketplace. You may cancel the Services through the marketplace so long as no Service commitments are active hereunder (i.e. You or one or more of Your customers are employing any active Services). <a name=\"_Toc362955805\"></a><a name=\"_Toc362955620\"></a>You may only terminate the Service if there are no existing term commitments for Services. If You or Your customer terminates its use of a Service prior to the expiration of the term commitment for the selected service, You will remain responsible to Ingram Micro for all remaining and accrued charges for such Service pursuant to the selected term commitment. </p>\n<p> </p>\n<p><a name=\"_Toc362955804\"></a><a name=\"_Toc362955619\"></a>Services are available for minimum commitment of one month. Services will auto renew for an additional month, unless You cancel the Services one (1) business days prior to the expiration of the term commitment for the selected Service.</p>\n<p> </p>\n<h2>2. Fees</h2>\n<h2> </h2>\n<p><a name=\"_Toc320601176\"></a><a name=\"_Toc329005647\"></a><a name=\"_Toc328553059\"></a><a name=\"_Toc328552976\"></a><a name=\"_Toc327868816\"></a><a name=\"_Toc320697822\"></a>You agree to pay the fees and charges for the Services as outlined in the registration process and that appear on the Site, as may be amended from time to time. If You or Your customer exceeds the usage limits applicable to the Service subscription, You agree to pay for the fees and charges for such over usage. For any extension of a subscription term or the provisioning of a Service upgrade, the then-current price will apply, unless otherwise mutually agreed in writing by You and Ingram Micro. Ingram Micro, may, from time to time in its sole discretion, change the fees it charges for the Service. Any increase in the fees will take effect at the beginning of the new subscription term. Ingram Micro will notify You of any such changes by updating the Site or sending notice by e-mail or regular mail.</p>\n<p> </p>\n<h2>3. Territory Restriction</h2>\n<p> </p>\n<p>You may only resell and/or market the Services in Canada.</p>\n<h2> </h2>\n<h2>4. Terms of Sale & Terms of Use</h2>\n<h2> </h2>\n<p><strong>All purchases are subject to the sales terms set forth at </strong><a href=\"https://ca.cloud.im/legal\"><strong>https://at.cloud.im/legal</strong></a><strong> and service setup information, including but not limited to pricing, (where applicable) set forth in the marketplace. </strong>For the avoidance of doubt, notwithstanding the presence or acceptance by Ingram Micro of Your order, such shall be for administrative purposes only and the parties agree that the governing terms and conditions shall be those set forth at <a href=\"https://at.cloud.im/legal\"><strong>https://at.cloud.im/legal</strong></a> unless otherwise agreed to in writing by Ingram Micro and You.</p>\n<h2> </h2>\n<p><strong>The Services are provided by the Vendor. All terms of use and/or service as established by the Vendor and as set forth at </strong><a href=\"https://wedgenetworks.com/eula.aspx\">https://wedgenetworks.com/eula.aspx</a></p>\n<p><strong>shall apply, as applicable, to Your resale activity and to You and Your customers’ use of the Services (“Terms of Use”). You covenant, represent and warrant that You will present the Terms of Use to each of Your customers and obtain their enforceable agreement to the Terms of Use before permitting them to access or use the Service. You covenant, represent and warrant that no subscription for the Services shall be activated for or used by Your customers before the customer agrees to the Terms of Use. </strong>You will track and record acceptance by Your customers of the Terms of Use and will provide such information to Ingram Micro upon request.</p>\n<p> </p>\n<p>Ingram Micro may at any time modify these terms and conditions. You and Your customers must regularly monitor the Site for any such modifications. The modified terms and conditions will be effective immediately after it is posted on the Site. Your purchase and resale of the Services and You and Your customers’ use of the Services after any such modification will be deemed acceptance of such modification.</p>" }, "Common": { "id": -2147483647, "name": "Common", "acceptType": "On first purchase and after every T&C change", "active": true, "text": "On first purchase and after every T&C change" } }, "subscriptionNotificationTemplates": [ { "name": "Welcome Email - Wedge Networks2", "locale": "en", "messageCategory": "RENEWAL_AND_EXPIRATION_NOTICES", "htmlText": "<title>Welcome Email - Wedge Networks2</title>", "plainText": "Welcome Email - Wedge Networks2", "subject": "Your account for @@Subscription_Name@ is ready!", "toAddress": "@@Cust_Account_BillingContact_Email@", "toName": "@@Cust_Account_CompanyName@", "bccAddress": "", "fromAddress": "@@Vend_Account_TechContact_Email@", "fromName": "@@Vend_Account_CompanyName@", "pdfAttachmentName": "", "active": true, "condition": "", "visibleToResellers": true, "secureBody": false }, { "name": "Welcome Email - Wedge Networks2", "locale": "fr", "messageCategory": "RENEWAL_AND_EXPIRATION_NOTICES", "htmlText": "<title>Welcome Email - Wedge Networks2 fr</title>", "plainText": "Welcome Email - Wedge Networks2 fr", "subject": "Votre compte @@ nom_souscription @ est prêt !", "toAddress": "@@Cust_Account_BillingContact_Email@", "toName": "@@Cust_Account_CompanyName@", "bccAddress": "", "fromAddress": "@@Vend_Account_TechContact_Email@", "fromName": "@@Vend_Account_CompanyName@", "pdfAttachmentName": "", "active": true, "condition": "", "visibleToResellers": true, "secureBody": false }, { "name": "Subscription has Expired - Wedge Networks2", "locale": "en", "messageCategory": "RENEWAL_AND_EXPIRATION_NOTICES", "htmlText": "<title>Subscription has Expired - Wedge Networks2</title>", "plainText": "Subscription has Expired - Wedge Networks2", "subject": "Subscription has expired", "toAddress": "@@Cust_Account_BillingContact_Email@", "toName": "@@Cust_Account_CompanyName@", "bccAddress": "", "fromAddress": "@@Vend_Account_TechContact_Email@", "fromName": "@@Vend_Account_CompanyName@", "pdfAttachmentName": "", "active": true, "condition": "", "visibleToResellers": true, "secureBody": false }, { "name": "Subscription has Expired - Wedge Networks2", "locale": "fr", "messageCategory": "RENEWAL_AND_EXPIRATION_NOTICES", "htmlText": "<title>Subscription has Expired - Wedge Networks2 fr</title>", "plainText": "Subscription has Expired - Wedge Networks2 fr", "subject": "L'abonnement a expiré", "toAddress": "@@Cust_Account_BillingContact_Email@", "toName": "@@Cust_Account_CompanyName@", "bccAddress": "", "fromAddress": "@@Vend_Account_TechContact_Email@", "fromName": "@@Vend_Account_CompanyName@", "pdfAttachmentName": "", "active": true, "condition": "", "visibleToResellers": true, "secureBody": false } ], "resourceDependencies": [ { "value": { "childResourceName": "Teamleader EU: Teamleader - monthly billing", "parentResourceName": "Teamleader EU: Teamleader - yearly billing", "dependenceKind": "CONFLICTS_ON_SUBSCRIPTION_LEVEL", "childResourceId": null, "parentResourceId": null, "dependenceMultiplier": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "childResourceName": "Teamleader EU: Teamleader - monthly billing", "parentResourceName": "Teamleader EU: Teamleader - yearly billing 2", "dependenceKind": "CONFLICTS_ON_ACCOUNT_LEVEL", "childResourceId": null, "parentResourceId": null, "dependenceMultiplier": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "childResourceName": "Teamleader EU: Teamleader - yearly billing", "parentResourceName": "Teamleader EU: Teamleader - yearly billing 2", "dependenceKind": "REQUIRES", "childResourceId": null, "parentResourceId": null, "dependenceMultiplier": null }, "action": "EDIT", "edit": true, "add": false } ] }, "appInfo": { "appId": null, "appCustomIconUrl": "/aps/2/applications/7047edc8-bcdb-4c42-9350-a2a0534c6200/aps/icon", "impersonationUid": "cdd11205-aa5e-4d43-9e6e-64e62f947fef" } }
Call the
applyConfigcustom operation of the PLM component’s APS application and pass theConfigurationInfoJSON object that you received in the previous step. To do that, make a request like this:POST /aps/2/resources/ca9685cb-d067-441b-b14d-146325aa2e53/applyConfig { "owner": { "accountId": 1, "memberId": 1 }, "serviceTemplateId": 9, "serviceTerms": { "0/0 Service Terms": { "bssId": 6, "serviceTermsName": "0/0 Service Terms", "holdPeriodInDays": 0, "gracePeriodInDays": 0 }, "Default": { "bssId": 0, "serviceTermsName": "Default", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "Domain Service Terms": { "bssId": 3, "serviceTermsName": "Domain Service Terms", "holdPeriodInDays": 0, "gracePeriodInDays": 30 }, "Hosting Service Terms": { "bssId": 2, "serviceTermsName": "Hosting Service Terms", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "In-House Products for Resellers": { "bssId": 4, "serviceTermsName": "In-House Products for Resellers", "holdPeriodInDays": 0, "gracePeriodInDays": 0 } }, "existingPdiPlans": { "teamleader eu (monthly plan)": { "aps": { "id": "01431d51-b012-4558-91b1-468f7326531d", "type": "http://com.odin.platform/inhouse-products/pdiPlan/1.0", "status": "aps:ready", "subscription": null, "revision": 2, "modified": 1649431014000, "schema": null, "package": null }, "products": null, "operatingUnits": null, "account": null, "productLine": null, "name": { "de_DE": "Teamleader EU (Monatsplan)", "en_US": "Teamleader EU (Monthly Plan)", "es_ES": "Teamleader EU (Monthly Plan)", "fr_FR": "Teamleader EU (Monthly Plan)", "it_IT": "Teamleader EU (Monthly Plan)", "nl_NL": "Teamleader EU (Monthly Plan)", "pt_BR": "Teamleader EU (Monthly Plan)", "pt_PT": "Teamleader EU (Monthly Plan)", "tr_TR": "Teamleader EU (Monthly Plan)" }, "description": { "de_DE": "Der monatliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "en_US": "The monthly service gives companies a majority of the same benefits that on-premises deployments provide.", "es_ES": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr_FR": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it_IT": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl_NL": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt_BR": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "pt_PT": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr_TR": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "bssServicePlanId": 12, "serviceTemplateId": 9, "isDefault": false, "customIconUrl": null, "billingPeriod": 3, "billingPeriodType": "psd", "pricePeriodType": "billing period", "planCategory": "Software & Licenses", "appId": null, "billingModel": "charge before billing period", "autoRenewType": "Before Expiration", "renewOrderInterval": 1, "vendorTimezone": null, "subscriptionPeriods": [ { "bssId": 16, "period": 6, "periodType": "month", "cancellationFeeType": "none", "cancellationFeeValue": "10", "afterRefundPeriod": "refund_prorated_recurring_fee", "fullRefundPeriod": 1, "cancelationPolicies": null, "downsizePolicies": null, "autoRenewPeriod": true, "trial": false }, { "bssId": 17, "period": 12, "periodType": "month", "cancellationFeeType": "none", "cancellationFeeValue": "", "afterRefundPeriod": "no_refund", "fullRefundPeriod": 3, "cancelationPolicies": null, "downsizePolicies": null, "autoRenewPeriod": false, "trial": false } ], "salesCategories": [ { "id": 10, "name": { "de": "TeamleaderEU", "en": "TeamleaderEU", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "Der Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten. Durch die Integration in den Cloud-Service können Unternehmen ihren Marktanteil ausbauen, wiederkehrende Umsätze automatisieren und steigern, die Kundenzufriedenheit steigern und gleichzeitig die Betriebskosten senken.", "en": "The service gives companies a majority of the same benefits that on-premises deployments provide. By integrating with the cloud service, companies can expand their market share, automate and grow recurring revenue, increase customer satisfaction, and cut operational costs at the same time.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "parent": { "id": 9, "name": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "parent": null, "expand": true, "inCCP": true }, "expand": true, "inCCP": true } ], "serviceTerms": { "bssId": 0, "serviceTermsName": "Default", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "termsAndConditions": [ { "id": null, "bssId": 7, "name": "Teamleader EU Additional Terms", "value": "Teamleader EU Additional Terms Content", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "On first purchase and after every T&C change" }, { "id": null, "bssId": 6, "name": "Common", "value": "Common", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "On first purchase and after every T&C change" }, { "id": null, "bssId": 4, "name": "Provider pre-existing TC", "value": "kp8CVlZAOc", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "Always, on every purchase" } ], "availableNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome e-mail - Business Class Mail" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "enabledNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome e-mail - Business Class Mail" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "servicePlanUpdateNotificationId": null, "alignWithStatementDay": true, "isSalesOrderProrated": true, "isFirstPeriodForFree": true, "customStatementDay": 2, "notificationScheduleId": 12, "resellerGroups": [], "volumePricingRatingMode": true, "ratingMode": "Revenue only", "default": false, "isOneTimeFeeProduct": false, "oneTimeFeePlan": false, "salesOrderProrated": true, "firstPeriodForFree": true, "published": true, "isPublished": true }, "teamleader eu (yearly plan 2)": { "aps": { "id": "7f80c0a3-301e-4b1d-9dd2-09af4719f456", "type": "http://com.odin.platform/inhouse-products/pdiPlan/1.0", "status": "aps:ready", "subscription": null, "revision": 2, "modified": 1649431015000, "schema": null, "package": null }, "products": null, "operatingUnits": null, "account": null, "productLine": null, "name": { "de_DE": "Teamleader EU (Jahresplan)", "en_US": "Teamleader EU (Yearly Plan 2)", "es_ES": "Teamleader EU (Yearly Plan 2)", "fr_FR": "Teamleader EU (Yearly Plan 2)", "it_IT": "Teamleader EU (Yearly Plan 2)", "nl_NL": "Teamleader EU (Yearly Plan 2)", "pt_BR": "Teamleader EU (Yearly Plan 2)", "pt_PT": "Teamleader EU (Yearly Plan 2)", "tr_TR": "Teamleader EU (Yearly Plan 2)" }, "description": { "de_DE": "Der jährliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "en_US": "The yearly service gives companies a majority of the same benefits that on-premises deployments provide.", "es_ES": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr_FR": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it_IT": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl_NL": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt_BR": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "pt_PT": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr_TR": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "bssServicePlanId": 14, "serviceTemplateId": 9, "isDefault": false, "customIconUrl": null, "billingPeriod": 12, "billingPeriodType": "psd", "pricePeriodType": "month", "planCategory": "Software & Licenses", "appId": null, "billingModel": "charge before billing period", "autoRenewType": "On Last Statement Day", "renewOrderInterval": 1, "vendorTimezone": null, "subscriptionPeriods": [ { "bssId": 19, "period": 5, "periodType": "year", "cancellationFeeType": "none", "cancellationFeeValue": "", "afterRefundPeriod": "no_refund", "fullRefundPeriod": 4, "cancelationPolicies": null, "downsizePolicies": null, "autoRenewPeriod": true, "trial": false } ], "salesCategories": [ { "id": 10, "name": { "de": "TeamleaderEU", "en": "TeamleaderEU", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "Der Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten. Durch die Integration in den Cloud-Service können Unternehmen ihren Marktanteil ausbauen, wiederkehrende Umsätze automatisieren und steigern, die Kundenzufriedenheit steigern und gleichzeitig die Betriebskosten senken.", "en": "The service gives companies a majority of the same benefits that on-premises deployments provide. By integrating with the cloud service, companies can expand their market share, automate and grow recurring revenue, increase customer satisfaction, and cut operational costs at the same time.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "parent": { "id": 9, "name": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "parent": null, "expand": true, "inCCP": true }, "expand": true, "inCCP": true } ], "serviceTerms": { "bssId": 0, "serviceTermsName": "Default", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "termsAndConditions": [ { "id": null, "bssId": 7, "name": "Teamleader EU Additional Terms", "value": "Teamleader EU Additional Terms Content", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "On first purchase and after every T&C change" } ], "availableNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome Email - Wedge Networks" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "enabledNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome Email - Wedge Networks" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "servicePlanUpdateNotificationId": null, "alignWithStatementDay": true, "isSalesOrderProrated": false, "isFirstPeriodForFree": false, "customStatementDay": 1, "notificationScheduleId": 12, "resellerGroups": [], "volumePricingRatingMode": false, "ratingMode": null, "default": false, "isOneTimeFeeProduct": false, "oneTimeFeePlan": false, "salesOrderProrated": false, "firstPeriodForFree": false, "published": true, "isPublished": true }, "teamleader eu (yearly plan)": { "aps": { "id": "6b52c392-82e4-44f4-b0b8-4abb7ca0b082", "type": "http://com.odin.platform/inhouse-products/pdiPlan/1.0", "status": "aps:ready", "subscription": null, "revision": 2, "modified": 1649431015000, "schema": null, "package": null }, "products": null, "operatingUnits": null, "account": null, "productLine": null, "name": { "de_DE": "Teamleader EU (Jahresplan)", "en_US": "Teamleader EU (Yearly Plan)", "es_ES": "Teamleader EU (Yearly Plan)", "fr_FR": "Teamleader EU (Yearly Plan)", "it_IT": "Teamleader EU (Yearly Plan)", "nl_NL": "Teamleader EU (Yearly Plan)", "pt_BR": "Teamleader EU (Yearly Plan)", "pt_PT": "Teamleader EU (Yearly Plan)", "tr_TR": "Teamleader EU (Yearly Plan)" }, "description": { "de_DE": "Der jährliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "en_US": "The yearly service gives companies a majority of the same benefits that on-premises deployments provide.", "es_ES": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr_FR": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it_IT": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl_NL": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt_BR": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "pt_PT": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr_TR": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "bssServicePlanId": 13, "serviceTemplateId": 9, "isDefault": false, "customIconUrl": null, "billingPeriod": 12, "billingPeriodType": "psd", "pricePeriodType": "month", "planCategory": "Software & Licenses", "appId": null, "billingModel": "charge before billing period", "autoRenewType": "On Last Statement Day", "renewOrderInterval": 1, "vendorTimezone": null, "subscriptionPeriods": [ { "bssId": 18, "period": 4, "periodType": "year", "cancellationFeeType": "none", "cancellationFeeValue": "", "afterRefundPeriod": "no_refund", "fullRefundPeriod": 2, "cancelationPolicies": null, "downsizePolicies": null, "autoRenewPeriod": true, "trial": true } ], "salesCategories": [ { "id": 10, "name": { "de": "TeamleaderEU", "en": "TeamleaderEU", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "Der Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten. Durch die Integration in den Cloud-Service können Unternehmen ihren Marktanteil ausbauen, wiederkehrende Umsätze automatisieren und steigern, die Kundenzufriedenheit steigern und gleichzeitig die Betriebskosten senken.", "en": "The service gives companies a majority of the same benefits that on-premises deployments provide. By integrating with the cloud service, companies can expand their market share, automate and grow recurring revenue, increase customer satisfaction, and cut operational costs at the same time.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir." }, "parent": { "id": 9, "name": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "description": { "de": "", "en": "Security", "es": "", "fr": "", "it": "", "nl": "", "pt": "", "tr": "" }, "parent": null, "expand": true, "inCCP": true }, "expand": true, "inCCP": true } ], "serviceTerms": { "bssId": 0, "serviceTermsName": "Default", "holdPeriodInDays": 30, "gracePeriodInDays": 10 }, "termsAndConditions": [ { "id": null, "bssId": 7, "name": "Teamleader EU Additional Terms", "value": "Teamleader EU Additional Terms Content", "isDeleted": false, "type": "plain_text", "ownerAccountId": 1, "acceptType": "On first purchase and after every T&C change" } ], "availableNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome Email - Wedge Networks" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "enabledNotifications": [ { "templateType": "welcome_email", "templateName": "Welcome Email - Wedge Networks" }, { "templateType": "expiration_email", "templateName": "Subscription has Expired - Wedge Networks" } ], "servicePlanUpdateNotificationId": null, "alignWithStatementDay": true, "isSalesOrderProrated": false, "isFirstPeriodForFree": false, "customStatementDay": 1, "notificationScheduleId": 12, "resellerGroups": [], "volumePricingRatingMode": false, "ratingMode": null, "default": false, "isOneTimeFeeProduct": false, "oneTimeFeePlan": false, "salesOrderProrated": false, "firstPeriodForFree": false, "published": true, "isPublished": true } }, "excelConfig": { "resources": [ { "value": { "resourceType": { "name": { "en": "Teamleader EU: Teamleader - monthly billing" }, "resClass": null, "actParams": null, "description": {} }, "resourceCategory": { "id": 1, "name": { "de": "", "pt": "", "en": "Additional Resources", "it": "", "fr": "", "es": "", "nl": "", "tr": "" }, "description": { "de": "", "pt": "", "en": "Additional Resources", "it": "", "fr": "Additional Resources", "nl": "", "tr": "", "es": "" }, "parent": null, "taxCatId": "All products" }, "uom": "unit", "measurable": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "resourceType": { "name": { "en": "Teamleader EU: Teamleader - yearly billing" }, "resClass": null, "actParams": null, "description": {} }, "resourceCategory": { "id": 11, "name": { "de": "", "pt": "", "en": "Other Resources", "it": "", "fr": "", "es": "", "nl": "", "tr": "" }, "description": { "de": "", "pt": "", "en": "Other Resources", "it": "", "fr": "Other Resources", "nl": "", "tr": "", "es": "" }, "parent": { "id": 5, "name": { "en": "Other Products" }, "description": null, "parent": null, "taxCatId": null }, "taxCatId": "All products" }, "uom": "unit", "measurable": null }, "action": "EDIT", "edit": true, "add": false } ], "serviceTemplates": [], "servicePlans": [ { "value": { "name": { "de": "Teamleader EU (Monatsplan)", "pt": "Teamleader EU (Monthly Plan)", "en": "Teamleader EU (Monthly Plan)", "it": "Teamleader EU (Monthly Plan)", "fr": "Teamleader EU (Monthly Plan)", "tr": "Teamleader EU (Monthly Plan)", "nl": "Teamleader EU (Monthly Plan)", "es": "Teamleader EU (Monthly Plan)" }, "planBillingPeriod": null, "planBillingPeriodType": null, "pricePeriodType": "billing period", "autoRenewType": null, "renewOrderInterval": null, "vendorTimezone": null, "billingModel": null, "serviceTemplateId": null, "serviceTemplateName": null, "description": { "de": "Der monatliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "en": "Testing renamed description", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo." }, "resources": [], "subscriptionPeriods": [ { "value": { "trial": false, "periodType": "month", "refundType": "refund_prorated_recurring_fee", "period": 6, "fullRefundPeriod": 1, "renewalFee": 0, "recurringFee": 0, "depositFee": 0, "setupFee": 0, "transferFee": 0, "cancellationFeeType": "none", "cancellationFeeValue": "10", "msrpSetupFee": null, "msrpRecurringFee": null, "msrpRenewalFee": null, "msrpTransferFee": null, "isAutoRenewPeriod": true, "cancelationPolicies": null, "downsizePolicies": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "trial": false, "periodType": "month", "refundType": "no_refund", "period": 12, "fullRefundPeriod": 3, "renewalFee": 0, "recurringFee": 0, "depositFee": 0, "setupFee": 0, "transferFee": 0, "cancellationFeeType": "none", "cancellationFeeValue": "", "msrpSetupFee": null, "msrpRecurringFee": null, "msrpRenewalFee": null, "msrpTransferFee": null, "isAutoRenewPeriod": false, "cancelationPolicies": null, "downsizePolicies": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "trial": true, "periodType": "month", "refundType": "refund_prorated_recurring_fee", "period": 9, "fullRefundPeriod": 6, "renewalFee": 0, "recurringFee": 0, "depositFee": 0, "setupFee": 0, "transferFee": 0, "cancellationFeeType": "none", "cancellationFeeValue": "10", "msrpSetupFee": null, "msrpRecurringFee": null, "msrpRenewalFee": null, "msrpTransferFee": null, "isAutoRenewPeriod": false, "cancelationPolicies": null, "downsizePolicies": null }, "action": "ADD", "edit": false, "add": true } ], "planCategory": null, "salesCategories": [], "serviceTerms": "Default", "welcomeNotificationTemplate": "Welcome Email - Wedge Networks2", "expirationNotificationTemplate": "Subscription has Expired - Wedge Networks2", "notificationScheduleId": null, "termsConditions": [], "vendorId": 1, "vendorName": null, "isAvailableForSale": null, "cloneFrom": null, "delegatedServicePlans": [ { "value": { "name": { "en": "Teamleader EU (Monthly Plan)" }, "planBillingPeriod": null, "planBillingPeriodType": null, "pricePeriodType": null, "autoRenewType": null, "renewOrderInterval": null, "vendorTimezone": null, "billingModel": null, "serviceTemplateId": null, "serviceTemplateName": null, "description": null, "resources": [], "subscriptionPeriods": [], "planCategory": null, "salesCategories": [], "serviceTerms": null, "welcomeNotificationTemplate": null, "expirationNotificationTemplate": null, "notificationScheduleId": null, "termsConditions": [], "vendorId": 1000002, "vendorName": "MICHAEL Legros, Crona", "isAvailableForSale": null, "cloneFrom": null, "delegatedServicePlans": [], "isEnableVolumePricingModel": null, "ratingMode": null, "alignWithStatementDay": null, "isSalesOrderProrated": null, "isFirstPeriodForFree": null, "customStatementDay": null, "upgrades": [], "isPublished": null, "resellerGroups": [], "enName": "Teamleader EU (Monthly Plan)" }, "action": "EDIT", "edit": true, "add": false } ], "isEnableVolumePricingModel": true, "ratingMode": null, "alignWithStatementDay": null, "isSalesOrderProrated": null, "isFirstPeriodForFree": null, "customStatementDay": null, "upgrades": [ { "value": { "toServicePlanId": null, "toServicePlanName": "Teamleader EU (Yearly Plan)", "remainCurrentSubscriptionStartDate": true }, "action": "ADD", "edit": false, "add": true } ], "isPublished": null, "resellerGroups": [], "enName": "Teamleader EU (Monthly Plan)" }, "action": "EDIT", "edit": true, "add": false }, { "value": { "name": { "de": "Teamleader EU (Jahresplan)", "pt": "Teamleader EU (Yearly Plan)", "en": "Teamleader EU (Yearly Plan)", "it": "Teamleader EU (Yearly Plan)", "fr": "Teamleader EU (Yearly Plan)", "tr": "Teamleader EU (Yearly Plan)", "nl": "Teamleader EU (Yearly Plan)", "es": "Teamleader EU (Yearly Plan)" }, "planBillingPeriod": null, "planBillingPeriodType": null, "pricePeriodType": "month", "autoRenewType": null, "renewOrderInterval": null, "vendorTimezone": null, "billingModel": null, "serviceTemplateId": null, "serviceTemplateName": null, "description": { "de": "Der jährliche Service bietet Unternehmen die meisten Vorteile, die lokale Bereitstellungen bieten.", "pt": "O serviço oferece às empresas a maioria dos mesmos benefícios que as implantações locais fornecem. Ao integrar-se ao serviço de nuvem, as empresas podem expandir sua participação no mercado, automatizar e aumentar a receita recorrente, aumentar a satisfação do cliente e cortar custos operacionais ao mesmo tempo.", "en": "Testing renamed description", "it": "Il servizio offre alle aziende la maggior parte degli stessi vantaggi offerti dalle distribuzioni locali. Integrandosi con il servizio cloud, le aziende possono espandere la propria quota di mercato, automatizzare e aumentare i ricavi ricorrenti, aumentare la soddisfazione dei clienti e ridurre i costi operativi allo stesso tempo.", "fr": "Le service offre aux entreprises la majorité des mêmes avantages que les déploiements sur site. En s'intégrant au service cloud, les entreprises peuvent accroître leur part de marché, automatiser et augmenter les revenus récurrents, augmenter la satisfaction client et réduire les coûts d'exploitation en même temps.", "tr": "Hizmet, şirket içi dağıtımların sağladığı faydaların çoğunu şirketlere verir. Bulut hizmetine entegre olarak, şirketler pazar paylarını artırabilir, yinelenen geliri otomatikleştirip büyütebilir, müşteri memnuniyetini artırabilir ve aynı zamanda operasyonel maliyetleri azaltabilir.", "nl": "De service biedt bedrijven een meerderheid van dezelfde voordelen die on-premises implementaties bieden. Door te integreren met de cloudservice kunnen bedrijven hun marktaandeel vergroten, terugkerende inkomsten automatiseren en laten groeien, de klanttevredenheid verhogen en tegelijkertijd de operationele kosten verlagen.", "es": "El servicio brinda a las empresas la mayoría de los mismos beneficios que brindan las implementaciones locales. Al integrarse con el servicio en la nube, las empresas pueden ampliar su participación en el mercado, automatizar y aumentar los ingresos recurrentes, aumentar la satisfacción del cliente y reducir los costos operativos al mismo tiempo." }, "resources": [ { "value": { "name": { "en": "Teamleader EU: Teamleader - monthly billing" }, "description": null, "composite": false, "createPlanRatePeriods": false, "unitOfMeasure": "unit", "inCP": true, "published": null, "setupFee": null, "overFee": null, "rtID": null, "resourceType": { "name": { "en": "Teamleader EU: Teamleader - monthly billing" }, "resClass": "rc.saas.countedlenk", "actParams": null, "description": null }, "billingResourceID": null, "externalBillingResourceID": null, "max": 5000, "min": 1, "measurable": false, "instore": true, "recFee": null, "resourceCategory": { "id": 1, "name": { "de": "", "pt": "", "en": "Additional Resources", "it": "", "fr": "", "es": "", "nl": "", "tr": "" }, "description": { "de": "", "pt": "", "en": "Additional Resources", "it": "", "fr": "Additional Resources", "nl": "", "tr": "", "es": "" }, "parent": null, "taxCatId": "All products" }, "periods": [], "msrpSetupFee": null, "msrpRecurringFee": null, "msrpOveruseFee": null, "rfeeShowZeroPrice": false, "rfeePerUnit": false, "ofeeShowZeroPrice": false, "sfeePerUnit": false, "sfeeShowZeroPrice": false }, "action": "ADD", "edit": false, "add": true } ], "subscriptionPeriods": [ { "value": { "trial": true, "periodType": "year", "refundType": "no_refund", "period": 4, "fullRefundPeriod": 2, "renewalFee": 0, "recurringFee": 0, "depositFee": 0, "setupFee": 0, "transferFee": 0, "cancellationFeeType": "none", "cancellationFeeValue": "", "msrpSetupFee": null, "msrpRecurringFee": null, "msrpRenewalFee": null, "msrpTransferFee": null, "isAutoRenewPeriod": true, "cancelationPolicies": null, "downsizePolicies": null }, "action": "EDIT", "edit": true, "add": false } ], "planCategory": null, "salesCategories": [], "serviceTerms": "Default", "welcomeNotificationTemplate": "Welcome Email - Wedge Networks2", "expirationNotificationTemplate": "Subscription has Expired - Wedge Networks2", "notificationScheduleId": null, "termsConditions": [], "vendorId": 1, "vendorName": null, "isAvailableForSale": null, "cloneFrom": null, "delegatedServicePlans": [ { "value": { "name": { "en": "Teamleader EU (Yearly Plan)" }, "planBillingPeriod": null, "planBillingPeriodType": null, "pricePeriodType": null, "autoRenewType": null, "renewOrderInterval": null, "vendorTimezone": null, "billingModel": null, "serviceTemplateId": null, "serviceTemplateName": null, "description": null, "resources": [], "subscriptionPeriods": [], "planCategory": null, "salesCategories": [], "serviceTerms": null, "welcomeNotificationTemplate": null, "expirationNotificationTemplate": null, "notificationScheduleId": null, "termsConditions": [], "vendorId": 1000002, "vendorName": "MICHAEL Legros, Crona", "isAvailableForSale": null, "cloneFrom": null, "delegatedServicePlans": [], "isEnableVolumePricingModel": null, "ratingMode": null, "alignWithStatementDay": null, "isSalesOrderProrated": null, "isFirstPeriodForFree": null, "customStatementDay": null, "upgrades": [], "isPublished": null, "resellerGroups": [], "enName": "Teamleader EU (Yearly Plan)" }, "action": "EDIT", "edit": true, "add": false } ], "isEnableVolumePricingModel": true, "ratingMode": null, "alignWithStatementDay": null, "isSalesOrderProrated": null, "isFirstPeriodForFree": null, "customStatementDay": null, "upgrades": [ { "value": { "toServicePlanId": null, "toServicePlanName": "Teamleader EU (Yearly Plan 2)", "remainCurrentSubscriptionStartDate": false }, "action": "EDIT", "edit": true, "add": false } ], "isPublished": null, "resellerGroups": [], "enName": "Teamleader EU (Yearly Plan)" }, "action": "EDIT", "edit": true, "add": false } ], "termsConditionsDetails": { "Teamleader EU Additional Terms": { "id": -2147483648, "name": "Teamleader EU Additional Terms", "acceptType": "On first purchase and after every T&C change", "active": true, "text": "<p><strong>Additional Terms and Conditions for TeamleaderEU Subscriptions</strong></p>\n<p><strong> </strong></p>\n<p>The following additional terms and conditions apply to Your purchase of WedgeARP™ Secure Home Office (“Vendor”) subscriptions and to the use of such Services by You and Your customers.</p>\n<p> </p>\n<h2><a name=\"_Toc381085506\"></a><a name=\"_Toc342658188\"></a>1. Term and Termination</h2>\n<h2> </h2>\n<p><a name=\"_Toc294012771\"></a><a name=\"_Toc285537541\"></a>Services start once provisioned through the marketplace. You may cancel the Services through the marketplace so long as no Service commitments are active hereunder (i.e. You or one or more of Your customers are employing any active Services). <a name=\"_Toc362955805\"></a><a name=\"_Toc362955620\"></a>You may only terminate the Service if there are no existing term commitments for Services. If You or Your customer terminates its use of a Service prior to the expiration of the term commitment for the selected service, You will remain responsible to Ingram Micro for all remaining and accrued charges for such Service pursuant to the selected term commitment. </p>\n<p> </p>\n<p><a name=\"_Toc362955804\"></a><a name=\"_Toc362955619\"></a>Services are available for minimum commitment of one month. Services will auto renew for an additional month, unless You cancel the Services one (1) business days prior to the expiration of the term commitment for the selected Service.</p>\n<p> </p>\n<h2>2. Fees</h2>\n<h2> </h2>\n<p><a name=\"_Toc320601176\"></a><a name=\"_Toc329005647\"></a><a name=\"_Toc328553059\"></a><a name=\"_Toc328552976\"></a><a name=\"_Toc327868816\"></a><a name=\"_Toc320697822\"></a>You agree to pay the fees and charges for the Services as outlined in the registration process and that appear on the Site, as may be amended from time to time. If You or Your customer exceeds the usage limits applicable to the Service subscription, You agree to pay for the fees and charges for such over usage. For any extension of a subscription term or the provisioning of a Service upgrade, the then-current price will apply, unless otherwise mutually agreed in writing by You and Ingram Micro. Ingram Micro, may, from time to time in its sole discretion, change the fees it charges for the Service. Any increase in the fees will take effect at the beginning of the new subscription term. Ingram Micro will notify You of any such changes by updating the Site or sending notice by e-mail or regular mail.</p>\n<p> </p>\n<h2>3. Territory Restriction</h2>\n<p> </p>\n<p>You may only resell and/or market the Services in Canada.</p>\n<h2> </h2>\n<h2>4. Terms of Sale & Terms of Use</h2>\n<h2> </h2>\n<p><strong>All purchases are subject to the sales terms set forth at </strong><a href=\"https://ca.cloud.im/legal\"><strong>https://at.cloud.im/legal</strong></a><strong> and service setup information, including but not limited to pricing, (where applicable) set forth in the marketplace. </strong>For the avoidance of doubt, notwithstanding the presence or acceptance by Ingram Micro of Your order, such shall be for administrative purposes only and the parties agree that the governing terms and conditions shall be those set forth at <a href=\"https://at.cloud.im/legal\"><strong>https://at.cloud.im/legal</strong></a> unless otherwise agreed to in writing by Ingram Micro and You.</p>\n<h2> </h2>\n<p><strong>The Services are provided by the Vendor. All terms of use and/or service as established by the Vendor and as set forth at </strong><a href=\"https://wedgenetworks.com/eula.aspx\">https://wedgenetworks.com/eula.aspx</a></p>\n<p><strong>shall apply, as applicable, to Your resale activity and to You and Your customers’ use of the Services (“Terms of Use”). You covenant, represent and warrant that You will present the Terms of Use to each of Your customers and obtain their enforceable agreement to the Terms of Use before permitting them to access or use the Service. You covenant, represent and warrant that no subscription for the Services shall be activated for or used by Your customers before the customer agrees to the Terms of Use. </strong>You will track and record acceptance by Your customers of the Terms of Use and will provide such information to Ingram Micro upon request.</p>\n<p> </p>\n<p>Ingram Micro may at any time modify these terms and conditions. You and Your customers must regularly monitor the Site for any such modifications. The modified terms and conditions will be effective immediately after it is posted on the Site. Your purchase and resale of the Services and You and Your customers’ use of the Services after any such modification will be deemed acceptance of such modification.</p>" }, "Common": { "id": -2147483647, "name": "Common", "acceptType": "On first purchase and after every T&C change", "active": true, "text": "On first purchase and after every T&C change" } }, "subscriptionNotificationTemplates": [ { "name": "Welcome Email - Wedge Networks2", "locale": "en", "messageCategory": "RENEWAL_AND_EXPIRATION_NOTICES", "htmlText": "<title>Welcome Email - Wedge Networks2</title>", "plainText": "Welcome Email - Wedge Networks2", "subject": "Your account for @@Subscription_Name@ is ready!", "toAddress": "@@Cust_Account_BillingContact_Email@", "toName": "@@Cust_Account_CompanyName@", "bccAddress": "", "fromAddress": "@@Vend_Account_TechContact_Email@", "fromName": "@@Vend_Account_CompanyName@", "pdfAttachmentName": "", "active": true, "condition": "", "visibleToResellers": true, "secureBody": false }, { "name": "Welcome Email - Wedge Networks2", "locale": "fr", "messageCategory": "RENEWAL_AND_EXPIRATION_NOTICES", "htmlText": "<title>Welcome Email - Wedge Networks2 fr</title>", "plainText": "Welcome Email - Wedge Networks2 fr", "subject": "Votre compte @@ nom_souscription @ est prêt !", "toAddress": "@@Cust_Account_BillingContact_Email@", "toName": "@@Cust_Account_CompanyName@", "bccAddress": "", "fromAddress": "@@Vend_Account_TechContact_Email@", "fromName": "@@Vend_Account_CompanyName@", "pdfAttachmentName": "", "active": true, "condition": "", "visibleToResellers": true, "secureBody": false }, { "name": "Subscription has Expired - Wedge Networks2", "locale": "en", "messageCategory": "RENEWAL_AND_EXPIRATION_NOTICES", "htmlText": "<title>Subscription has Expired - Wedge Networks2</title>", "plainText": "Subscription has Expired - Wedge Networks2", "subject": "Subscription has expired", "toAddress": "@@Cust_Account_BillingContact_Email@", "toName": "@@Cust_Account_CompanyName@", "bccAddress": "", "fromAddress": "@@Vend_Account_TechContact_Email@", "fromName": "@@Vend_Account_CompanyName@", "pdfAttachmentName": "", "active": true, "condition": "", "visibleToResellers": true, "secureBody": false }, { "name": "Subscription has Expired - Wedge Networks2", "locale": "fr", "messageCategory": "RENEWAL_AND_EXPIRATION_NOTICES", "htmlText": "<title>Subscription has Expired - Wedge Networks2 fr</title>", "plainText": "Subscription has Expired - Wedge Networks2 fr", "subject": "L'abonnement a expiré", "toAddress": "@@Cust_Account_BillingContact_Email@", "toName": "@@Cust_Account_CompanyName@", "bccAddress": "", "fromAddress": "@@Vend_Account_TechContact_Email@", "fromName": "@@Vend_Account_CompanyName@", "pdfAttachmentName": "", "active": true, "condition": "", "visibleToResellers": true, "secureBody": false } ], "resourceDependencies": [ { "value": { "childResourceName": "Teamleader EU: Teamleader - monthly billing", "parentResourceName": "Teamleader EU: Teamleader - yearly billing", "dependenceKind": "CONFLICTS_ON_SUBSCRIPTION_LEVEL", "childResourceId": null, "parentResourceId": null, "dependenceMultiplier": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "childResourceName": "Teamleader EU: Teamleader - monthly billing", "parentResourceName": "Teamleader EU: Teamleader - yearly billing 2", "dependenceKind": "CONFLICTS_ON_ACCOUNT_LEVEL", "childResourceId": null, "parentResourceId": null, "dependenceMultiplier": null }, "action": "EDIT", "edit": true, "add": false }, { "value": { "childResourceName": "Teamleader EU: Teamleader - yearly billing", "parentResourceName": "Teamleader EU: Teamleader - yearly billing 2", "dependenceKind": "REQUIRES", "childResourceId": null, "parentResourceId": null, "dependenceMultiplier": null }, "action": "EDIT", "edit": true, "add": false } ] }, "appInfo": { "appId": null, "appCustomIconUrl": "/aps/2/applications/7047edc8-bcdb-4c42-9350-a2a0534c6200/aps/icon", "impersonationUid": "cdd11205-aa5e-4d43-9e6e-64e62f947fef" } }
As a result, you will receive HTTP status code 202.
Obtaining Notification Templates¶
To obtain a list of notification templates used by PLM, make a request like this:
GET /aps/2/resources?implementing(http://com.odin.platform/inhouse-products/notificationTemplate/1.0)
As a result, you will receive a response like this:
HTTP/1.1 200 OK
[
{
"content": "...",
"templateName": "Welcome e-mail - other products",
"templateType": "welcome_email",
"aps": {
"modified": "2022-04-21T07:13:16Z",
"id": "b22b0399-cfe7-433b-b128-ede173887b52",
"type": "http://com.odin.platform/inhouse-products/notificationTemplate/1.0",
"status": "aps:ready",
"revision": 3
}
},
{
"content": "...",
"templateName": "Subscription has Expired - other products",
"templateType": "expiration_email",
"aps": {
"modified": "2022-04-21T07:13:16Z",
"id": "526d8c2e-5910-4c05-8828-2c763c60d2c0",
"type": "http://com.odin.platform/inhouse-products/notificationTemplate/1.0",
"status": "aps:ready",
"revision": 3
}
}
]