Get-PartnerCustomerEntitlement

Reference

Module:: PartnerCenter

Gets a collection of entitlements.

Syntax

Get-PartnerCustomerEntitlement
   -CustomerId <String>
   [-ShowExpiry]
   [-OrderId <String>]
   [<CommonParameters>]

Description

An entitlement represents the customer's right to use a product (service). It should be consumed by service providers as the source of truth regarding the customer's right to a service. The entitlement state changes based on information received from a variety of sources, for example, subscription events. A customer may stop paying, upgrade, etc, which results in changes to the entitlement fraud. The Commerce platform may rescind an entitlement due to fraud.

Examples

Example 1

PS C:\> Get-PartnerCustomerEntitlement -CustomerId c4f6bf3c-60de-432e-a3ec-20bcc5b26ec2

Return customer entitlements based on customer identifier.

Parameters

-CustomerId

Identifier for the customer.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-OrderId

Identifier for the order.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ShowExpiry

A flag to indicate if the expiry date is required to be returned along with the entitlement (if applicable).

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

None

Outputs

Microsoft.Store.PartnerCenter.PowerShell.Models.Entitlements.PSEntitlement

Share via