Sdílet prostřednictvím


Manage orders - Get subscription by ID

Načte předplatné podle identifikátoru zákazníka partnera podle identifikátoru tenanta služby Active Directory.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
customer_id
path True

string

Identifikátor tenanta active directory zákazníka.

subscription_id
path True

string

Identifikátor předplatného.

version
path True

string

Hlavička požadavku

Name Vyžadováno Typ Description
Authorization True

string

Nosný token autorizace

ms-correlationid

string

Používá se k internímu sledování požadavků. Pokud není zadaný identifikátor ms-correlationid, server vygeneruje pro každý požadavek nový.

ms-cv

string

Používá se k internímu sledování požadavků. Pokud ms-cv není zadaný, server vygeneruje pro každou žádost nový.

ms-requestid

string

Používá se pro idempotenci požadavků. Pokud není zadaný identifikátor ms-requestid, server pro každou žádost vygeneruje nový.

Odpovědi

Name Typ Description
200 OK

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

Požadavek byl úspěšný. Text odpovědi obsahuje informace o předplatném.

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

400 Bad Request

Chybí nebo je neplatný vstup. Text odpovědi poskytne podrobnosti o chybě.

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

401 Unauthorized

Požadavek nebyl ověřen. Klient se musí nejprve ověřit ve službě partnerského rozhraní API.

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

403 Forbidden

Požadavek byl ověřen, ale byl odmítnut, protože volající nemá práva k jeho vyvolání.

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

404 Not Found

Prostředek se s danými vstupními parametry nenašel nebo není k dispozici.

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

500 Internal Server Error

Službě partnerského rozhraní API nebo některé z jejích závislostí se nepodařilo požadavek splnit. Volající to můžou zkusit znovu.

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

Definice

Name Description
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 Description
body

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name Typ Description
etag

string

objectType

string

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

Name Typ Description
displayName

string

id

string

subType

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

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

Name Typ Description
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 Description
amount

number

currency

string

grain

string

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

Name Typ Description
details

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

totalQuantity

integer

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

Name Typ Description
allowedUntilDateTime

string

quantity

integer

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

Name Typ Description
expiresAt

string

type

string

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

Name Typ Description
customTermEndDate

string

product

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

quantity

integer

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

Name Typ Description
entitlementId

string

managementGroupId

string

resourceGroupId

string

subscriptionId

string

type

string

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

Name Typ Description
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 Description
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 Description
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 Description
key

string

value

string