v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13217260568.5 KB
billingProfiles

Retrieves a list of billing profiles, possibly filtered. This method supports paging.

get/userprofiles/{+profileId}/billingProfiles

Path parameters

profileIdstring required

User profile ID associated with this request.

Query parameters

currency_codestring

Select only billing profile with currency.

idsstring[]

Select only billing profile with these IDs.

maxResultsinteger

Maximum number of results to return.

namestring

Allows searching for billing profiles by name. Wildcards () are allowed. For example, "profile2020" will return objects with names like "profile June 2020", "profile April 2020", or simply "profile 2020". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "profile" will match objects with name "my profile", "profile 2021", or simply "profile".

onlySuggestionboolean

Select only billing profile which is suggested for the currency_code & subaccount_id using the Billing Suggestion API.

pageTokenstring

Value of the nextPageToken from the previous result page.

sortField'ID' | 'NAME'

Field by which to sort the list.

sortOrder'ASCENDING' | 'DESCENDING'

Order of sorted results.

statusstring[]

Select only billing profile with the specified status.

subaccountIdsstring[]

Select only billing profile with the specified subaccount.When only_suggestion is true, only a single subaccount_id is supported.

Response

Successful response