Get-ClientBillingProfile
- 1 Minute to read
- Print
- DarkLight
- PDF
Get-ClientBillingProfile
- 1 Minute to read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Summary
Retrieves the billing profile for a client.
Get-ClientBillingProfile
-Id
-Top
-Skip
-Filter
-OrderByReturns a collection object with the following properties:
Property | Type | Notes |
|---|---|---|
Collection | Collection of billing type property objects | The collection of entries retrieved after top, skip, filter, and order by parameters were applied. |
Top | Int32 | The top parameter value that was used. Useful while paging data. |
Skip | Int32 | The skip parameter value that was used. Useful while paging data. |
TotalCount | Int32 | The total count of records available after any filtering was applied. Useful while paging data. |
Parameters
Parameter | Type | Required? | Notes |
|---|---|---|---|
Id | Int32 | Yes | The client id. |
Top | Int32 | No, Defaults to 40 | Total number of entries to retrieve. Max is 1000. |
Skip | Int32 | No, Defaults to 0 | How many entries should be skipped within the collection. Used for paging the results. |
Filter | String | No | An OData 4 string that can be used for filtering the collection. |
OrderBy | String | No | An OData 4 string that can be used for sorting the collection by specific fields. |
Examples
Get a client billing profile
# Retrieve the billing profile for client 1 where a unit price is defined
$billingProfile = Get-ClientBillingProfile `
-Id 1 `
-Filter "UnitPrice ne null"
Write-Output "There are $($billingProfile.TotalCount) unit prices set for client id 1"Results of executing the script:
There are 2 unit prices set for client id 1