Replace a contract line item

PUT /api/customers/{id}/contracts/{contractId}/line-items/{itemId} on the Vigilbase One API.

PUT/api/customers/{id}/contracts/{contractId}/line-items/{itemId}

Authorizations

Send one of these:

AuthorizationstringAccess tokenheaderrequired

Bearer access token from Vigilbase Identity (auth.vigilbase.com), sent as Authorization: Bearer <token>. The CLI gets one with vigilbase login.

AuthorizationstringAPI keyheaderrequired

Organisation API key (vb_one_…) from Settings → API keys in Vigilbase One, sent as Authorization: Bearer vb_one_…. Needs a key with write access: read-only keys get 403 with the code read_only_key. See organisation API keys.

Permissions checkedwrite:contracts

Path Parameters

idstringrequired

contractIdstringrequired

itemIdstringrequired

Body

application/json

namestring

min length 1

descriptionstring | null

quantityinteger

maximum 9007199254740991

unit_pricenumber

minimum 0

cost_pricenumber | null

stripe_subscription_item_idstring | null

stripe_price_idstring | null

stripe_product_idstring | null

service_idany

quantity_limitany

quantity_unitstring | null

bandwidth_limit_tbany

requests_limit_millionsany

is_activeboolean

included_quantityany

overage_ratenumber | null

metadataobject

Response

Success

# Token from `vigilbase login`, or a write API key (vb_one_…)
curl --request PUT \
  --url 'https://one.vigilbase.com/api/customers/{id}/contracts/{contractId}/line-items/{itemId}' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"name":"<string>","description":"<string>","quantity":123,"unit_price":123,"cost_price":123,"stripe_subscription_item_id":"<string>","stripe_price_id":"<string>","stripe_product_id":"<string>","service_id":"<any>","quantity_limit":"<any>","quantity_unit":"<string>","bandwidth_limit_tb":"<any>","requests_limit_millions":"<any>","is_active":true,"included_quantity":"<any>","overage_rate":123,"metadata":{}}'

Set VIGILBASE_TOKEN to an Identity access token or an organisation API key first, or use Try it.

Responses

200Success

401Authentication required

403Not permitted

The catalog doesn't include example response bodies for this endpoint.

Was this page helpful?