Update contract

Partially update a contract by its ID. seatItems, fixedItems and subscription replace what the contract holds today, so send the complete set; omit them to leave them untouched. Moving renewalType to fixed retires the subscription. Clearing the date the contract renews on turns its renewal reminder off.

PATCH

/v1/contracts/{id}

PATCH

/contracts/{id}

curl -X PATCH "https://api.corma.io/v1/contracts/-9007199254740991" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "string",
  "renewalType": "fixed",
  "supplierName": "string",
  "stage": "live",
  "paymentMethod": "wire",
  "ownerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "renewalDate": "2026-01-15T09:30:00Z",
  "noticeDate": "2026-01-15T09:30:00Z",
  "lastPaymentDate": "2026-01-15T09:30:00Z",
  "subscription": {
    "frequency": "monthly",
    "nextRenewalDate": "2026-01-15T09:30:00Z"
  },
  "seatItems": [
    {
      "licenseTypeKey": "string",
      "quantity": 0,
      "billingPeriod": "monthly"
    }
  ],
  "fixedItems": [
    {
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly"
    }
  ]
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
integer
path
required
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

currency
string
renewalType
enum<string>
One of:
fixed
subscription
supplierName
string | null
stage
enum<string> | null
One of:
live
cancelled
negotiating
rollout
testing
paymentMethod
enum<string> | null
One of:
wire
card
direct_debit
ownerId
string | null
startDate
any of | null
renewalDate
any of | null
noticeDate
any of | null
lastPaymentDate
any of | null
subscription
ContractSubscriptionBody | null
seatItems
ContractSeatItemBody[]
fixedItems
ContractFixedItemBody[]

Response

application/json200

id
integer
required
applicationInstanceId
integer
required
supplierName
string | null
required
currency
string
required
stage
enum<string> | null
required
One of:
live
cancelled
negotiating
rollout
testing
renewalType
enum<string> | null
required
One of:
fixed
subscription
paymentMethod
enum<string> | null
required
One of:
wire
card
direct_debit
ownerId
string | null
required
The workspace member who owns the contract.
startDate
string<date-time> | null
required
renewalDate
string<date-time> | null
required
noticeDate
string<date-time> | null
required
lastPaymentDate
string<date-time> | null
required
activeAt
string<date-time> | null
required
When set, this is the contract in force for the application instance. Only one contract per application instance is active.
totalCost
string | null
required
A decimal number serialized as a string, so no precision is lost.
subscription
ContractSubscription | null
required
seatItems
ContractSeatItem[]
required
fixedItems
ContractFixedItem[]
required
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": -9007199254740991,
  "applicationInstanceId": -9007199254740991,
  "supplierName": "string",
  "currency": "string",
  "stage": "live",
  "renewalType": "fixed",
  "paymentMethod": "wire",
  "ownerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "renewalDate": "2026-01-15T09:30:00Z",
  "noticeDate": "2026-01-15T09:30:00Z",
  "lastPaymentDate": "2026-01-15T09:30:00Z",
  "activeAt": "2026-01-15T09:30:00Z",
  "totalCost": "string",
  "subscription": {
    "frequency": "monthly",
    "customFrequency": "weekly",
    "customFrequencyFactor": -9007199254740991,
    "nextRenewalDate": "2026-01-15T09:30:00Z"
  },
  "seatItems": [
    {
      "id": -9007199254740991,
      "licenseTypeKey": "string",
      "quantity": -9007199254740991,
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly",
      "isAutoAdjust": true
    }
  ],
  "fixedItems": [
    {
      "id": -9007199254740991,
      "name": "string",
      "quantity": -9007199254740991,
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly"
    }
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

PATCH

/contracts/{id}

curl -X PATCH "https://api.corma.io/v1/contracts/-9007199254740991" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "string",
  "renewalType": "fixed",
  "supplierName": "string",
  "stage": "live",
  "paymentMethod": "wire",
  "ownerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "renewalDate": "2026-01-15T09:30:00Z",
  "noticeDate": "2026-01-15T09:30:00Z",
  "lastPaymentDate": "2026-01-15T09:30:00Z",
  "subscription": {
    "frequency": "monthly",
    "nextRenewalDate": "2026-01-15T09:30:00Z"
  },
  "seatItems": [
    {
      "licenseTypeKey": "string",
      "quantity": 0,
      "billingPeriod": "monthly"
    }
  ],
  "fixedItems": [
    {
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly"
    }
  ]
}'

