v1

latestOpenAPI 3.0.32026-07-2246176.0 KB
Residential

Residential overview

Get residential subscription overview: plan, bandwidth used/remaining, status. Permission: residential:read.

get/v4/account/{subAccountId}/residential/overview

Path parameters

subAccountIdstring uuid required

Response

Residential overview

planstring
bandwidth_usedinteger
bandwidth_limitinteger
statusstring