curl --request PUT \
--url https://api.zenskar.com/contract_v2/{contract_id} \
--header 'Content-Type: application/json' \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Annual Subscription - Acme Corp",
"status": "active",
"currency": "USD",
"start_date": "2025-01-01T00:00:00",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"description": "<string>",
"tags": [
"<unknown>"
],
"end_date": "2023-11-07T05:31:56Z",
"anchor_date": "2023-11-07T05:31:56Z",
"is_last_day_of_month": true,
"custom_attributes": {},
"phases": [
{
"name": "Standard Phase",
"pricings": [
{
"pricing_id": "6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3",
"product_id": "c19a0ece-63c3-412b-8549-e722bc28605d"
}
]
}
],
"contract_link": "<string>",
"bill_parent_customer": true,
"invoice_payer_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_in_renewal": true,
"source": {}
}
'import requests
url = "https://api.zenskar.com/contract_v2/{contract_id}"
payload = {
"name": "Annual Subscription - Acme Corp",
"status": "active",
"currency": "USD",
"start_date": "2025-01-01T00:00:00",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"description": "<string>",
"tags": ["<unknown>"],
"end_date": "2023-11-07T05:31:56Z",
"anchor_date": "2023-11-07T05:31:56Z",
"is_last_day_of_month": True,
"custom_attributes": {},
"phases": [
{
"name": "Standard Phase",
"pricings": [
{
"pricing_id": "6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3",
"product_id": "c19a0ece-63c3-412b-8549-e722bc28605d"
}
]
}
],
"contract_link": "<string>",
"bill_parent_customer": True,
"invoice_payer_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_in_renewal": True,
"source": {}
}
headers = {
"x-api-key": "<api-key>",
"organisation": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
organisation: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Annual Subscription - Acme Corp',
status: 'active',
currency: 'USD',
start_date: '2025-01-01T00:00:00',
customer_id: '123e4567-e89b-12d3-a456-426614174000',
description: '<string>',
tags: ['<unknown>'],
end_date: '2023-11-07T05:31:56Z',
anchor_date: '2023-11-07T05:31:56Z',
is_last_day_of_month: true,
custom_attributes: {},
phases: [
{
name: 'Standard Phase',
pricings: [
{
pricing_id: '6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3',
product_id: 'c19a0ece-63c3-412b-8549-e722bc28605d'
}
]
}
],
contract_link: '<string>',
bill_parent_customer: true,
invoice_payer_customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
include_in_renewal: true,
source: {}
})
};
fetch('https://api.zenskar.com/contract_v2/{contract_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zenskar.com/contract_v2/{contract_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Annual Subscription - Acme Corp',
'status' => 'active',
'currency' => 'USD',
'start_date' => '2025-01-01T00:00:00',
'customer_id' => '123e4567-e89b-12d3-a456-426614174000',
'description' => '<string>',
'tags' => [
'<unknown>'
],
'end_date' => '2023-11-07T05:31:56Z',
'anchor_date' => '2023-11-07T05:31:56Z',
'is_last_day_of_month' => true,
'custom_attributes' => [
],
'phases' => [
[
'name' => 'Standard Phase',
'pricings' => [
[
'pricing_id' => '6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3',
'product_id' => 'c19a0ece-63c3-412b-8549-e722bc28605d'
]
]
]
],
'contract_link' => '<string>',
'bill_parent_customer' => true,
'invoice_payer_customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'include_in_renewal' => true,
'source' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"organisation: <api-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zenskar.com/contract_v2/{contract_id}"
payload := strings.NewReader("{\n \"name\": \"Annual Subscription - Acme Corp\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"start_date\": \"2025-01-01T00:00:00\",\n \"customer_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"anchor_date\": \"2023-11-07T05:31:56Z\",\n \"is_last_day_of_month\": true,\n \"custom_attributes\": {},\n \"phases\": [\n {\n \"name\": \"Standard Phase\",\n \"pricings\": [\n {\n \"pricing_id\": \"6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3\",\n \"product_id\": \"c19a0ece-63c3-412b-8549-e722bc28605d\"\n }\n ]\n }\n ],\n \"contract_link\": \"<string>\",\n \"bill_parent_customer\": true,\n \"invoice_payer_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_in_renewal\": true,\n \"source\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("organisation", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.zenskar.com/contract_v2/{contract_id}")
.header("x-api-key", "<api-key>")
.header("organisation", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Annual Subscription - Acme Corp\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"start_date\": \"2025-01-01T00:00:00\",\n \"customer_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"anchor_date\": \"2023-11-07T05:31:56Z\",\n \"is_last_day_of_month\": true,\n \"custom_attributes\": {},\n \"phases\": [\n {\n \"name\": \"Standard Phase\",\n \"pricings\": [\n {\n \"pricing_id\": \"6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3\",\n \"product_id\": \"c19a0ece-63c3-412b-8549-e722bc28605d\"\n }\n ]\n }\n ],\n \"contract_link\": \"<string>\",\n \"bill_parent_customer\": true,\n \"invoice_payer_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_in_renewal\": true,\n \"source\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zenskar.com/contract_v2/{contract_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["organisation"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Annual Subscription - Acme Corp\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"start_date\": \"2025-01-01T00:00:00\",\n \"customer_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"anchor_date\": \"2023-11-07T05:31:56Z\",\n \"is_last_day_of_month\": true,\n \"custom_attributes\": {},\n \"phases\": [\n {\n \"name\": \"Standard Phase\",\n \"pricings\": [\n {\n \"pricing_id\": \"6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3\",\n \"product_id\": \"c19a0ece-63c3-412b-8549-e722bc28605d\"\n }\n ]\n }\n ],\n \"contract_link\": \"<string>\",\n \"bill_parent_customer\": true,\n \"invoice_payer_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_in_renewal\": true,\n \"source\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"currency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"customer_name": "<string>",
"custom_data": {},
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"country_code": "<string>",
"validation_status": "<string>",
"connector_validation": {}
},
"ship_to_address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"country_code": "<string>",
"validation_status": "<string>",
"connector_validation": {}
},
"tax_info": [],
"email": "<string>",
"custom_attributes": {},
"phone_number": "<string>",
"communications_enabled": true,
"auto_charge_enabled": true,
"business_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"tags": [
"<unknown>"
],
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"custom_attributes": {},
"source": {},
"anchor_date": "2023-11-07T05:31:56Z",
"is_last_day_of_month": true,
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"renewal_policy": "do_not_renew",
"phases": [],
"invoice_payer_customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"customer_name": "<string>",
"custom_data": {},
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"country_code": "<string>",
"validation_status": "<string>",
"connector_validation": {}
},
"ship_to_address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"country_code": "<string>",
"validation_status": "<string>",
"connector_validation": {}
},
"tax_info": [],
"email": "<string>",
"custom_attributes": {},
"phone_number": "<string>",
"communications_enabled": true,
"auto_charge_enabled": true,
"business_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"current_phase": {
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"phase_type": "active",
"phase_metadata": {}
},
"contract_link": "<string>",
"bill_parent_customer": false,
"invoice_payer_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": "Validation error: start_date must be before end_date"
}{
"detail": "Contract with id 123e4567-e89b-12d3-a456-426614174000 not found"
}{
"detail": [
{
"loc": [
"body",
"currency"
],
"msg": "Invalid currency: XYZ",
"type": "value_error"
}
]
}{
"detail": "An unexpected error occurred"
}Update contract
Update an existing contract with new details.
Allows modification of contract terms including name, status, dates, currency, customer, phases, and custom attributes. All fields from the create schema are supported. This operation replaces the entire contract, so include all fields you want to retain.
curl --request PUT \
--url https://api.zenskar.com/contract_v2/{contract_id} \
--header 'Content-Type: application/json' \
--header 'organisation: <api-key>' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "Annual Subscription - Acme Corp",
"status": "active",
"currency": "USD",
"start_date": "2025-01-01T00:00:00",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"description": "<string>",
"tags": [
"<unknown>"
],
"end_date": "2023-11-07T05:31:56Z",
"anchor_date": "2023-11-07T05:31:56Z",
"is_last_day_of_month": true,
"custom_attributes": {},
"phases": [
{
"name": "Standard Phase",
"pricings": [
{
"pricing_id": "6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3",
"product_id": "c19a0ece-63c3-412b-8549-e722bc28605d"
}
]
}
],
"contract_link": "<string>",
"bill_parent_customer": true,
"invoice_payer_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_in_renewal": true,
"source": {}
}
'import requests
url = "https://api.zenskar.com/contract_v2/{contract_id}"
payload = {
"name": "Annual Subscription - Acme Corp",
"status": "active",
"currency": "USD",
"start_date": "2025-01-01T00:00:00",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"description": "<string>",
"tags": ["<unknown>"],
"end_date": "2023-11-07T05:31:56Z",
"anchor_date": "2023-11-07T05:31:56Z",
"is_last_day_of_month": True,
"custom_attributes": {},
"phases": [
{
"name": "Standard Phase",
"pricings": [
{
"pricing_id": "6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3",
"product_id": "c19a0ece-63c3-412b-8549-e722bc28605d"
}
]
}
],
"contract_link": "<string>",
"bill_parent_customer": True,
"invoice_payer_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"include_in_renewal": True,
"source": {}
}
headers = {
"x-api-key": "<api-key>",
"organisation": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {
'x-api-key': '<api-key>',
organisation: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: 'Annual Subscription - Acme Corp',
status: 'active',
currency: 'USD',
start_date: '2025-01-01T00:00:00',
customer_id: '123e4567-e89b-12d3-a456-426614174000',
description: '<string>',
tags: ['<unknown>'],
end_date: '2023-11-07T05:31:56Z',
anchor_date: '2023-11-07T05:31:56Z',
is_last_day_of_month: true,
custom_attributes: {},
phases: [
{
name: 'Standard Phase',
pricings: [
{
pricing_id: '6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3',
product_id: 'c19a0ece-63c3-412b-8549-e722bc28605d'
}
]
}
],
contract_link: '<string>',
bill_parent_customer: true,
invoice_payer_customer_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
include_in_renewal: true,
source: {}
})
};
fetch('https://api.zenskar.com/contract_v2/{contract_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zenskar.com/contract_v2/{contract_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Annual Subscription - Acme Corp',
'status' => 'active',
'currency' => 'USD',
'start_date' => '2025-01-01T00:00:00',
'customer_id' => '123e4567-e89b-12d3-a456-426614174000',
'description' => '<string>',
'tags' => [
'<unknown>'
],
'end_date' => '2023-11-07T05:31:56Z',
'anchor_date' => '2023-11-07T05:31:56Z',
'is_last_day_of_month' => true,
'custom_attributes' => [
],
'phases' => [
[
'name' => 'Standard Phase',
'pricings' => [
[
'pricing_id' => '6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3',
'product_id' => 'c19a0ece-63c3-412b-8549-e722bc28605d'
]
]
]
],
'contract_link' => '<string>',
'bill_parent_customer' => true,
'invoice_payer_customer_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'include_in_renewal' => true,
'source' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"organisation: <api-key>",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.zenskar.com/contract_v2/{contract_id}"
payload := strings.NewReader("{\n \"name\": \"Annual Subscription - Acme Corp\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"start_date\": \"2025-01-01T00:00:00\",\n \"customer_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"anchor_date\": \"2023-11-07T05:31:56Z\",\n \"is_last_day_of_month\": true,\n \"custom_attributes\": {},\n \"phases\": [\n {\n \"name\": \"Standard Phase\",\n \"pricings\": [\n {\n \"pricing_id\": \"6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3\",\n \"product_id\": \"c19a0ece-63c3-412b-8549-e722bc28605d\"\n }\n ]\n }\n ],\n \"contract_link\": \"<string>\",\n \"bill_parent_customer\": true,\n \"invoice_payer_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_in_renewal\": true,\n \"source\": {}\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("organisation", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.zenskar.com/contract_v2/{contract_id}")
.header("x-api-key", "<api-key>")
.header("organisation", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Annual Subscription - Acme Corp\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"start_date\": \"2025-01-01T00:00:00\",\n \"customer_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"anchor_date\": \"2023-11-07T05:31:56Z\",\n \"is_last_day_of_month\": true,\n \"custom_attributes\": {},\n \"phases\": [\n {\n \"name\": \"Standard Phase\",\n \"pricings\": [\n {\n \"pricing_id\": \"6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3\",\n \"product_id\": \"c19a0ece-63c3-412b-8549-e722bc28605d\"\n }\n ]\n }\n ],\n \"contract_link\": \"<string>\",\n \"bill_parent_customer\": true,\n \"invoice_payer_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_in_renewal\": true,\n \"source\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zenskar.com/contract_v2/{contract_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["organisation"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Annual Subscription - Acme Corp\",\n \"status\": \"active\",\n \"currency\": \"USD\",\n \"start_date\": \"2025-01-01T00:00:00\",\n \"customer_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"description\": \"<string>\",\n \"tags\": [\n \"<unknown>\"\n ],\n \"end_date\": \"2023-11-07T05:31:56Z\",\n \"anchor_date\": \"2023-11-07T05:31:56Z\",\n \"is_last_day_of_month\": true,\n \"custom_attributes\": {},\n \"phases\": [\n {\n \"name\": \"Standard Phase\",\n \"pricings\": [\n {\n \"pricing_id\": \"6cd431e4-d3d4-43dc-b0c4-9c6988a6c1b3\",\n \"product_id\": \"c19a0ece-63c3-412b-8549-e722bc28605d\"\n }\n ]\n }\n ],\n \"contract_link\": \"<string>\",\n \"bill_parent_customer\": true,\n \"invoice_payer_customer_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"include_in_renewal\": true,\n \"source\": {}\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "draft",
"currency": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"customer_name": "<string>",
"custom_data": {},
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"country_code": "<string>",
"validation_status": "<string>",
"connector_validation": {}
},
"ship_to_address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"country_code": "<string>",
"validation_status": "<string>",
"connector_validation": {}
},
"tax_info": [],
"email": "<string>",
"custom_attributes": {},
"phone_number": "<string>",
"communications_enabled": true,
"auto_charge_enabled": true,
"business_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"description": "<string>",
"tags": [
"<unknown>"
],
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"custom_attributes": {},
"source": {},
"anchor_date": "2023-11-07T05:31:56Z",
"is_last_day_of_month": true,
"plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"renewal_policy": "do_not_renew",
"phases": [],
"invoice_payer_customer": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_id": "<string>",
"customer_name": "<string>",
"custom_data": {},
"address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"country_code": "<string>",
"validation_status": "<string>",
"connector_validation": {}
},
"ship_to_address": {
"line1": "<string>",
"line2": "<string>",
"line3": "<string>",
"city": "<string>",
"state": "<string>",
"zipCode": "<string>",
"country": "<string>",
"country_code": "<string>",
"validation_status": "<string>",
"connector_validation": {}
},
"tax_info": [],
"email": "<string>",
"custom_attributes": {},
"phone_number": "<string>",
"communications_enabled": true,
"auto_charge_enabled": true,
"business_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"current_phase": {
"name": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"start_date": "2023-11-07T05:31:56Z",
"end_date": "2023-11-07T05:31:56Z",
"phase_type": "active",
"phase_metadata": {}
},
"contract_link": "<string>",
"bill_parent_customer": false,
"invoice_payer_customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": "Validation error: start_date must be before end_date"
}{
"detail": "Contract with id 123e4567-e89b-12d3-a456-426614174000 not found"
}{
"detail": [
{
"loc": [
"body",
"currency"
],
"msg": "Invalid currency: XYZ",
"type": "value_error"
}
]
}{
"detail": "An unexpected error occurred"
}Authorizations
Path Parameters
Body
Human-readable name for the contract. Used for identification and reporting purposes.
Contract status. Only 'active' and 'draft' are accepted. Other statuses (expired, paused) are managed via dedicated endpoints.
draft, active, paused, expired, disputed Three-letter ISO 4217 currency code for all monetary amounts in this contract (e.g., 'USD', 'EUR', 'GBP'). Must match customer's billing currency or be explicitly configured.
Date when the contract becomes active and billing begins. Must be in ISO 8601 format. Used as the basis for billing cycle calculations and revenue recognition.
The unique identifier of the customer who is party to this contract. Customer must exist in the system before contract creation.
Detailed description of the contract terms, scope, or special conditions. Displayed in contract details and reports.
Optional list of tags for categorizing and filtering contracts (e.g., ['enterprise', 'annual', 'discounted']). Useful for reporting and segmentation.
Optional date when the contract expires. If not provided, contract continues indefinitely until manually terminated. Must be after start_date. Used for automatic expiration and renewal calculations.
Reference date for billing cycle calculations. When set, all billing cycles align to this date regardless of contract start. Useful for ensuring consistent billing dates across multiple contracts.
When true, billing cycles always end on the last day of the month, adjusting for varying month lengths. Commonly used for monthly subscriptions billed on the last day.
Flexible key-value store for organization-specific metadata. Can include fields like sales_rep, deal_id, region, or any custom data needed for reporting and integrations.
List of contract phases defining distinct periods with different terms, products, or pricing. Common use cases include trial periods, promotional pricing, or stepped pricing models. Phases must not overlap and must fall within contract date boundaries.
Show child attributes
Show child attributes
Defines contract renewal behavior. Currently only 'do_not_renew' is supported—contracts must be manually renewed or replaced. Additional renewal options coming soon.
renew_with_default_contract, renew_with_existing, do_not_renew URL to external contract document, signed agreement, or related resource. Useful for maintaining references to legal documents stored in external systems.
When true and customer has a parent relationship, invoices are sent to the parent customer instead. Used for hierarchical billing scenarios like subsidiaries or franchises.
Optional customer ID who will receive and pay invoices for this contract, if different from the contract customer. Used when one entity uses services but another pays for them.
When true, this contract is eligible for renewal processes. Set to false to exclude from automatic renewal workflows.
Metadata about the originating system or process that created this contract. Commonly includes fields like 'system', 'opportunity_id', or 'contract_number' for integration tracking and audit trails.
Response
Contract updated successfully
Unique identifier for this contract
Human-readable name for the contract. Used for identification and reporting purposes.
Current status of the contract (e.g., active, draft, expired, terminated). System automatically updates to 'expired' when end_date is reached.
draft, active, paused, expired, disputed Three-letter ISO 4217 currency code for all monetary amounts in this contract (e.g., 'USD', 'EUR', 'GBP').
Timestamp when this contract was created in the system. Used for audit trails and reporting.
Timestamp of the last modification to this contract. Updates whenever any field or related entity changes.
Unique identifier of the customer who is party to this contract.
Complete customer details including name, contact information, and billing preferences. The customer who is party to this contract.
Show child attributes
Show child attributes
Detailed description of the contract terms, scope, or special conditions.
List of tags for categorizing and filtering contracts. Useful for reporting and segmentation.
Date when the contract became or will become active. Billing and revenue recognition calculations start from this date.
Date when the contract expires. Null indicates an indefinite contract that continues until manually terminated.
Organization-specific metadata stored as key-value pairs. Can include fields like sales_rep, deal_id, region, or any custom data needed for reporting and integrations.
Metadata about the originating system or process that created this contract. Used for integration tracking and audit trails.
Reference date for billing cycle calculations. When set, billing cycles align to this date regardless of contract start date.
When true, billing cycles always end on the last day of the month, adjusting for varying month lengths.
Reference to the plan template used to create this contract, if applicable.
Defines contract renewal behavior. Currently only 'do_not_renew' is supported—contracts must be manually renewed or replaced.
renew_with_default_contract, renew_with_existing, do_not_renew List of contract phases defining distinct periods with different terms, products, or pricing. Sorted chronologically by start date.
Show child attributes
Show child attributes
Customer details for the invoice payer, if different from the contract customer. Used when one entity uses services but another pays for them.
Show child attributes
Show child attributes
The contract phase that is currently active based on today's date. Null if no phase is active or contract hasn't started.
Show child attributes
Show child attributes
URL to external contract document, signed agreement, or related resource.
When true and customer has a parent relationship, invoices are sent to the parent customer instead.
Customer ID who will receive and pay invoices for this contract, if different from the contract customer.