Service Adjustment

Retrieve Service Adjustment

Retrieves a specific Service Adjustment based on the provided ID for the current user's account. The returned adjustment provides details about any modifications or updates made to the user's service.

get/public/user/service_adjustment/retrieve/{service_adjustment_id}

Request

Base URL
https://api.byteful.com/1.0
Auth
API key in header X-API-Private-Key and API key in header X-API-Public-Key
TypeScript
https://skmtc.dev/byteful/apis/byteful-public-user-api/docs/public/user/service_adjustment/retrieve/:service_adjustment_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

service_adjustment_idstring required

ID of the Service Adjustment to retrieve

Response

Successful Service Adjustment Retrieve

messagestring

Status message for the retrieval.

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"
  },
  "message": "Service Adjustment successfully retrieved."
}

Changes

No recorded changes to this operation across all 1 revision of this API.