GET
/
public
/
user
/
residential_ledger
/
search
curl --request GET \
  --url https://api.pingproxies.com/1.0/public/user/residential_ledger/search \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
{
  "data": [
    {
      "customer_id": 1955,
      "residential_ledger_bytes": 128290101,
      "residential_ledger_creation_datetime": "2023-04-01 12:00:00",
      "residential_ledger_id": "123e4567-e89b-12d3-a456-426614174000",
      "residential_ledger_last_update_datetime": "2023-04-02 12:00:00",
      "residential_ledger_period_date": "2023-10-01",
      "residential_ledger_reason": "top_up",
      "residential_ledger_requests": 1244,
      "service_adjustment_id": 10,
      "service_id": "API-1234-5678"
    }
  ],
  "item_count": 1,
  "message": "Residential Ledger search successful.",
  "page": 1,
  "per_page": 10,
  "total_count": 1
}

Authorizations

​
X-API-Private-Key
string
header
required

Private API key for user-level authentication.

​
X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Query Parameters

​
residential_ledger_id
string

Unique identifier of the Residential Ledger entry.

​
service_id
string

Service identifier associated with the ledger entry.

​
service_adjustment_id
integer

Adjustment identifier associated with the ledger entry.

​
residential_ledger_reason
string

Reason for the ledger entry.

​
residential_ledger_requests
integer

Number of requests recorded in the ledger entry.

​
residential_ledger_bytes
integer

Data usage in bytes recorded in the ledger entry.

​
residential_ledger_period_date
string

The date of the ledger entry.

​
residential_ledger_creation_datetime
string

Creation datetime of the ledger entry.

​
residential_ledger_last_update_datetime
string

Last update datetime of the ledger entry.

​
per_page
integer

Number of items per page for pagination

​
page
integer

Page number for pagination

​
sort_by
string

Key for sorting or random.

Response

200 - application/json
Successful Residential Ledger search

Residential Ledger search was successful.

​
data
object[]

Array of Residential Ledger items matching the search criteria up to the limit of per_page paramater.

​
item_count
integer

Total number of Residential Ledger items returned in the data field.

​
message
string

Status message for the search.

​
page
integer

Current page number of the search results returned.

​
per_page
integer

Number of Residential Ledger items returned per page.

​
total_count
integer

Total of Residential Ledger items that match the search filter.