Update a contract

Updates a contract’s metadata (name, PO number, activation dates) and optionally re-links its subscriptions. Best-effort re-syncs the change to the connected billing provider.

PATCH /api/v1/contracts/{id}

JavaScript

JavaScript

import Stigg from '@stigg/typescript';

const client = new Stigg({
  apiKey: process.env['STIGG_API_KEY'], // This is the default and can be omitted
});

const contract = await client.v1.contracts.update('x');

console.log(contract.data);

import os
from stigg import Stigg

client = Stigg(
    api_key=os.environ.get("STIGG_API_KEY"),  # This is the default and can be omitted
)
contract = client.v1.contracts.update(
    id="x",
)
print(contract.data)

package main

import (
	"context"
	"fmt"

	"github.com/stiggio/stigg-go"
	"github.com/stiggio/stigg-go/option"
)

func main() {
	client := stigg.NewClient(
		option.WithAPIKey("My API Key"),
	)
	contract, err := client.V1.Contracts.Update(
		context.TODO(),
		"x",
		stigg.V1ContractUpdateParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", contract.Data)
}

package io.stigg.example;

import io.stigg.client.StiggClient;
import io.stigg.client.okhttp.StiggOkHttpClient;
import io.stigg.models.v1.contracts.ContractUpdateParams;
import io.stigg.models.v1.contracts.ContractUpdateResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        StiggClient client = StiggOkHttpClient.fromEnv();

        ContractUpdateResponse contract = client.v1().contracts().update("x");
    }
}

require "stigg"

stigg = Stigg::Client.new(api_key: "My API Key")

contract = stigg.v1.contracts.update("x")

puts(contract)

using System;
using Stigg.Client;
using Stigg.Client.Models.V1.Contracts;

StiggClient client = new();

ContractUpdateParams parameters = new() { ID = "x" };

var contract = await client.V1.Contracts.Update(parameters);

Console.WriteLine(contract);

stigg v1:contracts update \
  --api-key 'My API Key' \
  --id x

curl --request PATCH \
  --url https://api.stigg.io/api/v1/contracts/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "poNumber": "<string>",
  "activationStartDate": "2023-11-07T05:31:56Z",
  "activationEndDate": "2023-11-07T05:31:56Z",
  "subscriptionIds": [
    "<string>"
  ],
  "setupBilling": true
}
'

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.stigg.io/api/v1/contracts/{id}",
  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([
    'name' => '<string>',
    'poNumber' => '<string>',
    'activationStartDate' => '2023-11-07T05:31:56Z',
    'activationEndDate' => '2023-11-07T05:31:56Z',
    'subscriptionIds' => [
        '<string>'
    ],
    'setupBilling' => true
  ]),
  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;
}

200

{
  "data": {
    "contractId": "contract-acme-2026",
    "billingId": "ct_1a2b3c4d",
    "id": "3452155b-deca-4d7f-91e5-82d486dc8bb0",
    "refId": "contract-acme-2026",
    "poNumber": "PO-4821",
    "externalId": "contract-acme-2026",
    "customerExternalId": "customer-acme",
    "name": "PO-4821",
    "state": "ACTIVE",
    "activationStartDate": "2026-01-01T00:00:00.000Z",
    "activationEndDate": "2026-12-31T00:00:00.000Z",
    "createdAt": "2025-12-15T09:30:00.000Z",
    "nextInvoice": {
      "amount": {
        "amount": 4900,
        "currency": "usd"
      },
      "dueDate": "2026-08-01T00:00:00.000Z",
      "periodStart": "2026-07-01T00:00:00.000Z",
      "periodEnd": "2026-08-01T00:00:00.000Z"
    },
    "latestInvoice": {
      "billingId": "inv_abc123",
      "status": "OPEN",
      "createdAt": "2026-07-01T00:00:00.000Z",
      "total": 4900,
      "amountDue": 4900,
      "currency": "usd",
      "pdfUrl": null,
      "requiresAction": false,
      "billingReason": null
    },
    "subscriptions": [
      {
        "subscriptionId": "subscription-acme-platform",
        "planDisplayName": "Enterprise Platform",
        "productDisplayName": "Revvenu"
      }
    ]
  }
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "code": "Unauthenticated"
}

{
  "message": "<string>"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "code": "RateLimitExceeded"
}

Authorizations

X-API-KEY · string · header · required

Server API Key

Headers

X-ACCOUNT-ID · string

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-ID · string

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

id · string · required

The unique identifier of the entity

Required string length: 1 - 255

Body

application/json

Input for updating a contract and optionally re-linking its subscriptions.

name · string | null

New contract name

Maximum string length: 255

poNumber · string | null

New purchase-order number

Maximum string length: 255

activationStartDate · string<date-time>

New activation start date

activationEndDate · string<date-time>

New activation end date

subscriptionIds · string[]

When provided, replaces the set of subscriptions linked to the contract (subscription ref IDs)

When provided, replaces the set of subscriptions linked to the contract (subscription ref IDs)

Required string length: 1 - 255

Pattern: ^[a-zA-Z0-9][a-zA-Z0-9_|.-]*$

setupBilling · boolean

Enable billing on a provision-access-only contract by creating a billing contract in the connected billing provider. Only takes effect when true and the contract has no billing yet; omitting it leaves billing unchanged. Billing is never removed by an update.

Response

200

application/json

The updated contract.

Response object

data · Contract · object · required

A billing contract as reported by the connected billing provider.

Show child attributes