Understanding the Service Adjustment object and its role in the Ping Proxies API
Attribute | Type | Description |
---|---|---|
service_adjustment_id | integer | Unique identifier for the service adjustment |
service_id | string | ID of the service that was modified |
service_adjustment_type | string | Type of adjustment (e.g., extension , fulfillment , proxy_replacement ) |
service_adjustment_status | string | Status of the adjustment (pending , complete , failed ) |
service_adjustment_pre | object | JSON representation of the service state before the adjustment |
service_adjustment_post | object | JSON representation of the service state after the adjustment |
service_adjustment_eval | object | Evaluation of changes between pre and post states |
service_adjustment_is_administrator | boolean | Whether the adjustment was made by a Ping Proxies administrator |
service_adjustment_is_automatic | boolean | Whether the adjustment was made automatically by the system |
service_adjustment_is_customer | boolean | Whether the adjustment was made by the customer |
service_adjustment_creation_datetime | datetime | When the adjustment was created |
service_adjustment_last_update_datetime | datetime | When the adjustment was last updated |
invoice_id | string | ID of any invoice associated with the adjustment |
Type | Description |
---|---|
ingestion | Initial creation and ingestion of a service |
fulfillment | Allocation of proxies to a service |
remove_proxy | Removal of proxies from a service |
additional_fulfillment | Adding more proxies to an existing service |
update | General update to service attributes |
proxy_replacement | Replacing proxies with new ones |
extension | Extending the service period |
top_up | Adding additional bandwidth to a residential service |
top_up_and_extension | Both extending service and adding bandwidth |
cancel | Cancellation of a service |
Endpoint | Description |
---|---|
GET /public/user/service_adjustment/retrieve/{service_adjustment_id} | Retrieve a specific service adjustment |
GET /public/user/service_adjustment/search | Search service adjustments with filters |
service_adjustment_pre
and service_adjustment_post
fields store JSON snapshots of the service state before and after the changeservice_adjustment_eval
field provides a side-by-side comparison of changed valuesproxy_replacements
array will be included with details of each replaced proxyservice_adjustment_is_administrator
, service_adjustment_is_automatic
, and service_adjustment_is_customer
flags help identify the origin of the changeproxy_replacement
, the adjustment may contain additional nested objects with details specific to that adjustment type