< Back
Get-PartnerCustomerEntitlement
Post
NAME Get-PartnerCustomerEntitlement
SYNOPSIS
Gets a collection of entitlements.
SYNTAX
Get-PartnerCustomerEntitlement -CustomerId <String> [-OrderId <String>] [-ShowExpiry] [<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.
PARAMETERS
-CustomerId <String>
Identifier for the customer.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OrderId <String>
Identifier for the order.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ShowExpiry [<SwitchParameter>]
A flag to indicate if the expiry date is required to be returned along with the entitlement (if applicable).
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Store.PartnerCenter.PowerShell.Models.Entitlements.PSEntitlement
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Get-PartnerCustomerEntitlement -CustomerId c4f6bf3c-60de-432e-a3ec-20bcc5b26ec2
Return customer entitlements based on customer identifier.
RELATED LINKS
Online Version: https://docs.microsoft.com/powershell/m ... ntitlement
SYNOPSIS
Gets a collection of entitlements.
SYNTAX
Get-PartnerCustomerEntitlement -CustomerId <String> [-OrderId <String>] [-ShowExpiry] [<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.
PARAMETERS
-CustomerId <String>
Identifier for the customer.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-OrderId <String>
Identifier for the order.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ShowExpiry [<SwitchParameter>]
A flag to indicate if the expiry date is required to be returned along with the entitlement (if applicable).
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
Microsoft.Store.PartnerCenter.PowerShell.Models.Entitlements.PSEntitlement
NOTES
-------------------------- Example 1 --------------------------
PS C:\\> Get-PartnerCustomerEntitlement -CustomerId c4f6bf3c-60de-432e-a3ec-20bcc5b26ec2
Return customer entitlements based on customer identifier.
RELATED LINKS
Online Version: https://docs.microsoft.com/powershell/m ... ntitlement