Manage orders - Get customer's subscriptions

服务:

Partner Center Rest

API 版本:

v1

按合作伙伴的 Active Directory 租户标识符检索合作伙伴客户的所有订阅。

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}

URI 参数

名称	在	必需	类型	说明
customer_id	path	True	string	客户的 Active Directory 租户标识符。
version	path	True	string
mpn_id	query		string	合作伙伴标识符（mpn）。 可选参数。 按“合作伙伴 ID”筛选订阅。 此参数不能与“订单 ID”结合使用。
order_id	query		string	订单标识符。 可选参数。 按“订单 ID”筛选订阅。 此参数不能与“合作伙伴 ID”结合使用。
product_subtype	query		string	产品子类型。 可选参数。 按“product type”和“product subtype”筛选订阅。
product_type	query		string	产品类型。 可选参数。 按“产品类型”筛选订阅。

请求头

名称	必需	类型	说明
Authorization	True	string	授权持有者令牌
ms-correlationid		string	用于在内部跟踪请求。 如果未提供 ms-correlationid，则服务器将为每个请求生成一个新请求
ms-cv		string	用于在内部跟踪请求。 如果未提供 ms-cv，服务器将为每个请求生成一个新请求
ms-requestid		string	用于请求的幂等性。 如果未提供 ms-requestid，服务器将为每个请求生成一个新请求

响应

名称	类型	说明
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription]	请求成功。 响应正文包含订阅。 Media Types: "application/json", "text/json"
400 Bad Request		输入缺失或无效。 响应正文将提供错误详细信息。 Media Types: "application/json", "text/json"
401 Unauthorized		请求未通过身份验证。 客户端需要首先通过合作伙伴 API 服务进行身份验证。 Media Types: "application/json", "text/json"
403 Forbidden		请求已经过身份验证，但被拒绝，因为调用方无权调用该请求。 Media Types: "application/json", "text/json"
404 Not Found		找不到资源或未与给定输入参数一起使用。 Media Types: "application/json", "text/json"
500 Internal Server Error		合作伙伴 API 服务或其某个依赖项未能满足请求。 调用方可能会重试此操作。 Media Types: "application/json", "text/json"

定义

名称	说明
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription]
Microsoft.Partner.Core.Collections.ResourceLinks
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]

Microsoft.Partner.Core.Collections.Link

Object

名称	类型	说明
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Object

名称	类型	说明
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription]

Object

名称	类型	说明
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Services.Subscriptions.V1.Models.Subscription[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Object

名称	类型	说明
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

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

Object

名称	类型	说明
displayName	string
id	string
subType	Microsoft.Partner.Services.Subscriptions.V1.Models.ItemType

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

Object

名称	类型	说明
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

Object

名称	类型	说明
amount	number
currency	string
grain	string

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

Object

名称	类型	说明
details	Microsoft.Partner.Services.Subscriptions.V1.Models.RefundableQuantityDetail[]
totalQuantity	integer

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

Object

名称	类型	说明
allowedUntilDateTime	string
quantity	integer

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

Object

名称	类型	说明
expiresAt	string
type	string

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

Object

名称	类型	说明
customTermEndDate	string
product	Microsoft.Partner.Services.Subscriptions.V1.Models.ProductTerm
quantity	integer

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

Object

名称	类型	说明
entitlementId	string
managementGroupId	string
resourceGroupId	string
subscriptionId	string
type	string

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

Object

名称	类型	说明
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

Object

名称	类型	说明
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

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

Object

名称	类型	说明
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]

Object

名称	类型	说明
key	string
value	string