Interface BillingAccountsSearch

All Known Implementing Classes:
BillingAccountsSearchImpl
public interface BillingAccountsSearch
Client interface for searching billing accounts via the Platform Billing Account v2 (BAS) API at /billing/v2/billingAccounts.

search(BillingAccountSearchRequest) pages over the customer's billing accounts matching the supplied criteria, while getByAccountNumber(String) and getByAccountId(String) fetch a single account by its number or id respectively.

  • Method Details

    • search

      PaginatedList<BillingAccountV2> search(BillingAccountSearchRequest request)
      Searches the customer's billing accounts using the supplied criteria.
      Parameters:
      request - the search criteria
      Returns:
      a paginated list of matching billing accounts

    • getByAccountNumber

      BillingAccountV2 getByAccountNumber(String accountNumber)
      Returns a single billing account by its account number.
      Parameters:
      accountNumber - the billing account number
      Returns:
      the billing account detail

    • getByAccountId

      BillingAccountV2 getByAccountId(String accountId)
      Returns a single billing account by its account id.
      Parameters:
      accountId - the billing account id
      Returns:
      the billing account detail