GET
/
public
/
user
/
service_adjustment
/
search
curl --request GET \
  --url https://api.pingproxies.com/1.0/public/user/service_adjustment/search \
  --header 'X-API-Private-Key: <api-key>' \
  --header 'X-API-Public-Key: <api-key>'
{
  "data": [
    {
      "invoice_id": "in_1NpRIvB2BUlqim5lN4v3URka",
      "service_adjustment_creation_datetime": "2023-09-14 18:30:00",
      "service_adjustment_eval": {
        "service_expiry_datetime": [
          "2023-09-14 18:30:00",
          "2024-09-14 18:30:00"
        ]
      },
      "service_adjustment_id": 213,
      "service_adjustment_is_administrator": false,
      "service_adjustment_is_automatic": true,
      "service_adjustment_is_customer": true,
      "service_adjustment_last_update_datetime": "2023-09-15 18:30:00",
      "service_adjustment_post": {
        "service_expiry_datetime": "2024-09-14 18:30:00"
      },
      "service_adjustment_pre": {
        "service_expiry_datetime": "2023-09-14 18:30:00"
      },
      "service_adjustment_status": "complete",
      "service_adjustment_type": "extension",
      "service_id": "API-1234-5678"
    }
  ],
  "item_count": 1,
  "message": "Service Adjustment 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

​
invoice_id
string

ID of the invoice

​
service_id
string

Service ID associated with the service adjustment

​
service_adjustment_id
integer

ID of the service adjustment

​
service_adjustment_type
enum<string>

Type of the service adjustment

Available options:
ingestion,
fulfillment,
update,
proxy_replacement,
extension,
cancel
​
service_adjustment_status
enum<string>

Current status of the service adjustment

Available options:
pending,
complete,
failed
​
service_adjustment_is_administrator
boolean

Whether the adjustment was made by an administrator

​
service_adjustment_is_automatic
boolean

Whether the adjustment was made automatically

​
service_adjustment_is_customer
boolean

Whether the adjustment was made by a customer

​
service_adjustment_creation_datetime
string

Datetime the service adjustment was created

​
service_adjustment_last_update_datetime
string

Datetime the service adjustment was last updated

​
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 Service Adjustment search

Service Adjustment search was successful.

​
data
object[]

Array of Service Adjustment items matching the search criteria up to the limit of per_page paramater.

​
item_count
integer

Total number of Service Adjustment 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 Service Adjustment items returned per page.

​
total_count
integer

Total of Service Adjustment items that match the search filter.