Understanding the Residential Ledger object and its role in the Ping Proxies API
Attribute | Type | Description |
---|---|---|
residential_ledger_id | string | Unique identifier for the ledger entry |
residential_ledger_bytes | integer | Amount of bandwidth in bytes associated with this ledger entry |
residential_ledger_requests | integer | Number of requests associated with this ledger entry |
residential_ledger_period_date | string | The date this ledger entry is associated with |
residential_ledger_reason | string | Reason for the ledger entry (e.g., “usage”, “top_up”, “service_purchase”) |
service_id | string | ID of the related service if applicable |
service_adjustment_id | integer | ID of the related service adjustment if applicable |
residential_ledger_creation_datetime | datetime | When the ledger entry was created |
residential_ledger_last_update_datetime | datetime | When the ledger entry was last updated |
Endpoint | Description |
---|---|
GET /public/user/residential_ledger/retrieve/{residential_ledger_id} | Retrieve a specific residential ledger entry |
GET /public/user/residential_ledger/search | Search residential ledger entries with filters |
GET /public/user/residential/summary | Get a summary of residential bandwidth status |
Reason | Description |
---|---|
usage | Daily decrements to the bandwidth pool from proxy usage |
top_up | Increments from purchasing additional bandwidth |
adjustment | Manual adjustments (positive or negative) made by administrators |
residential_ledger_bytes
values add to your bandwidth pool (top-ups, purchases)residential_ledger_bytes
values subtract from your bandwidth pool (usage)residential_ledger_period_date
field indicates the specific day when usage occurred or changes were made/residential/summary
endpoint