Manage orders - Get customer subscriptions
Récupère les abonnements pour un client partenaire par identifiant de locataire Microsoft Entra.
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptions
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptions?order_id={order_id}&mpn_id={mpn_id}&product_type={product_type}&product_subtype={product_subtype}
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
customer_id
|
path | True |
string |
L'identifiant de locataire Microsoft Entra du client. |
|
version
|
path | True |
string |
La version API du Partner Center. Utilisez la v1. |
|
mpn_id
|
query |
string |
Filtre les abonnements par le revendeur PartnerID. Ce paramètre ne peut pas être combiné avec order_id. |
|
|
order_id
|
query |
string |
Filtre les abonnements par identifiant d’ordre. Ce paramètre ne peut pas être combiné avec mpn_id, product_type ou product_subtype. |
|
|
product_subtype
|
query |
string |
Filtre les abonnements par sous-type de produit. Utilisez-les avec product_type. |
|
|
product_type
|
query |
string |
Filtre les abonnements par type de produit. |
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 requêtes 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 requêtes 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’idempotence 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 |
La demande a été traitée avec succès. Le corps de la réponse contient les abonnements. Media Types: "application/json", "text/json" |
|
| 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" |
|
| 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" |
|
| 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" |
|
| 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" |
|
| 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" |
Définitions
| Nom | Description |
|---|---|
|
Benefit |
Représente les instructions appliquées à un avantage au début de son prochain mandat. |
|
Item |
Représente une ressource de type objet. |
| Link |
Représente une ressource de lien. |
|
Next |
Représente les instructions de facturation à appliquer au début de la prochaine période de l’abonnement. |
|
Price |
Représente un avantage de prix appliqué à une ligne ou à un abonnement. Aujourd’hui, le seul type de bénéfice est une marge de croissance CSP, indiquée par un type de marge de croissance ; la ressource est conçue pour pouvoir supporter des types de bénéfices supplémentaires dans de futures versions. Les avantages de prix sont automatiquement appliqués par le service et sont en lecture seule, donc toute valeur fournie lors d’une demande est écrasée. L’effet monétaire du bénéfice se reflète dans les propriétés de prix existantes ; cette ressource n’identifie que le produit à escompte appliqué. |
|
Purchase |
Représente une ressource d’engagement d’achat. |
|
Refundable |
Représente une ressource en quantité remboursable. |
|
Refundable |
Représente une ressource de découpe de quantité remboursable. |
|
Refund |
Représente une ressource pour les options de remboursement. |
|
Resource |
Représente une ressource d’attributs de ressource. |
|
Resource |
Représente une ressource de liens de ressources. |
|
Scheduled |
Représente une ressource d’action planifiée. |
| Scope |
Représente une ressource de périmètre. |
|
String |
Représente une ressource de paires clés-valeurs. |
| Subscription |
Représente une ressource par abonnement. |
|
Subscription |
Représente une ressource de collecte de ressources. |
|
Subscription |
Représente une ressource de détail sur les articles d’abonnement. |
|
Subscription |
Représente une ressource de liens d’abonnement. |
|
Subscription |
Représente un terme produit, ressource. |
|
Subscription |
Représente une ressource d’instructions pour le prochain trimestre planifié. |
BenefitScheduledNextTermInstructions
Représente les instructions appliquées à un avantage au début de son prochain mandat.
| Nom | Type | Description |
|---|---|---|
| billingCycle |
enum:
|
Le cycle de facturation pour postuler pour la session suivante. Les valeurs possibles incluent : « inconnu », « mensuel », « annuel », « aucun », « one_time », « triennal », « biennal », « quadriennal », « quinquennal ». |
| productCode |
string |
Le code produit pour acheter le produit pour la session suivante. |
| productId |
string |
L’identifiant du produit à acheter pour la période suivante. |
| purchaseCommitment |
L’engagement d’achat pour postuler pour le prochain terme. |
|
| skuId |
string |
L’identifiant du SKU à acheter pour le prochain trimestre. |
| termDuration |
string |
La durée du prochain trimestre, au format ISO 8601. |
ItemType
Représente une ressource de type objet.
| Nom | Type | Description |
|---|---|---|
| displayName |
string |
Le nom affiché aux partenaires. |
| id |
string |
Identifiant unique pour le type d’article. La valeur est généralement un GUID. |
| skuCategories |
string[] |
Les catégories SKU associées au type de produit. |
| subType |
Sous-type supplémentaire associé au type d’objet. |
Link
Représente une ressource de lien.
| Nom | Type | Description |
|---|---|---|
| body |
string |
Le corps pour le lien. |
| headers |
La collection d’en-têtes associée à ce lien. |
|
| method |
string |
La méthode du lien. |
| uri |
string |
L’URI de la ressource associée. |
NextChargeInstructions
Représente les instructions de facturation à appliquer au début de la prochaine période de l’abonnement.
| Nom | Type | Description |
|---|---|---|
| product |
Le produit et la durée de facturation à facturer lors du prochain trimestre. |
|
| quantity |
integer (int32) |
La quantité à facturer au prochain trimestre. |
PriceBenefit
Représente un avantage de prix appliqué à une ligne ou à un abonnement. Aujourd’hui, le seul type de bénéfice est une marge de croissance CSP, indiquée par un type de marge de croissance ; la ressource est conçue pour pouvoir supporter des types de bénéfices supplémentaires dans de futures versions. Les avantages de prix sont automatiquement appliqués par le service et sont en lecture seule, donc toute valeur fournie lors d’une demande est écrasée. L’effet monétaire du bénéfice se reflète dans les propriétés de prix existantes ; cette ressource n’identifie que le produit à escompte appliqué.
| Nom | Type | Description |
|---|---|---|
| availabilityId |
string |
L’identifiant de disponibilité du produit à réduction prix-bénéfice. Identifie le prix à rabais spécifique appliqué. |
| productCode |
string |
Le nom universel du produit (UPN) du produit à rabais prix-avantage. |
| productId |
string |
L’identifiant du produit à rabais prix-avantage. |
| skuId |
string |
L’identifiant SKU du produit à réduction prix-avantage. |
| type |
string |
Type d’avantage tarifaire. Seul GrowthMargin est pris en charge aujourd’hui. |
PurchaseCommitment
Représente une ressource d’engagement d’achat.
| Nom | Type | Description |
|---|---|---|
| amount |
number (double) |
Le montant monétaire. |
| currency |
string |
Le code de devise ISO à trois lettres. |
| grain |
string |
Le grain de mesure utilisé pour cette valeur. |
RefundableQuantity
Représente une ressource en quantité remboursable.
| Nom | Type | Description |
|---|---|---|
| details |
La collection de détails associés à ce montant remboursable. |
|
| totalQuantity |
integer (int32) |
Le montant total pour le montant remboursable. |
RefundableQuantityDetail
Représente une ressource de découpe de quantité remboursable.
| Nom | Type | Description |
|---|---|---|
| allowedUntilDateTime |
string (date-time) |
Le délai autorisé jusqu’à la date limite pour le détail du montant remboursable. Utilise le format date-heure ISO 8601. |
| quantity |
integer (int32) |
Nombre d’unités. |
RefundOption
Représente une ressource pour les options de remboursement.
| Nom | Type | Description |
|---|---|---|
| expiresAt |
string (date-time) |
L’option de remboursement expire à . Utilise le format date-heure ISO 8601. |
| type |
string |
Le type d’option de remboursement. |
ResourceAttributes
Représente une ressource d’attributs de ressource.
| Nom | Type | Description |
|---|---|---|
| etag |
string |
L’entité utilisée pour le contrôle de la concurrence. |
| objectType |
string |
Le type d’objet pour les attributs de ressource. |
ResourceLinks
Représente une ressource de liens de ressources.
| Nom | Type | Description |
|---|---|---|
| next |
Ajout supplémentaire aux liens de ressources. |
|
| previous |
Des liens supplémentaires liés aux ressources de liens. |
|
| self |
Autre auto-association avec les liens de ressources. |
ScheduledAction
Représente une ressource d’action planifiée.
| Nom | Type | Description |
|---|---|---|
| actionType |
enum:
|
L’action à accomplir. Les valeurs prises en charge sont RenewToExtendedServiceTerm, Cancel, RenewToNewTerm et Transition. |
| effectiveDate |
string (date-time) |
La date et l’heure de la prise en vigueur d’une action programmée CustomDate, au format ISO 8601. |
| instructions |
Les instructions produit, quantitatif et terme pour le changement programmé. Non utilisé pour Annuler. |
|
| scheduleType |
enum:
|
Quand l’action prend effet. Les valeurs prises en charge sont TermEnd, BillingCycleEnd et CustomDate. |
Scope
Représente une ressource de périmètre.
| Nom | Type | Description |
|---|---|---|
| entitlementId |
string |
L’identifiant unique du droit à tous. La valeur est généralement un GUID. |
| managementGroupId |
string |
L’identifiant unique du groupe de gestion. La valeur est généralement un GUID. |
| resourceGroupId |
string |
L’identifiant unique du groupe de ressources. La valeur est généralement un GUID. |
| subscriptionId |
string |
L’identifiant unique (GUID) de l’abonnement. La valeur est généralement un GUID. |
| type |
string |
Le type de lunette. |
StringStringKeyValuePair
Représente une ressource de paires clés-valeurs.
| Nom | Type | Description |
|---|---|---|
| key |
string |
La clé pour la paire clé-valeur. |
| value |
string |
La valeur de la paire clé-valeur. |
Subscription
Représente une ressource par abonnement.
| Nom | Type | Description |
|---|---|---|
| actionTaken |
boolean |
Que cette action d’abonnement soit entreprise. |
| actions |
string[] |
La collection d’actions associées à cet abonnement. |
| additionalPartnerIds |
string[] |
Des PartnerID de revendeurs supplémentaires attribués à l’abonnement par les distributeurs sur les marchés UE/EFTA. |
| attentionNeeded |
boolean |
Est-ce que cet abonnement devait s’intéresser à l’autre. |
| attentionReason |
string |
La raison de l’attention de l’abonnement. |
| attributes |
Attributs supplémentaires associés à l’abonnement. |
|
| autoRenewEnabled |
boolean |
Que ce renouvellement automatique d’abonnement soit activé. |
| billingCycle |
enum:
|
Fréquence de facturation. Les valeurs soutenues sont inconnues : mensuel, annuel, aucun, one_time, triennal, biennal, quadriennale et quinquennale. |
| billingCycleEndDate |
string (date-time) |
La date de fin du cycle de facturation de l’abonnement, au format ISO 8601. |
| billingCycleEndDateTime |
string (date-time) |
La date et l’heure de fin du cycle de facturation pour l’abonnement, au format ISO 8601. |
| billingType |
enum:
|
Le type de facturation de l’abonnement. Les valeurs possibles incluent : « aucun(ne) », « usage », « licence », « benefit ». |
| cancellationAllowedUntilDate |
string (date-time) |
La dernière date et heure d’annulation autorisée, au format ISO 8601. |
| commitmentEndDate |
string (date-time) |
La date de fin de l’engagement actuel, au format ISO 8601. Utilise le format date-heure ISO 8601. |
| commitmentEndDateTime |
string (date-time) |
La date et l’heure de la fin de l’engagement d’abonnement actuel, au format ISO 8601. |
| commitmentStartDate |
string (date-time) |
La date et l’heure de début de l’engagement d’abonnement actuel, au format ISO 8601. |
| consumptionType |
string |
Le type de consommation associé à l’abonnement. |
| contractType |
enum:
|
Le type de contrat pour l’abonnement. Les valeurs possibles incluent : « abonnement », « product_key », « redemption_code ». |
| creationDate |
string (date-time) |
La date et l’heure de création de l’abonnement, au format ISO 8601. Utilise le format date-heure ISO 8601. |
| effectiveStartDate |
string (date-time) |
La date de début effective de l’abonnement. Utilise le format date-heure ISO 8601. |
| entitlementId |
string |
L’identifiant unique du droit à tous. La valeur est généralement un GUID. |
| friendlyName |
string |
Un nom d’affichage amical pour cet article. |
| gracePeriodEndDate |
string (date-time) |
La date de fin de la période de grâce lorsque l’abonnement n’est pas renouvelé, au format ISO 8601. |
| hasPurchasableAddons |
boolean |
S’il y a des addons achetables. |
| id |
string |
Identificateur unique pour l’abonnement. La valeur est généralement un GUID. |
| isMicrosoftProduct |
boolean |
Que ce soit le produit Microsoft. |
| isTrial |
boolean |
Ou quoi que ce soit un procès. |
| lineItems |
La collection de lignes associées à cet abonnement. |
|
| links |
Liens vers des ressources associées. |
|
| migratedFromSubscriptionId |
string |
L’identifiant unique de la migration depuis l’abonnement. La valeur est généralement un GUID. |
| migratedToSubscriptionId |
string |
L’identifiant de l’abonnement vers lequel cet abonnement a été migré. |
| nextChargeInstructions |
Les instructions de facturation doivent s’appliquer au début du prochain terme lorsqu’un changement de cycle de facturation est en attente. |
|
| offerId |
string |
Identificateur de l’offre. Pour les nouveaux abonnements commerce, il s’agit généralement d’un identifiant composite d’article catalogue produit :SKU :disponibilité. |
| offerName |
string |
Le nom de l’offre pour l’abonnement. |
| orderId |
string |
L’identifiant de l’ordre qui a créé l’abonnement. |
| parentSubscriptionId |
string |
L’identifiant unique de l’abonnement parent. La valeur est généralement un GUID. |
| partnerId |
string |
Le PartnerID du revendeur enregistré dans le modèle du partenaire indirect. |
| priceBenefits |
Les avantages de prix appliqués à cette souscription pour la durée en cours. Les avantages de prix sont automatiquement appliqués par le service et sont en lecture seule, donc toute valeur fournie lors d’une demande est écrasée. Cette propriété est omise lorsqu’aucun avantage de prix ne s’applique, et au plus une entrée est retournée aujourd’hui. |
|
| productOrderId |
string |
L’identifiant du bon de commande produit, comme une réservation ou un plan d’épargne Azure. |
| productType |
Type de produit supplémentaire associé à l’abonnement. |
|
| promotionId |
string |
L’identifiant de promotion s’appliquait à l’abonnement, généralement un identifiant composite product :SKU :availability. |
| publisherName |
string |
Le nom de l’éditeur de l’abonnement. |
| quantity |
integer (int32) |
Nombre d’unités. |
| refundOptions |
La collection d’options de remboursement associées à cet abonnement. |
|
| refundableQuantity |
Montant supplémentaire remboursable associé à l’abonnement. |
|
| renewalTermDuration |
string |
La durée du renouvellement de l’abonnement. |
| scheduledActions |
La collection des actions programmées associées à cet abonnement. |
|
| scheduledNextTermInstructions |
Instructions supplémentaires prévues pour le prochain trimestre associées à l’abonnement. |
|
| status |
enum:
|
Le statut actuel de l’abonnement. Les valeurs possibles incluent : « aucun », « actif », « en attente », « suspendu », « expiré », « désactivé », « supprimé ». |
| suspensionReasons |
string[] |
La collection des raisons de suspension associées à cet abonnement. |
| termDuration |
string |
La durée de la durée de l’abonnement (par exemple, P1M pour le mois ou P1Y pour l’annuel). |
| termLifeCycleState |
string |
Le terme cycle de vie est l’état de l’abonnement. |
| unitType |
string |
Le type d’unité pour l’abonnement. |
SubscriptionCollection
Représente une ressource de collecte de ressources.
| Nom | Type | Description |
|---|---|---|
| attributes |
Attributs supplémentaires associés à la collection de ressources. |
|
| items |
La collection d’objets associés à cette collection de ressources. |
|
| links |
Liens vers des ressources associées. |
|
| totalCount |
integer (int32) |
Le nombre total d’éléments disponibles dans l’ensemble de résultats. |
SubscriptionLineItemDetail
Représente une ressource de détail sur les articles d’abonnement.
| Nom | Type | Description |
|---|---|---|
| autoRenewEnabled |
boolean |
Que ce détail de ligne d’abonnement soit renouvelé automatiquement ? |
| friendlyName |
string |
Un nom d’affichage amical pour cet article. |
| id |
string |
Identifiant unique pour le détail de la ligne d’abonnement. La valeur est généralement un GUID. |
| purchaseCommitment |
L’engagement d’achat associé à cet article. |
|
| quantity |
integer (int32) |
Nombre d’unités. |
| scope |
Champ d’application supplémentaire lié au détail des lignes d’abonnement. |
|
| status |
enum:
|
Le statut actuel de l’abonnement. Les valeurs possibles incluent : « aucun », « actif », « en attente », « suspendu », « expiré », « désactivé », « supprimé ». |
SubscriptionLinks
Représente une ressource de liens d’abonnement.
| Nom | Type | Description |
|---|---|---|
| activationLinks |
Des liens d’activation supplémentaires associés aux liens d’abonnement. |
|
| availability |
Disponibilité supplémentaire associée aux liens d’abonnement. |
|
| entitlement |
Un droit supplémentaire associé aux liens d’abonnement. |
|
| next |
Autres liens liés aux liens d’abonnement. |
|
| offer |
Offre supplémentaire associée aux liens d’abonnement. |
|
| parentSubscription |
Abonnement parental supplémentaire associé aux liens d’abonnement. |
|
| pendingChanges |
D’autres modifications en attente liées aux liens d’abonnement. |
|
| previous |
Autres liens d’abonnement liés aux liens d’abonnement. |
|
| product |
Produits supplémentaires associés aux liens d’abonnement. |
|
| self |
Autre soi associé aux liens d’abonnement. |
|
| sku |
SKU supplémentaires associés aux liens d’abonnement. |
SubscriptionProductTerm
Représente un terme produit, ressource.
| Nom | Type | Description |
|---|---|---|
| availabilityId |
string |
L’identifiant de disponibilité dans le produit et le SKU. |
| billingCycle |
enum:
|
Fréquence de facturation. Les valeurs soutenues sont inconnues : mensuel, annuel, aucun, one_time, triennal, biennal, quadriennale et quinquennale. |
| productId |
string |
L’identifiant du produit pour le terme suivant. |
| promotionId |
string |
L’identifiant de promotion à appliquer dans le terme suivant, généralement un identifiant composite product :SKU :availability. |
| skuId |
string |
L’identifiant SKU dans le produit. |
| termDuration |
string |
La durée de la durée de l’abonnement (par exemple, P1M pour le mois ou P1Y pour l’annuel). |
SubscriptionScheduledNextTermInstructions
Représente une ressource d’instructions pour le prochain trimestre planifié.
| Nom | Type | Description |
|---|---|---|
| customTermEndDate |
string (date-time) |
La date de fin personnalisée du trimestre, au format ISO 8601. Utilise le format date-heure ISO 8601. |
| priceBenefits |
Les avantages du prix qui seront appliqués lors du changement programmé. Les avantages de prix sont automatiquement appliqués par le service et sont en lecture seule, donc toute valeur fournie lors d’une demande est écrasée. Cette propriété est omise lorsqu’aucun avantage de prix ne s’applique, et au plus une entrée est retournée aujourd’hui. |
|
| product |
Produits supplémentaires associés aux instructions prévues pour le prochain trimestre. |
|
| quantity |
integer (int32) |
Nombre d’unités. |