Manage orders - Get subscription by ID
Pobiera subskrypcję według identyfikatora klienta partnera według identyfikatora dzierżawy usługi Active Directory.
GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/subscriptions/{subscription_id}
Parametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
customer_id
|
path | True |
string |
Identyfikator dzierżawy usługi Active Directory klienta. |
|
subscription_id
|
path | True |
string |
Identyfikator subskrypcji. |
|
version
|
path | True |
string |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Authorization | True |
string |
Token elementu nośnego autoryzacji |
| ms-correlationid |
string |
Służy do śledzenia żądań wewnętrznie. Jeśli nie podano identyfikatora ms-correlationid, serwer wygeneruje nowy dla każdego żądania |
|
| ms-cv |
string |
Służy do śledzenia żądań wewnętrznie. Jeśli nie podano ms-cv, serwer wygeneruje nowy dla każdego żądania |
|
| ms-requestid |
string |
Służy do idempotentności żądań. Jeśli nie podano identyfikatora ms-requestid, serwer wygeneruje nowy dla każdego żądania |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
Microsoft. |
Żądanie zakończyło się pomyślnie. Treść odpowiedzi zawiera informacje o subskrypcji. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
| 400 Bad Request |
Brak danych wejściowych lub nieprawidłowy. Treść odpowiedzi udostępni szczegóły błędu. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
|
| 401 Unauthorized |
Żądanie nie zostało uwierzytelnione. Klient musi najpierw uwierzytelnić się za pomocą usługi interfejsu API partnera. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
|
| 403 Forbidden |
Żądanie zostało uwierzytelnione, ale zostało odrzucone, ponieważ obiekt wywołujący nie ma praw do jego wywołania. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
|
| 404 Not Found |
Zasób nie został znaleziony lub niedostępny z podanymi parametrami wejściowymi. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
|
| 500 Internal Server Error |
Usługa interfejsu API partnera lub jedna z jego zależności nie spełniła żądania. Osoby wywołujące mogą ponowić próbę. Media Types: "application/json", "text/json", "application/xml", "text/xml" |
Definicje
Microsoft.Partner.Core.Collections.Link
| Nazwa | Typ | Opis |
|---|---|---|
| body |
string |
|
| headers |
System. |
|
| method |
string |
|
| uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
| Nazwa | Typ | Opis |
|---|---|---|
| etag |
string |
|
| objectType |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType
| Nazwa | Typ | Opis |
|---|---|---|
| displayName |
string |
|
| id |
string |
|
| subType |
Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm
| Nazwa | Typ | Opis |
|---|---|---|
| availabilityId |
string |
|
| billingCycle |
enum:
|
|
| productId |
string |
|
| skuId |
string |
|
| termDuration |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.PurchaseCommitment
| Nazwa | Typ | Opis |
|---|---|---|
| amount |
number (double) |
|
| currency |
string |
|
| grain |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantity
| Nazwa | Typ | Opis |
|---|---|---|
| details |
Microsoft. |
|
| totalQuantity |
integer (int32) |
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail
| Nazwa | Typ | Opis |
|---|---|---|
| allowedUntilDateTime |
string (date-time) |
|
| quantity |
integer (int32) |
Microsoft.Partner.Services.Subscriptions.V1.Models.RefundOption
| Nazwa | Typ | Opis |
|---|---|---|
| expiresAt |
string (date-time) |
|
| type |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledAction
| Nazwa | Typ | Opis |
|---|---|---|
| actionType |
string |
Wymagane, jeśli ScheduledType to "TermEnd". Może to być "RenewToExtendedServiceTerm", "Cancel" lub "RenewToNewTerm". |
| effectiveDate |
string (date-time) |
Data, kiedy planowana akcja wchodzi w życie. |
| instructions |
Microsoft. |
Instrukcje dotyczące zmian subskrypcji. Opcjonalne dla RenewToNewTerm. Nie dotyczy anulowania. |
| scheduleType |
string |
To jest wymagane. Może to być "TermEnd". |
Microsoft.Partner.Services.Subscriptions.V1.Models.ScheduledNextTermInstructions
| Nazwa | Typ | Opis |
|---|---|---|
| customTermEndDate |
string (date-time) |
|
| product |
Microsoft. |
|
| quantity |
integer (int32) |
Microsoft.Partner.Services.Subscriptions.V1.Models.Scope
| Nazwa | Typ | Opis |
|---|---|---|
| entitlementId |
string |
|
| managementGroupId |
string |
|
| resourceGroupId |
string |
|
| subscriptionId |
string |
|
| type |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription
| Nazwa | Typ | Opis |
|---|---|---|
| actionTaken |
boolean |
|
| actions |
string[] |
|
| attentionNeeded |
boolean |
|
| attentionReason |
string |
|
| attributes | ||
| autoRenewEnabled |
boolean |
|
| billingCycle |
enum:
|
|
| billingType |
enum:
|
|
| commitmentEndDate |
string (date-time) |
|
| contractType |
enum:
|
|
| creationDate |
string (date-time) |
|
| effectiveStartDate |
string (date-time) |
|
| entitlementId |
string |
|
| friendlyName |
string |
|
| hasPurchasableAddons |
boolean |
|
| id |
string |
|
| isMicrosoftProduct |
boolean |
|
| isTrial |
boolean |
|
| lineItems |
Microsoft. |
|
| links |
Microsoft. |
|
| migratedFromSubscriptionId |
string |
|
| offerId |
string |
|
| offerName |
string |
|
| orderId |
string |
|
| parentSubscriptionId |
string |
|
| partnerId |
string |
|
| productOrderId |
string |
|
| productType | ||
| promotionId |
string |
|
| publisherName |
string |
|
| quantity |
integer (int32) |
|
| refundOptions |
Microsoft. |
|
| refundableQuantity |
Microsoft. |
|
| renewalTermDuration |
string |
|
| scheduledActions |
Microsoft. |
|
| scheduledNextTermInstructions |
Microsoft. |
|
| status |
enum:
|
|
| suspensionReasons |
string[] |
|
| termDuration |
string |
|
| termLifeCycleState |
string |
|
| unitType |
string |
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLineItemDetail
| Nazwa | Typ | Opis |
|---|---|---|
| autoRenewEnabled |
boolean |
|
| friendlyName |
string |
|
| id |
string |
|
| purchaseCommitment |
Microsoft. |
|
| quantity |
integer (int32) |
|
| scope | ||
| status |
enum:
|
Microsoft.Partner.Services.Subscriptions.V1.Models.SubscriptionLinks
| Nazwa | Typ | Opis |
|---|---|---|
| activationLinks | ||
| availability | ||
| entitlement | ||
| next | ||
| offer | ||
| parentSubscription | ||
| pendingChanges | ||
| previous | ||
| product | ||
| self | ||
| sku |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Nazwa | Typ | Opis |
|---|---|---|
| key |
string |
|
| value |
string |