Add service to contract line

Adds one service configuration to a contract line; rejects duplicates.

Path parameters

idstring <uuid>Required

Contract line UUID from contract_lines.contract_line_id.

Request body

Content type: application/json · schema ContractLineAddServiceBody

service_idstring <uuid>Required

quantitynumber

Seat/unit count. Must be at least 1 for a bundle service; zero or more (whole number) when type_config.pricing_basis is "unit" (zero bills zero).

≥ 0

custom_ratenumber

≥ 0

configuration_typestring

Enum: FixedHourlyUsageBucket

type_configobject

Type-specific configuration. For a Fixed service, set pricing_basis to "unit" to bill quantity x base_rate every period (base_rate is the unit rate in minor units of the contract currency; omit or null to follow the catalog price in the contract currency). The default "bundle" keeps the line total authoritative. Per-unit pricing is not available for products or non-Fixed lines.

Response body

Success response 201 · 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

201

Service added to contract line.

400

Invalid request payload.

401

x-api-key missing at middleware.

500

Request context missing or service-level validation failure.

POST /api/v1/contract-lines/{id}/services

cURL

curl -X POST "https://algapsa.com/api/v1/contract-lines/{id}/services" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "service_id": "01HN2K7VRB9PQ3Y0000000000",
  "quantity": 0,
  "custom_rate": 0,
  "configuration_type": "Fixed",
  "type_config": {}
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/contract-lines/{id}/services", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "service_id": "01HN2K7VRB9PQ3Y0000000000",
    "quantity": 0,
    "custom_rate": 0,
    "configuration_type": "Fixed",
    "type_config": {}
  })
});
const data = await response.json();

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

201 OK·application/json

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