Freigeben über

Manage orders - Get subscription by ID

  • Referenz
Service:
Partner Center Rest
API Version:
v1

Ruft ein Abonnement nach Bezeichner für den Kunden eines Partners anhand seines Active Directory-Mandantenbezeichners ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
customer_id
 path True

string

Der Active Directory-Mandantenbezeichner des Kunden.
subscription_id
 path True

string

Die Abonnement-ID.
version
 path True

string

Anforderungsheader

Name Erforderlich Typ Beschreibung
Authorization True

string

Autorisierungs-Bearertoken
ms-correlationid

string

Wird für die interne Nachverfolgung von Anforderungen verwendet. Wenn keine ms-correlationid angegeben wird, generiert der Server für jede Anforderung eine neue.
ms-cv

string

Wird für die interne Nachverfolgung von Anforderungen verwendet. Wenn kein ms-cv bereitgestellt wird, generiert der Server für jede Anforderung eine neue.
ms-requestid

string

Wird für Idempotenz von Anforderungen verwendet. Wenn keine ms-requestid angegeben wird, generiert der Server für jede Anforderung eine neue.

Antworten

Name Typ Beschreibung
200 OK

Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription

Die Anforderung wurde erfolgreich gesendet. Der Antworttext enthält die Abonnementinformationen.

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

Es fehlte eine oder eine ungültige Eingabe. Der Antworttext enthält die Fehlerdetails.

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

Die Anforderung wurde nicht authentifiziert. Der Client muss sich zuerst beim Partner-API-Dienst authentifizieren.

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

Die Anforderung wurde authentifiziert, aber abgelehnt, da der Aufrufer nicht über die Rechte zum Aufrufen verfügt.

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

Die Ressource ist mit den angegebenen Eingabeparametern nicht gefunden oder nicht verfügbar.

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

Der Partner-API-Dienst oder eine seiner Abhängigkeiten konnte die Anforderung nicht erfüllen. Aufrufer können dies wiederholen.

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

Definitionen

Name Beschreibung
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType
Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm
Microsoft.Partner.Services.Subscriptions.V1.Models.PurchaseCommitment
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantity
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundOption
Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledNextTermInstructions
Microsoft.Partner.Services.Subscriptions.V1.Models.Scope
Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLineItemDetail
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name Typ Beschreibung
body

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name Typ Beschreibung
etag

string

objectType

string

Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType

Name Typ Beschreibung
displayName

string

id

string

subType

Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType

Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm

Name Typ Beschreibung
availabilityId

string

billingCycle enum:
  • annual
  • biennial
  • monthly
  • none
  • one_time
  • triennial
  • unknown
productId

string

skuId

string

termDuration

string

Microsoft.Partner.Services.Subscriptions.V1.Models.PurchaseCommitment

Name Typ Beschreibung
amount

number

currency

string

grain

string

Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantity

Name Typ Beschreibung
details

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

totalQuantity

integer

Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail

Name Typ Beschreibung
allowedUntilDateTime

string

quantity

integer

Microsoft.Partner.Services.Subscriptions.V1.Models.RefundOption

Name Typ Beschreibung
expiresAt

string

type

string

Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledNextTermInstructions

Name Typ Beschreibung
customTermEndDate

string

product

Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm

quantity

integer

Microsoft.Partner.Services.Subscriptions.V1.Models.Scope

Name Typ Beschreibung
entitlementId

string

managementGroupId

string

resourceGroupId

string

subscriptionId

string

type

string

Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription

Name Typ Beschreibung
actionTaken

boolean

actions

string[]

attentionNeeded

boolean

attentionReason

string

attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

autoRenewEnabled

boolean

billingCycle enum:
  • annual
  • monthly
  • none
  • one_time
  • triennial
  • unknown
billingType enum:
  • benefit
  • license
  • none
  • usage
commitmentEndDate

string

contractType enum:
  • product_key
  • redemption_code
  • subscription
creationDate

string

effectiveStartDate

string

entitlementId

string

friendlyName

string

hasPurchasableAddons

boolean

id

string

isMicrosoftProduct

boolean

isTrial

boolean

lineItems

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

links

Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks

migratedFromSubscriptionId

string

offerId

string

offerName

string

orderId

string

parentSubscriptionId

string

partnerId

string

productOrderId

string

productType

Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType

promotionId

string

publisherName

string

quantity

integer

refundOptions

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

refundableQuantity

Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantity

renewalTermDuration

string

scheduledNextTermInstructions

Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledNextTermInstructions

status enum:
  • active
  • deleted
  • disabled
  • expired
  • none
  • pending
  • suspended
suspensionReasons

string[]

termDuration

string

unitType

string

Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLineItemDetail

Name Typ Beschreibung
autoRenewEnabled

boolean

friendlyName

string

id

string

purchaseCommitment

Microsoft.Partner.Services.Subscriptions.V1.Models.PurchaseCommitment

quantity

integer

scope

Microsoft.Partner.Services.Subscriptions.V1.Models.Scope

status enum:
  • active
  • deleted
  • expired
  • expired
  • none
  • pending
  • suspended
Name Typ Beschreibung
activationLinks

Microsoft.Partner.Core.Collections.Link

availability

Microsoft.Partner.Core.Collections.Link

entitlement

Microsoft.Partner.Core.Collections.Link

next

Microsoft.Partner.Core.Collections.Link

offer

Microsoft.Partner.Core.Collections.Link

parentSubscription

Microsoft.Partner.Core.Collections.Link

pendingChanges

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

product

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

sku

Microsoft.Partner.Core.Collections.Link

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

Name Typ Beschreibung
key

string

value

string