Manage customer accounts - Get Entitlements

Service:

Partner Center Rest

API Version:

v1

GET https://api.partnercenter.microsoft.com/V1/customers/{customer_id}/entitlements

With optional parameters:

GET https://api.partnercenter.microsoft.com/V1/customers/{customer_id}/entitlements?entitlementtype={entitlementtype}&showExpiry={showExpiry}

URI Parameters

Name	In	Required	Type	Description
customer_id	path	True	string	The customer Id.
entitlementtype	query		string	The Entitlement Type.
showExpiry	query		boolean	Flag to show expiry date for each asset.

Request Header

Name	Required	Type	Description
Authorization	True	string	Authorization Bearer token
ms-correlationid		string	Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
ms-cv		string	Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request
ms-requestid		string	Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name	Type	Description
200 OK	Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Entitlement]	The request succeeded. The response body contains entitlements. Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name	Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Entitlement]
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Artifact
Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Entitlement
Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.QuantityDetail
Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.ReferenceOrder
System.Collections.Generic.KeyValuePair[System.String,System.String]

Microsoft.Partner.Core.Collections.Link

Name	Type	Description
body	string
headers	System.Collections.Generic.KeyValuePair[System.String,System.String][]
method	string
uri	string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name	Type	Description
etag	string
objectType	string

Microsoft.Partner.Core.Collections.ResourceCollection[Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Entitlement]

Name	Type	Description
attributes	Microsoft.Partner.Core.Collections.ResourceAttributes
items	Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Entitlement[]
links	Microsoft.Partner.Core.Collections.ResourceLinks
totalCount	integer

Microsoft.Partner.Core.Collections.ResourceLinks

Name	Type	Description
next	Microsoft.Partner.Core.Collections.Link
previous	Microsoft.Partner.Core.Collections.Link
self	Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Artifact

Name	Type	Description
artifactType	enum: product_key reservedinstance unknown virtual_machine_reserved_instance
dynamicAttributes	object

Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Entitlement

Name	Type	Description
entitledArtifacts	Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Artifact[]
entitlementType	enum: reservedinstance software unknown virtual_machine_reserved_instance
expiryDate	string
fulfillmentState	string
includedEntitlements	Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.Entitlement[]
minEventDate	string
productId	string
quantity	integer
quantityDetails	Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.QuantityDetail[]
referenceOrder	Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.ReferenceOrder
skuId	string

Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.QuantityDetail

Name	Type	Description
quantity	integer
status	string

Microsoft.Partner.Fulfillment.Services.ServiceLayer.Models.ReferenceOrder

Name	Type	Description
alternateId	string
id	string
lineItemId	string

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

Name	Type	Description
key	string
value	string