Manage orders - Get upgrades for a subscription

Service:

Partner Center Rest

API Version:

v1

Gets the upgrades for a subscription.

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

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

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

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Upgrade]	The request was successful. The response body contains the upgrades. Media Types: "application/json", "text/json"
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"
401 Unauthorized		The request was not authenticated. The client needs to authenticate with the partner API service first. Media Types: "application/json", "text/json"
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"
404 Not Found		The resource is not found or not available with the given input parameters. Media Types: "application/json", "text/json"
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"

Definitions

Name	Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Upgrade]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Providers.Catalog.V1.Models.Offer
Microsoft.Partner.Providers.Catalog.V1.Models.OfferCategory
Microsoft.Partner.Providers.Catalog.V1.Models.OfferLinks
Microsoft.Partner.Providers.Catalog.V1.Models.OfferProduct
Microsoft.Partner.Services.Subscriptions.V1.Models.Upgrade
Microsoft.Partner.Services.Subscriptions.V1.Models.UpgradeError
SupportedBillingCycles
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Core.Collections.Link

Name	Type	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Upgrade]

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Services.Subscriptions.V1.Models.Upgrade[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Name	Type	Description
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Providers.Catalog.V1.Models.Offer

Name	Type	Description
acquisitionType	string
actions	string[]
additionalProperties	object
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
billing	string
category	Microsoft.Partner.Providers.Catalog.V1.Models.OfferCategory
conversionTargetOffers	string[]
description	string
hasAddOns	boolean
id	string
isAutoRenewable	boolean
isAvailableForPurchase	boolean
isInternal	boolean
isMicrosoftProduct	boolean
isTrial	boolean
links	Microsoft.Partner.Providers.Catalog.V1.Models.OfferLinks
maximumQuantity	integer
minimumQuantity	integer
name	string
product	Microsoft.Partner.Providers.Catalog.V1.Models.OfferProduct
reselleeQualifications	string[]
resellerQualifications	string[]
salesGroupId	string
supportedBillingCycles	SupportedBillingCycles[]
supportedCatalogTypes	string[]
term	integer
termUnitOfMeasure	string
unitType	string
upgradeTargetOffers	string[]
uri	string

Microsoft.Partner.Providers.Catalog.V1.Models.OfferCategory

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
country	string
id	string
links	Microsoft.Partner.Core.Collections.ResourceLinks
locale	string
name	string
rank	integer

Microsoft.Partner.Providers.Catalog.V1.Models.OfferLinks

Name	Type	Description
learnMore	Microsoft.Partner.Core.Collections.Link
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Providers.Catalog.V1.Models.OfferProduct

Name	Type	Description
id	string
name	string
unit	string

Microsoft.Partner.Services.Subscriptions.V1.Models.Upgrade

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
isEligible	boolean
quantity	integer
targetOffer	Microsoft.Partner.Providers.Catalog.V1.Models.Offer
upgradeErrors	Microsoft.Partner.Services.Subscriptions.V1.Models.UpgradeError[]
upgradeType	enum: none upgrade_only upgrade_with_license_transfer

Microsoft.Partner.Services.Subscriptions.V1.Models.UpgradeError

Name	Type	Description
additionalDetails	string
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
code	enum: 0 1 10 2 3 4 5 6 7 8 9
description	string

SupportedBillingCycles

Name	Type	Description
annual	string
monthly	string
none	string
one_time	string
triennial	string
unknown	string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name	Type	Description
key	string
value	string