{
  "id": -9007199254740991,
  "applicationInstanceId": -9007199254740991,
  "supplierName": "string",
  "currency": "string",
  "stage": "live",
  "renewalType": "fixed",
  "paymentMethod": "wire",
  "ownerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "renewalDate": "2026-01-15T09:30:00Z",
  "noticeDate": "2026-01-15T09:30:00Z",
  "lastPaymentDate": "2026-01-15T09:30:00Z",
  "activeAt": "2026-01-15T09:30:00Z",
  "totalCost": "string",
  "subscription": {
    "frequency": "monthly",
    "customFrequency": "weekly",
    "customFrequencyFactor": -9007199254740991,
    "nextRenewalDate": "2026-01-15T09:30:00Z"
  },
  "seatItems": [
    {
      "id": -9007199254740991,
      "licenseTypeKey": "string",
      "quantity": -9007199254740991,
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly",
      "isAutoAdjust": true
    }
  ],
  "fixedItems": [
    {
      "id": -9007199254740991,
      "name": "string",
      "quantity": -9007199254740991,
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly"
    }
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

Update contract - Corma Help Center | Productlane

API referenceContracts

Update contract

PATCH

/v1/contracts/{id}

PATCH

/contracts/{id}

curl -X PATCH "https://api.corma.io/v1/contracts/-9007199254740991" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "string",
  "renewalType": "fixed",
  "supplierName": "string",
  "stage": "live",
  "paymentMethod": "wire",
  "ownerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "renewalDate": "2026-01-15T09:30:00Z",
  "noticeDate": "2026-01-15T09:30:00Z",
  "lastPaymentDate": "2026-01-15T09:30:00Z",
  "subscription": {
    "frequency": "monthly",
    "nextRenewalDate": "2026-01-15T09:30:00Z"
  },
  "seatItems": [
    {
      "licenseTypeKey": "string",
      "quantity": 0,
      "billingPeriod": "monthly"
    }
  ],
  "fixedItems": [
    {
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly"
    }
  ]
}'

Authorization

x-corma-api-key
string
header
required
Colon-separated API key ID and secret: API_KEY_ID:API_KEY_SECRET

Parameters

id
integer
path
required
x-corma-idempotency-key
string
header
Optional client-generated key. Reusing the same key with an identical request replays the original response instead of enqueueing a duplicate task.

Body

application/json

currency
string
renewalType
enum<string>
One of:
fixed
subscription
supplierName
string | null
stage
enum<string> | null
One of:
live
cancelled
negotiating
rollout
testing
paymentMethod
enum<string> | null
One of:
wire
card
direct_debit
ownerId
string | null
startDate
any of | null
renewalDate
any of | null
noticeDate
any of | null
lastPaymentDate
any of | null
subscription
ContractSubscriptionBody | null
seatItems
ContractSeatItemBody[]
fixedItems
ContractFixedItemBody[]

Response

application/json200

id
integer
required
applicationInstanceId
integer
required
supplierName
string | null
required
currency
string
required
stage
enum<string> | null
required
One of:
live
cancelled
negotiating
rollout
testing
renewalType
enum<string> | null
required
One of:
fixed
subscription
paymentMethod
enum<string> | null
required
One of:
wire
card
direct_debit
ownerId
string | null
required
The workspace member who owns the contract.
startDate
string<date-time> | null
required
renewalDate
string<date-time> | null
required
noticeDate
string<date-time> | null
required
lastPaymentDate
string<date-time> | null
required
activeAt
string<date-time> | null
required
When set, this is the contract in force for the application instance. Only one contract per application instance is active.
totalCost
string | null
required
A decimal number serialized as a string, so no precision is lost.
subscription
ContractSubscription | null
required
seatItems
ContractSeatItem[]
required
fixedItems
ContractFixedItem[]
required
createdAt
string<date-time>
required
The timestamp of when this resource was created. ISO 8601 format.
updatedAt
string<date-time>
required
The timestamp of the last update to this resource. ISO 8601 format.

{
  "id": -9007199254740991,
  "applicationInstanceId": -9007199254740991,
  "supplierName": "string",
  "currency": "string",
  "stage": "live",
  "renewalType": "fixed",
  "paymentMethod": "wire",
  "ownerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "renewalDate": "2026-01-15T09:30:00Z",
  "noticeDate": "2026-01-15T09:30:00Z",
  "lastPaymentDate": "2026-01-15T09:30:00Z",
  "activeAt": "2026-01-15T09:30:00Z",
  "totalCost": "string",
  "subscription": {
    "frequency": "monthly",
    "customFrequency": "weekly",
    "customFrequencyFactor": -9007199254740991,
    "nextRenewalDate": "2026-01-15T09:30:00Z"
  },
  "seatItems": [
    {
      "id": -9007199254740991,
      "licenseTypeKey": "string",
      "quantity": -9007199254740991,
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly",
      "isAutoAdjust": true
    }
  ],
  "fixedItems": [
    {
      "id": -9007199254740991,
      "name": "string",
      "quantity": -9007199254740991,
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly"
    }
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}

PATCH

/contracts/{id}

curl -X PATCH "https://api.corma.io/v1/contracts/-9007199254740991" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "currency": "string",
  "renewalType": "fixed",
  "supplierName": "string",
  "stage": "live",
  "paymentMethod": "wire",
  "ownerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "renewalDate": "2026-01-15T09:30:00Z",
  "noticeDate": "2026-01-15T09:30:00Z",
  "lastPaymentDate": "2026-01-15T09:30:00Z",
  "subscription": {
    "frequency": "monthly",
    "nextRenewalDate": "2026-01-15T09:30:00Z"
  },
  "seatItems": [
    {
      "licenseTypeKey": "string",
      "quantity": 0,
      "billingPeriod": "monthly"
    }
  ],
  "fixedItems": [
    {
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly"
    }
  ]
}'

{
  "id": -9007199254740991,
  "applicationInstanceId": -9007199254740991,
  "supplierName": "string",
  "currency": "string",
  "stage": "live",
  "renewalType": "fixed",
  "paymentMethod": "wire",
  "ownerId": "string",
  "startDate": "2026-01-15T09:30:00Z",
  "renewalDate": "2026-01-15T09:30:00Z",
  "noticeDate": "2026-01-15T09:30:00Z",
  "lastPaymentDate": "2026-01-15T09:30:00Z",
  "activeAt": "2026-01-15T09:30:00Z",
  "totalCost": "string",
  "subscription": {
    "frequency": "monthly",
    "customFrequency": "weekly",
    "customFrequencyFactor": -9007199254740991,
    "nextRenewalDate": "2026-01-15T09:30:00Z"
  },
  "seatItems": [
    {
      "id": -9007199254740991,
      "licenseTypeKey": "string",
      "quantity": -9007199254740991,
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly",
      "isAutoAdjust": true
    }
  ],
  "fixedItems": [
    {
      "id": -9007199254740991,
      "name": "string",
      "quantity": -9007199254740991,
      "unitPeriodPrice": "string",
      "billingPeriod": "monthly"
    }
  ],
  "createdAt": "2026-01-15T09:30:00Z",
  "updatedAt": "2026-01-15T09:30:00Z"
}