Update contract line service

Updates service configuration for one `{id}` + `{serviceId}` pair.

Path parameters

idstring <uuid>Required

Contract line UUID from contract_lines.contract_line_id.

serviceIdstring <uuid>Required

Service UUID from service_catalog.service_id.

Request body

Content type: application/json · schema ContractLineUpdateServiceBody

quantitynumber

New seat/unit count (zero or more, whole number, for a per-unit service; at least 1 for a bundle service). On a per-unit service the change is scheduled as a dated revision effective at the next unbilled period boundary; already-invoiced periods keep their price.

≥ 0

custom_ratenumber

≥ 0

type_configobject

For a per-unit Fixed service, base_rate is the new unit rate (scheduled like a quantity change). pricing_basis may be sent only if it equals the stored basis; it cannot be changed after the service is added.

rate_tiersarray of object

itemsobject

user_type_ratesarray of object

itemsobject

Response body

Success response 200 · schema ContractLineApiSuccess

successbooleanRequired

Enum: true

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

timestampstring <date-time>Required

versionstringRequired

Response codes

200

Service configuration updated.

400

Invalid request payload.

401

x-api-key missing at middleware.

500

Request context missing or service failure.

PUT /api/v1/contract-lines/{id}/services/{serviceId}

cURL

curl -X PUT "https://algapsa.com/api/v1/contract-lines/{id}/services/{serviceId}" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "quantity": 0,
  "custom_rate": 0,
  "type_config": {},
  "rate_tiers": [
    {}
  ],
  "user_type_rates": [
    {}
  ]
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contract-lines/{id}/services/{serviceId}", {
  method: "PUT",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "quantity": 0,
    "custom_rate": 0,
    "type_config": {},
    "rate_tiers": [
      {}
    ],
    "user_type_rates": [
      {}
    ]
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Put, "https://algapsa.com/api/v1/contract-lines/{id}/services/{serviceId}");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""quantity"": 0,
  ""custom_rate"": 0,
  ""type_config"": {},
  ""rate_tiers"": [
    {}
  ],
  ""user_type_rates"": [
    {}
  ]
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "success": true,
  "data": {},
  "meta": {
    "timestamp": "2026-04-18T15:22:14Z",
    "version": "string"
  }
}