Get-PartnerCustomerEntitlement
Gets a collection of entitlements.
Syntax
Default (Default)
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.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OrderId
Identifier for the order.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ShowExpiry
A flag to indicate if the expiry date is required to be returned along with the entitlement (if applicable).
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.