Sign in

v1

latestOpenAPI 3.0.12026-07-265331168.0 KB
Service Adjustment

Search Service Adjustments

Search Service Adjustments on the customer account using various filters.

get/public/user/service_adjustment/search

Query parameters

invoice_idstring

ID of the invoice

service_idstring

Service ID associated with the service adjustment

service_adjustment_idinteger

ID of the service adjustment

service_adjustment_type'ingestion' | 'fulfillment' | 'update' | 'proxy_replacement' | 'extension' | 'cancel' | 'remove_proxy' | 'additional_fulfillment' | 'top_up' | 'top_up_and_extension' | 'cancel'

Type of the service adjustment

service_adjustment_status'pending' | 'complete' | 'failed'

Current status of the service adjustment

service_adjustment_is_administratorboolean

Whether the adjustment was made by an administrator

service_adjustment_is_automaticboolean

Whether the adjustment was made automatically

service_adjustment_is_customerboolean

Whether the adjustment was made by a customer

service_adjustment_creation_datetimestring date-time

Datetime the service adjustment was created

service_adjustment_last_update_datetimestring date-time

Datetime the service adjustment was last updated

per_pageinteger

Number of items per page for pagination

pageinteger

Page number for pagination

sort_bystring

Key for sorting or random.

Response

Successful Service Adjustment search

item_countinteger

Total number of Service Adjustment items returned in the data field.

messagestring

Status message for the search.

pageinteger

Current page number of the search results returned.

per_pageinteger

Number of Service Adjustment items returned per page.

total_countinteger

Total of Service Adjustment items that match the search filter.

Example response

{
  "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
}