Skip to main content
GET
/
public
/
user
/
service_adjustment
/
retrieve
/
{service_adjustment_id}
Retrieve Service Adjustment
curl --request GET \
  --url https://api.byteful.com/1.0/public/user/service_adjustment/retrieve/{service_adjustment_id} \
  --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"
  },
  "message": "Service Adjustment successfully retrieved."
}

Documentation Index

Fetch the complete documentation index at: https://documentation.byteful.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
service_adjustment_id
string
required

ID of the Service Adjustment to retrieve

Response

200 - application/json

Successful Service Adjustment Retrieve

Service Adjustment retrieve was successful.

​
data
object

Retrieved Service Adjustment item details.

​
message
string

Status message for the retrieval.