Sign in

v69

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-011221331.4 MB
Contracts

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}

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

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-IDstring

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).

Request body

namestring nullable

New contract name

poNumberstring nullable

New purchase-order number

activationStartDatestring date-time

New activation start date

activationEndDatestring date-time

New activation end date

subscriptionIdsstring[]

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

setupBillingboolean

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

The updated contract.