Get-ClientBillingProfile
  • 1 Minute to read
  • Dark
    Light
  • PDF

Get-ClientBillingProfile

  • Dark
    Light
  • PDF

Article summary

Summary

Retrieves the billing profile for a client.

Get-ClientBillingProfile
    -Id
    -Top
    -Skip
    -Filter
    -OrderBy

Returns a collection object with the following properties:

PropertyTypeNotes
CollectionCollection of billing type property objectsThe collection of entries retrieved after top, skip, filter, and order by parameters were applied.
TopInt32The top parameter value that was used. Useful while paging data.
SkipInt32The skip parameter value that was used. Useful while paging data.
TotalCountInt32The total count of records available after any filtering was applied. Useful while paging data.

Parameters

ParameterTypeRequired?Notes
IdInt32YesThe client id.
TopInt32No, Defaults to 40Total number of entries to retrieve. Max is 1000.
SkipInt32No, Defaults to 0How many entries should be skipped within the collection. Used for paging the results.
FilterStringNoAn OData 4 string that can be used for filtering the collection.
OrderByStringNoAn OData 4 string that can be used for sorting the collection by specific fields.

Examples

Get a client billing profile

# TODO