Create contract

Create a contract on an application instance, together with its seat items, fixed items and subscription. The new contract becomes the active one for that application instance, and the contract it replaces becomes inactive.

POST

/v1/contracts

POST

/contracts

curl -X POST "https://api.corma.io/v1/contracts" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "applicationInstanceId": -9007199254740991,
  "currency": "string",
  "renewalType": "fixed"
}'

Authorization

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

Parameters

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

applicationInstanceId
integer
required
currency
string
required
renewalType
enum<string>
required
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[] | null
fixedItems
ContractFixedItemBody[] | null

Response

application/json201

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"
}

POST

/contracts

curl -X POST "https://api.corma.io/v1/contracts" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "applicationInstanceId": -9007199254740991,
  "currency": "string",
  "renewalType": "fixed"
}'

{
  "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"
}

Create contract - Corma Help Center | Productlane

API referenceContracts

Create contract

POST

/v1/contracts

POST

/contracts

curl -X POST "https://api.corma.io/v1/contracts" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "applicationInstanceId": -9007199254740991,
  "currency": "string",
  "renewalType": "fixed"
}'

Authorization

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

Parameters

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

applicationInstanceId
integer
required
currency
string
required
renewalType
enum<string>
required
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[] | null
fixedItems
ContractFixedItemBody[] | null

Response

application/json201

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"
}

POST

/contracts

curl -X POST "https://api.corma.io/v1/contracts" \
  -H "x-corma-api-key: $CORMA_OPEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "applicationInstanceId": -9007199254740991,
  "currency": "string",
  "renewalType": "fixed"
}'

{
  "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"
}