Partager via


Manage orders - Get subscription by ID

Récupère un abonnement par identificateur pour le client d’un partenaire par son identificateur de locataire Active Directory.

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

Paramètres URI

Nom Dans Obligatoire Type Description
customer_id
path True

string

Identificateur de locataire Active Directory du client.

subscription_id
path True

string

Identificateur d’abonnement.

version
path True

string

En-tête de la demande

Nom Obligatoire Type Description
Authorization True

string

Jeton du porteur d’autorisation

ms-correlationid

string

Utilisé pour le suivi des demandes en interne. Si un ms-correlationid n’est pas fourni, le serveur en génère un nouveau pour chaque requête

ms-cv

string

Utilisé pour le suivi des demandes en interne. Si un ms-cv n’est pas fourni, le serveur en génère un nouveau pour chaque requête

ms-requestid

string

Utilisé pour l’idempotency des requêtes. Si un ms-requestid n’est pas fourni, le serveur en génère un nouveau pour chaque requête

Réponses

Nom Type Description
200 OK

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

La demande a réussi. Le corps de la réponse contient les informations d’abonnement.

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

400 Bad Request

Une entrée est manquante ou non valide. Le corps de la réponse fournit les détails de l’erreur.

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

401 Unauthorized

La demande n’a pas été authentifiée. Le client doit d’abord s’authentifier auprès du service d’API partenaire.

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

403 Forbidden

La demande a été authentifiée, mais a été refusée, car l’appelant n’a pas les droits de l’appeler.

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

404 Not Found

La ressource est introuvable ou non disponible avec les paramètres d’entrée donnés.

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

500 Internal Server Error

Le service d’API partenaire ou l’une de ses dépendances n’a pas pu répondre à la demande. Les appelants peuvent réessayer.

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

Définitions

Nom 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]
Nom Type Description
body

string

headers

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

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Nom Type Description
etag

string

objectType

string

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

Nom Type Description
displayName

string

id

string

subType

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

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

Nom Type 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

Nom Type Description
amount

number

currency

string

grain

string

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

Nom Type Description
details

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

totalQuantity

integer

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

Nom Type Description
allowedUntilDateTime

string

quantity

integer

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

Nom Type Description
expiresAt

string

type

string

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

Nom Type Description
customTermEndDate

string

product

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

quantity

integer

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

Nom Type Description
entitlementId

string

managementGroupId

string

resourceGroupId

string

subscriptionId

string

type

string

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

Nom Type 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

Nom Type 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
Nom Type 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]

Nom Type Description
key

string

value

string