Contract Lines API

A contract line is a single priced item on a contract. It carries the rate rules and the services they apply to. This API defines lines, configures how they bill, and edits them one at a time or in bulk.

Pick a billing type

Three fields are required: contract_line_name, billing_frequency, and contract_line_type. The type drives everything else: Fixed bills a flat amount per period, Hourly bills logged time at hourly_rate (with minimum_billable_time, round_up_to_nearest, and overtime fields), and Usage bills metered consumption.

curl https://algapsa.com/api/v1/contract-lines \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contract_line_name": "Tier 2 remote support",
    "contract_line_type": "Hourly",
    "billing_frequency": "monthly",
    "hourly_rate": 14500,
    "minimum_billable_time": 15,
    "round_up_to_nearest": 15
  }'

Services and configuration

A line bills against the services on it. List them with GET /contract-lines/{id}/services, add one with POST /contract-lines/{id}/services, and adjust the per-service rate through PUT /contract-lines/{id}/services/{serviceId}. Fixed lines also carry their own settings at GET and PUT /contract-lines/{id}/fixed-config. Toggle a line on or off with PUT /contract-lines/{id}/activation and clone an existing one with POST /contract-lines/{id}/copy.

Bulk edits and metrics

When you are rolling out a rate change, the /contract-lines/bulk routes create, update, and delete many lines in one call, and /contract-lines/bulk/add-services attaches a service across them. For reporting, read GET /contract-lines/{id}/usage-metrics and /analytics.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.