curl --request PATCH \
--url https://api.stigg.io/api/v1/contracts/{id}/billing/terms \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"activationStartDate": "2023-11-07T05:31:56Z",
"activationEndDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"netTerms": 123
}
'import requests
url = "https://api.stigg.io/api/v1/contracts/{id}/billing/terms"
payload = {
"activationStartDate": "2023-11-07T05:31:56Z",
"activationEndDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"netTerms": 123
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
activationStartDate: '2023-11-07T05:31:56Z',
activationEndDate: '2023-11-07T05:31:56Z',
currency: '<string>',
netTerms: 123
})
};
fetch('https://api.stigg.io/api/v1/contracts/{id}/billing/terms', 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.stigg.io/api/v1/contracts/{id}/billing/terms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'activationStartDate' => '2023-11-07T05:31:56Z',
'activationEndDate' => '2023-11-07T05:31:56Z',
'currency' => '<string>',
'netTerms' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.stigg.io/api/v1/contracts/{id}/billing/terms"
payload := strings.NewReader("{\n \"activationStartDate\": \"2023-11-07T05:31:56Z\",\n \"activationEndDate\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"netTerms\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<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.patch("https://api.stigg.io/api/v1/contracts/{id}/billing/terms")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activationStartDate\": \"2023-11-07T05:31:56Z\",\n \"activationEndDate\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"netTerms\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stigg.io/api/v1/contracts/{id}/billing/terms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"activationStartDate\": \"2023-11-07T05:31:56Z\",\n \"activationEndDate\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"netTerms\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contractId": "<string>",
"externalId": "<string>",
"subTotal": 123,
"totalDiscount": 123,
"totalTax": 123,
"total": 123,
"items": [
{
"itemId": "<string>",
"name": "<string>",
"subTotal": 123,
"discount": 123,
"tax": 123,
"total": 123
}
],
"currency": "<string>",
"activationStartDate": "2023-11-07T05:31:56Z",
"activationEndDate": "2023-11-07T05:31:56Z",
"netTerms": 123,
"legalEntityId": "<string>",
"paymentAccountId": "<string>"
}
}{
"message": "<string>",
"code": "BadUserInput",
"reason": "<string>"
}{
"message": "<string>",
"code": "Unauthenticated"
}{
"message": "<string>",
"code": "IdentityForbidden"
}{
"message": "<string>",
"code": "CustomerNotFound"
}{
"message": "<string>",
"code": "RateLimitExceeded"
}Update a contract
Sets the contract’s period, currency and payment terms — the Terms step in the dashboard. Only supplied fields are written, and each applies to the whole contract. Requires a draft with line items: the terms are stored on them, which is also why the contract period reads back from them.
curl --request PATCH \
--url https://api.stigg.io/api/v1/contracts/{id}/billing/terms \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"activationStartDate": "2023-11-07T05:31:56Z",
"activationEndDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"netTerms": 123
}
'import requests
url = "https://api.stigg.io/api/v1/contracts/{id}/billing/terms"
payload = {
"activationStartDate": "2023-11-07T05:31:56Z",
"activationEndDate": "2023-11-07T05:31:56Z",
"currency": "<string>",
"netTerms": 123
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
activationStartDate: '2023-11-07T05:31:56Z',
activationEndDate: '2023-11-07T05:31:56Z',
currency: '<string>',
netTerms: 123
})
};
fetch('https://api.stigg.io/api/v1/contracts/{id}/billing/terms', 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.stigg.io/api/v1/contracts/{id}/billing/terms",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'activationStartDate' => '2023-11-07T05:31:56Z',
'activationEndDate' => '2023-11-07T05:31:56Z',
'currency' => '<string>',
'netTerms' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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.stigg.io/api/v1/contracts/{id}/billing/terms"
payload := strings.NewReader("{\n \"activationStartDate\": \"2023-11-07T05:31:56Z\",\n \"activationEndDate\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"netTerms\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-KEY", "<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.patch("https://api.stigg.io/api/v1/contracts/{id}/billing/terms")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"activationStartDate\": \"2023-11-07T05:31:56Z\",\n \"activationEndDate\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"netTerms\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stigg.io/api/v1/contracts/{id}/billing/terms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"activationStartDate\": \"2023-11-07T05:31:56Z\",\n \"activationEndDate\": \"2023-11-07T05:31:56Z\",\n \"currency\": \"<string>\",\n \"netTerms\": 123\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contractId": "<string>",
"externalId": "<string>",
"subTotal": 123,
"totalDiscount": 123,
"totalTax": 123,
"total": 123,
"items": [
{
"itemId": "<string>",
"name": "<string>",
"subTotal": 123,
"discount": 123,
"tax": 123,
"total": 123
}
],
"currency": "<string>",
"activationStartDate": "2023-11-07T05:31:56Z",
"activationEndDate": "2023-11-07T05:31:56Z",
"netTerms": 123,
"legalEntityId": "<string>",
"paymentAccountId": "<string>"
}
}{
"message": "<string>",
"code": "BadUserInput",
"reason": "<string>"
}{
"message": "<string>",
"code": "Unauthenticated"
}{
"message": "<string>",
"code": "IdentityForbidden"
}{
"message": "<string>",
"code": "CustomerNotFound"
}{
"message": "<string>",
"code": "RateLimitExceeded"
}Authorizations
Server API Key
Headers
Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.
Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).
Path Parameters
The unique identifier of the entity
1 - 255Body
Input for the contract's terms. Contract-wide: applied across every line item, which is where the period, currency and payment terms are stored.
Response
The contract's recomputed totals.
Response object
A contract's pre-publish totals, with a per line item breakdown — read this before publishing, since after publishing these are the figures the customer is invoiced.
Show child attributes
Show child attributes
Related topics
Update a contractDelete contractScheduled updatesCanceling scheduled updatesGet a list of contracts