Get service usage

Traffic counters are bytes; GB balances are decimal gigabytes (1 GB = 1,000,000,000 bytes). Read last_updated_at and provider_observed_at for freshness. Provider balances are present for GB services.

get/v1/services/{id}/usage

Request

  • Base URL: https://api.trueproxies.com
  • URL: https://api.trueproxies.com/v1/services/{id}/usage
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

customer_idstring uuid

Owned sub-customer UUID. Resellers only; reads require reseller:read and writes reseller:purchase in addition to the operation scope. X-Customer-Id header is an alternative. Not allowed for me, wallet, trial, API keys, or reseller-management routes.

Response

ok

allowance_bytesinteger required
bytes_ininteger required

Bytes the proxy read from the client, which is the customer's upload.

bytes_outinteger required

Bytes the proxy wrote back to the client, which is the customer's download.

current_period_used_bytesinteger

Traffic counted against the current allowance period. Lifetime totals remain in bytes_in and bytes_out.

gb_allocatednumber

Informational provider balance in decimal GB; billing uses node byte counters.

gb_remainingnumber

Informational provider balance in decimal GB; billing uses node byte counters.

gb_usednumber

Informational provider balance in decimal GB; billing uses node byte counters.

last_updated_atstring date-time required
next_reset_atstring date-time

Next scheduled allowance reset; a past timestamp means confirmation is pending.

period_started_atstring date-time

Start of the current confirmed allowance period, when applicable.

provider_observed_atstring date-time
provider_usage_informationaltrue required
remaining_bytesinteger required

Node allowance remaining, floored at zero.

service_idstring uuid required
usage_source'node' required

Billing usage comes from durable, deduplicated node byte counters.

Changes

No recorded changes to this operation across all 1 revision of this API.