Create a customer contract

POST /api/customers/{id}/contracts on the Vigilbase One API.

POST/api/customers/{id}/contracts

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

Body

application/json

namestringrequired

min length 1

descriptionstring | null

statusstringrequired

One of:draftpendingactiveexpiredterminated

effective_dateany

expiration_dateany

signed_dateany

hubspot_deal_idstring | null

stripe_subscription_idstring | null

commonpaper_agreement_idstring | null

commonpaper_urlany

total_valuenumber | null

currencystring

Default:"USD"min length 3max length 3

billing_frequencyany

auto_renewalboolean

Default:false

renewal_notice_daysinteger

Default:30minimum 0maximum 9007199254740991

notesstring | null

metadataobject

linked_customer_idany

renews_contract_idany

created_bystring | null

Response

Success

# Token from `vigilbase login`, or a write API key (vb_one_…)
curl --request POST \
  --url 'https://one.vigilbase.com/api/customers/{id}/contracts' \
  --header "Authorization: Bearer $VIGILBASE_TOKEN" \
  --header 'Content-Type: application/json' \
  --data '{"name":"<string>","description":"<string>","status":"draft","effective_date":"<any>","expiration_date":"<any>","signed_date":"<any>","hubspot_deal_id":"<string>","stripe_subscription_id":"<string>","commonpaper_agreement_id":"<string>","commonpaper_url":"<any>","total_value":123,"currency":"USD","billing_frequency":"<any>","auto_renewal":false,"renewal_notice_days":30,"notes":"<string>","metadata":{},"linked_customer_id":"<any>","renews_contract_id":"<any>","created_by":"<string>"}'

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?