Delen via

Manage orders - Perform a subscription upgrade

  • Referentie
Service:
Partner Center Rest
API-versie:
v1

Voert een abonnementsupgrade uit.

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

URI-parameters

Name In Vereist Type Description
customer_id
 path True

string

De klant-id.
subscription_id
 path True

string

De abonnements-id.
version
 path True

string

Aanvraagkoptekst

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

Name Vereist Type Description
Authorization True

string

Bearer-token voor autorisatie
ms-correlationid

string

Wordt intern gebruikt voor het bijhouden van aanvragen. Als er geen ms-correlationid is opgegeven, genereert de server een nieuwe voor elke aanvraag
ms-cv

string

Wordt intern gebruikt voor het bijhouden van aanvragen. Als er geen ms-cv is opgegeven, genereert de server een nieuwe voor elke aanvraag
ms-requestid

string

Wordt gebruikt voor idempotentie van aanvragen. Als er geen ms-requestid is opgegeven, genereert de server een nieuwe voor elke aanvraag

Aanvraagbody

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

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

Antwoorden

Name Type Description
200 OK

Microsoft.Partner.Services.Subscriptions.V1.Models.UpgradeResult

De aanvraag is geslaagd. Het resultaat van de upgrade wordt geretourneerd in de hoofdtekst van het antwoord.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
400 Bad Request

Er is een ontbrekende of ongeldige invoer. De hoofdtekst van het antwoord bevat de foutdetails.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
401 Unauthorized

De aanvraag is niet geverifieerd. De client moet eerst worden geverifieerd met de partner-API-service.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
403 Forbidden

De aanvraag is geverifieerd, maar is geweigerd omdat de beller niet over de rechten beschikt om deze aan te roepen.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
404 Not Found

De resource is niet gevonden of niet beschikbaar met de opgegeven invoerparameters.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
500 Internal Server Error

De partner-API-service of een van de bijbehorende afhankelijkheden kan niet voldoen aan de aanvraag. Bellers kunnen dit opnieuw proberen.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definities

Name Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Core.Web.Exceptions.ServiceFault
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
Microsoft.Partner.Services.Subscriptions.V1.Models.UpgradeResult
Microsoft.Partner.Services.Subscriptions.V1.Models.UserLicenseError
SupportedBillingCycles
System.Collections.Generic.KeyValuePair[System.String,System.String]
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

Name Type Description
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Core.Web.Exceptions.ServiceFault

Name Type Description
code

integer

data

string[]

description

string

source

string

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

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

Microsoft.Partner.Services.Subscriptions.V1.Models.UpgradeResult

Name Type Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

licenseErrors

Microsoft.Partner.Services.Subscriptions.V1.Models.UserLicenseError[]

sourceSubscriptionId

string

targetSubscriptionId

string

upgradeErrors

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

upgradeType enum:
  • none
  • upgrade_only
  • upgrade_with_license_transfer

Microsoft.Partner.Services.Subscriptions.V1.Models.UserLicenseError

Name Type Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

email

string

errors

Microsoft.Partner.Core.Web.Exceptions.ServiceFault[]

name

string

userObjectId

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