Skip to main content
GET
/
public
/
user
/
residential_ledger
/
retrieve
/
{residential_ledger_id}
Retrieve Residential Ledger
curl --request GET \
  --url https://api.pingproxies.com/1.0/public/user/residential_ledger/retrieve/{residential_ledger_id} \
  --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"
  },
  "message": "Residential Ledger successfully retrieved."
}

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.

Path Parameters

​
residential_ledger_id
string
required

ID of the Residential Ledger to retrieve

Response

200 - application/json

Successful Residential Ledger Retrieve

Residential Ledger retrieve was successful.

​
data
object

Retrieved Residential Ledger item details.

​
message
string

Status message for the retrieval.