Skip to main content
GET
Get bandwidth and usage charges

Authorizations

Authorization
string
header
required

Your organization's active API key.

Query Parameters

from
string<date>

Inclusive UTC start date. Provide both dates, or omit both for the current UTC calendar month.

to
string<date>

Exclusive UTC end date, after from, within 366 days. Use next month's first day for a full month.

credential_id
string<uuid>

Select one credential ID from this response. Cannot combine with username. Missing or inaccessible credentials return 404.

username
string

Base proxy username, without targeting or session suffixes. Cannot combine with credential_id.

Pattern: ^[a-zA-Z0-9_]{1,32}$

Response

Selected credential usage. An empty workspace returns an empty credentials array and zero totals.

from
string<date>
required

Inclusive UTC date.

to
string<date>
required

Exclusive UTC date.

currency
string
required
Allowed value: "usd"
totals
object
required

Wallet charges exclude package purchases, package-funded traffic, subscription fees, top-ups, manual adjustments, and positive ledger entries.

credentials
object[]
required

All current credentials unless filtered, including disabled and unused ones. Excludes deleted credentials. Ordered by username, then ID.