Listing, Sorting and Filtering Payment Methods
This endpoint returns the list of payment methods.
Sorting
The results from this endpoint can be ordered using the $orderby query parameter. Specify a field name, and optionally asc or desc.
Sorting is valid on the following fields: type, azure/azureSaasSubscriptionName, azure/azureSaasSubscriptionId, aws/awsAccountId
Filtering
There are two ways to filter the set of returned payment methods from this endpoint - the first is to use the $filter query parameter, the second is to use the
$label_key and $label query parameters.
$filter allows for payment methods to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: type, azure/azureSaasSubscriptionName, azure/azureSaasSubscriptionId, aws/awsAccountId
Examples:
?$top=10 - Returns only the first 10 payment methods from the list.
?$orderby=name desc - Sorts payment methods by name in descending order.
?$filter=name eq 'descriptive name' - Returns payment methods that match the provided name.
?$orderby=properties/created desc - Sorts payment methods by creation date in descending order.
?$filter=properties/created ge 2021-01-01T00:00:00Z - Returns payment methods created after January 1, 2021.