Validate a subscription for migration

Article
10/13/2023

Applies to: Partner Center | Partner Center operated by 21Vianet | Partner Center for Microsoft Cloud for US Government

How to validate a subscription for migration to New Commerce Experience

Prerequisites

Credentials as described in Partner Center authentication. This scenario supports authentication with both standalone App and App+User credentials.
A customer ID (customer-tenant-id). If you don't know the customer's ID, you can look it up in Partner Center by selecting the Customers workspace, then the customer from the customer list, then Account. On the customer’s Account page, look for the Microsoft ID in the Customer Account Info section. The Microsoft ID is the same as the customer ID (customer-tenant-id).
A current subscription ID

Rate limit

The Validate Migration API limit is 450 calls per partner-customer combination in 5 minutes. More information about rate limits and throttling is available at API throttling guidance.

REST request

Request syntax

Method	Request URI
POST	{baseURL}/v1/customers/{customer-tenant-id}/migrations/newcommerce/validate HTTP/1.1

URI parameter

This table lists the required query parameters to validate a subscription for migration.

Name	Type	Required	Description
customer-tenant-id	string	Yes	A GUID-formatted string that identifies the customer.
termDuration	string	No	Term duration can be changed upon migration.
billingCycle	string	No	Billing cycle can be changed upon migration.
purchaseFullTerm	bool	No	A new term can be started in NCE upon migration.
quantity	int	No	License quantity for a subscription can be increased or decreased upon migration.
customTermEndDate	datetime	No	An end-date can be set to align with an existing nontrial OnlineServicesNCE subscription or calendar month. There is more information on aligning subscription end dates here: Align subscription end dates in Partner Center

Request headers

For more information, see Partner Center REST headers.

Request body

This table describes the Subscription properties in the request body.

Property	Type	Required	Description
currentSubscriptionId	string	Yes	A subscription identifier that indicates which subscription requires validation for migration.

Request example

"currentSubscriptionId" : "9beb6319-6889-4d28-a155-68ca9c783842"

REST response

If successful, this method returns an "isEligible" boolean in the response body, indicating if the current subscription is eligible for migration to new commerce. Note, the Validate Migration API does not provide information regarding a subscription's eligibility for promotions in New Commerce.

Response success and error codes

Each response comes with an HTTP status code that indicates success or failure and extral debugging information. Use a network trace tool to read this code, error type, and other parameters. For the full list, see Partner Center REST error codes.

Response examples

1. 
    {
        "currentSubscriptionId": "9beb6319-6889-4d28-a155-68ca9c783842",
        "isEligible": false,
        "errors": [
            {
                "code": 5,
                "description": "Subscription cannot be migrated to New Commerce because the equivalent offer is not yet available in New Commerce",
            }
        ]
    }

2. 
    {
        "currentSubscriptionId": "9beb6319-6889-4d28-a155-68ca9c783842",
        "isEligible": true,
        "catalogItemId": "CFQ7TTC0LF8S:0002:CFQ7TTC0KSVV"
    }