Interface BillingAccounts

All Known Implementing Classes:
BillingAccountsImpl
public interface BillingAccounts
Client interface for viewing billing accounts and downloading invoice documents in the Equinix Customer Portal.

Backed by the Billing v1 API at /v1/finance/accounts. summaries() pages over the billing accounts the current user may view, getByAccountNumber(String) fetches a single account's summary, and downloadInvoiceDocument(String, String, String) retrieves an invoice document as raw bytes.

  • Method Details

    • summaries

      PaginatedList<BillingAccount> summaries()
      Pages over a summary of all the billing accounts that the current user has permission to view.
      Returns:
      a paginated list of billing account summaries

    • summaries

      PaginatedList<BillingAccount> summaries(String sorts)
      Pages over a summary of all the billing accounts that the current user has permission to view, sorted by the supplied sort specifier.
      Parameters:
      sorts - the sort specifier, e.g. "ACCOUNT_NUMBER" ascending or "-ACCOUNT_NUMBER" descending (may be null)
      Returns:
      a paginated list of billing account summaries

    • getByAccountNumber

      BillingAccount getByAccountNumber(String accountNumber)
      Returns the billing summary of a single account by its account number.
      Parameters:
      accountNumber - the billing account number
      Returns:
      the billing account summary

    • getByAccountNumber

      BillingAccount getByAccountNumber(String accountNumber, String months)
      Returns the billing detail of a single account by its account number, restricting the available finance documents to the supplied months.
      Parameters:
      accountNumber - the billing account number
      months - the months to pull finance documents for, as a comma-separated list of ISO local dates (e.g. "2017-12-03,2018-01-03"); may be null
      Returns:
      the billing account detail

    • downloadInvoiceDocument

      byte[] downloadInvoiceDocument(String accountNumber, String invoiceId, String documentId)
      Downloads a specific invoice document for an account by its invoice and document identifiers.
      Parameters:
      accountNumber - the billing account number
      invoiceId - the invoice identifier
      documentId - the document identifier
      Returns:
      the document content as raw bytes