Parameter Required to Migrate CSP Legacy Subscriptions to NCE Subscriptions
Note: Refer to CloudBlue Commerce API documentation for additional information on how to manage orders through the platform's API.
When making the request to migrate CSP legacy subscriptions to NCE, please ensure that the new order is placed for an NCE plan that is equivalent to the CSP plan to be migrated. The transaction_info_object parameter provides information of the transaction to be processed. The specific data to be provided in JSON format will depend on the transaction type. The request for the migration must contain parameters both for the base products and the add-ons.
Note: Add-ons can be now migrated independently (without migrating the base product). To do this, the add-on subscription ID must be specified in the corresponding subscription_id field. When doing this, it is also possible to migrate add-ons to the add-on specified in such field by adding the corresponding add-on subscription ID in the subscription_id fields available within the addons object.
| Parameter ID | Required | JSON structure with the following parameters: | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| transaction_info_object | Yes |
|
||||||||||||||||
| microsoft_domain | Yes | The Microsoft domain of the subscription to be migrated, including ".onmicrosoft.com". For example: mycompanyDomain.onmicrosoft.com. |
||||||||||||||||
| transaction_id | Yes | The transaction id must be the same as the one used for add-ons (see below). | ||||||||||||||||
| migration_type | No | This parameter is used by the migration tools and it stores a value containing the type of migration as agreed with the Vendor. This parameter is not mandatory, but it is nice to have in cases when reports are generated. | ||||||||||||||||
Additionally, for each add-on, additional parameters are used in order to align orders in Connect with those in Microsoft:
| Parameter ID | Required | |||||||
|---|---|---|---|---|---|---|---|---|
| transaction_info_object | Yes |
|
||||||
| microsoft_domain | Yes | The Microsoft domain of the subscription to be migrated, including ".onmicrosoft.com". For example: mycompanyDomain.onmicrosoft.com. |
||||||
| transaction_id | Yes | The transaction id for the addon must be the same as the one used for the base product. | ||||||
Example of parameters to migrate a base subscription and the corresponding add-ons:
{
{
"key": "transaction_info_object",
"structured_value":
{
"transaction_type": "NCEmigration",
"ms_customer_id": "MSFT customer id",
"csp_order_id": "MSFT CSP source order id",
"subscription_id": "MSFT source Base/Add-on subscription ID",
"purchaseFullTerm": true/false
"addons": [
{
"subscription_id": "MSFT Add-on subscription ID",
"termDuration":"New TermDuration",
"billingCycle":"New BillingCycle",
"purchaseFullTerm": true/false
},
{
"subscription_id": "MSFT Add-on subscription ID",
"termDuration":"New TermDuration",
"billingCycle":"New billingCycle",
"purchaseFullTerm": true/false
}
]
}
},
{
"key": "microsoft_domain",
"value": "mybusiness.onmicrosoft.com"
},
{
"key": "transaction_id",
"value": "123345" *---------------------------the same transaction ID to be sent in addons requests*
}
}Example of the parameters to be used for each addon:
{
{
"key": "transaction_info_object",
"structured_value":
{
"transaction_type": "NCEmigrationAddon"
}
},
{
"key": "microsoft_domain",
"value": "mybusiness.onmicrosoft.com"
},
{
"key": "transaction_id",
"value": "123345"* ------------------------the same transaction ID as the parent*
}
}