Sign in
Contracts

Create contract

Creates a contract for a customer together with all of its (custom) subscriptions in a single atomic operation. Every new subscription is created inside one transaction — any validation or creation failure rolls the whole contract back. Each subscription entry is either a new subscription to create or a reference to an existing custom subscription. Returns the created contract.

post/api/v1/contracts

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

customerIdstring required

The customer ref ID the contract belongs to

namestring nullable

Optional contract name

poNumberstring nullable

Optional purchase-order number

activationStartDatestring date-time

Optional contract activation start date

activationEndDatestring date-time

Optional contract activation end date

setupBillingboolean

Whether to set up billing for the contract by creating a billing contract in the connected billing provider. When false, the contract only provisions access (grants entitlements) and no billing contract is created. Defaults to true.

Response

The created contract, including the custom subscriptions attached to it.

Changes

Changed in 2 of the 115 revisions of this API.2