Manage orders - Convert a trial subscription to paid

Service:

Partner Center Rest

API Version:

v1

Converts a trial subscription to the target conversion.

POST https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptions/{subscription_id}/conversions

URI Parameters

Name	In	Required	Type	Description
customer_id	path	True	string	The customer id.
subscription_id	path	True	string	The subscription id.
version	path	True	string

Request Header

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name	Required	Type	Description
Authorization	True	string	Authorization Bearer token
ms-correlationid		string	Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
ms-cv		string	Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request
ms-requestid		string	Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Request Body

Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
billingCycle	enum: unknown monthly annual none one_time triennial
offerId	string
orderId	string
quantity	integer
targetOfferId	string

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Services.Subscriptions.V1.Models.ConversionResult	The request was successful. Convert result is returned in the response body. Media Types: "application/json", "text/json", "application/xml", "text/xml"
400 Bad Request		There was a missing or an invalid input. The response body will provide the error details. Media Types: "application/json", "text/json", "application/xml", "text/xml"
401 Unauthorized		The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "text/json", "application/xml", "text/xml"
403 Forbidden		The request was authenticated but was refused since the caller does not have the rights to invoke it. Media Types: "application/json", "text/json", "application/xml", "text/xml"
404 Not Found		The resource is not found or not available with the given input parameters. Media Types: "application/json", "text/json", "application/xml", "text/xml"
500 Internal Server Error		The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name	Description
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Services.Subscriptions.V1.Models.Conversion
Microsoft.Partner.Services.Subscriptions.V1.Models.ConversionError
Microsoft.Partner.Services.Subscriptions.V1.Models.ConversionResult

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

Microsoft.Partner.Services.Subscriptions.V1.Models.Conversion

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
billingCycle	enum: annual monthly none one_time triennial unknown
offerId	string
orderId	string
quantity	integer
targetOfferId	string

Microsoft.Partner.Services.Subscriptions.V1.Models.ConversionError

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
code	enum: 0 1
description	string

Microsoft.Partner.Services.Subscriptions.V1.Models.ConversionResult

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
error	Microsoft.Partner.Services.Subscriptions.V1.Models.ConversionError
offerId	string
subscriptionId	string
targetOfferId	string