Sign in

v1

latestOpenAPI 3.1.02026-07-2489171167.4 KB
License Manager Public

Update a Contract

Update the details of an existing contract. Only the fields included in the request body will be updated.

patch/license-manager/contracts/{id}

Request body

namestring

The display name of the contract.

applicationIdstring nullable

The unique identifier of the linked application. Use the Applications API to retrieve application details.

statusstring

The current status of the contract. Allowed values are "active" (currently in effect), "closed" (expired or terminated), and "pipeline" (planned but not yet active).

typestring nullable

The type of software deployment for this contract. Allowed values are "saas" (cloud-based software), "on-prem" (on-premises software), "hybrid" (combination of cloud and on-premises), and "other".

categorystring nullable

The application's business category. Allowed values: operations, sales-and-marketing, developer-tools, design, project-management, customer-success, human-resources, it-and-security, finance, productivity, analytics-and-bi, other.

startDatestring date nullable

The start date of the contract.

endDatestring date nullable

The end date of the contract.

paymentTermstring nullable

The billing frequency for this contract. Allowed values are "annual", "monthly", "multiyear", "quarterly", "one-time", and "free".

contractValuenumber nullable

The total monetary value of the contract in the specified currency.

currencystring

ISO 4217 currency code for cost fields. Allowed values: USD, EUR, GBP, CAD, CHF, SEK, NOK, DKK, MXN, PLN, BRL, ILS, AUD, NZD, ZAR, GHS, TTD.

licensesCountinteger nullable

The number of licenses included in this contract.

autoRenewalboolean

Indicates whether the contract renews automatically when it reaches its end date. The default is "false".

cancellationNoticeinteger nullable

The number of days before the end date by which cancellation must be submitted to avoid auto-renewal.

notesstring nullable

Free-text notes or comments about the contract.

Example request

{
  "name": "Slack Enterprise Annual",
  "applicationId": "cm9z8y7x6w5v4u3t2s1r0q9p",
  "status": "active",
  "type": "saas",
  "category": "developer-tools",
  "startDate": "2025-01-01",
  "endDate": "2026-01-01",
  "paymentTerm": "annual",
  "contractValue": 12000,
  "currency": "USD",
  "licensesCount": 50,
  "autoRenewal": true,
  "cancellationNotice": 30,
  "notes": "Renewed with 10% discount"
}

Response

Contract is successfully updated.

namestring required

The display name of the contract.

applicationIdstring nullable

The unique identifier of the linked application. Use the Applications API to retrieve application details.

statusstring required

The current status of the contract. Allowed values are "active" (currently in effect), "closed" (expired or terminated), and "pipeline" (planned but not yet active).

typestring nullable

The type of software deployment for this contract. Allowed values are "saas" (cloud-based software), "on-prem" (on-premises software), "hybrid" (combination of cloud and on-premises), and "other".

categorystring nullable

The application's business category. Allowed values: operations, sales-and-marketing, developer-tools, design, project-management, customer-success, human-resources, it-and-security, finance, productivity, analytics-and-bi, other.

startDatestring date nullable

The start date of the contract.

endDatestring date nullable

The end date of the contract.

paymentTermstring nullable

The billing frequency for this contract. Allowed values are "annual", "monthly", "multiyear", "quarterly", "one-time", and "free".

contractValuenumber nullable

The total monetary value of the contract in the specified currency.

currencystring

ISO 4217 currency code for cost fields. Allowed values: USD, EUR, GBP, CAD, CHF, SEK, NOK, DKK, MXN, PLN, BRL, ILS, AUD, NZD, ZAR, GHS, TTD.

licensesCountinteger nullable

The number of licenses included in this contract.

autoRenewalboolean

Indicates whether the contract renews automatically when it reaches its end date. The default is "false".

cancellationNoticeinteger nullable

The number of days before the end date by which cancellation must be submitted to avoid auto-renewal.

notesstring nullable

Free-text notes or comments about the contract.

idstring required

The unique identifier of the contract (CUID format, 24 characters).

cancellationDeadlinestring date-time nullable

The deadline for cancellation, calculated as endDate minus cancellationNotice days. This field cannot be edited.

dateCreatedstring date-time required

The timestamp of when the contract was created.

dateUpdatedstring date-time required

The timestamp of when the contract was last updated.

Example response

{
  "name": "Slack Enterprise Annual",
  "applicationId": "cm9z8y7x6w5v4u3t2s1r0q9p",
  "status": "active",
  "type": "saas",
  "category": "developer-tools",
  "startDate": "2025-01-01",
  "endDate": "2026-01-01",
  "paymentTerm": "annual",
  "contractValue": 12000,
  "currency": "USD",
  "licensesCount": 50,
  "autoRenewal": true,
  "cancellationNotice": 30,
  "notes": "Renewed with 10% discount",
  "id": "cm1a2b3c4d5e6f7g8h9i0j1k",
  "application": {
    "category": "developer-tools",
    "currency": "USD",
    "dateCreated": "2025-06-15T10:30:00Z",
    "dateUpdated": "2025-08-20T14:30:00Z"
  },
  "cancellationDeadline": "2025-12-02T23:59:59.000Z",
  "dateCreated": "2025-01-15T10:30:00.000Z",
  "dateUpdated": "2025-06-20T14:45:00.000Z"
}