Skip to main content
PUT
Update a SaaS contract
Key: Write Scope: Company

Authorizations

Authorization
string
header
required

Use your Primo API key in the Authorization header as Bearer <API_KEY>.

Path Parameters

saasId
string
required

Body

application/json
pricingMode
enum<string> | null
required

Contract pricing mode. Use flat_rate for one recurring amount or per_licence for license-based pricing.

Available options:
per_licence,
flat_rate
currency
enum<string> | null
required

ISO currency code used for all contract prices.

Available options:
EUR,
GBP,
USD,
CHF,
CAD
billingFrequency
enum<string> | null
required

Billing period used by every price in this contract: monthly, quarterly, or annual.

Available options:
monthly,
quarterly,
annual
flatRatePrice
number | null
required

Recurring flat-rate amount billed for one billing period defined by billingFrequency. Not annualized. Required when pricingMode is flat_rate; must be null when pricingMode is per_licence.

unlicensedPricePerSeat
number | null
required

Price billed per unlicensed seat for one billing period defined by billingFrequency. Not annualized. Required when pricingMode is per_licence; must be null when pricingMode is flat_rate.

unlicensedMinimumSeatsBilled
integer | null
required

Minimum number of unlicensed seats billed during one billing period. Required when pricingMode is per_licence; must be null when pricingMode is flat_rate.

Required range: 0 <= x <= 9007199254740991
licenses
object[]
required

Priced contract lines, one entry per SaaS license. Required when pricingMode is per_licence; all pricePerSeat and minimumSeatsBilled values must be null when pricingMode is flat_rate. The list must exactly match the licenses defined in the SaaS (same id for every entry).

Response

default - application/json
contract
object | null
required

Billing contract currently configured for this SaaS.

finance
object
required

Derived financial metrics computed from the configured contract.

licenses
object[]
required

SaaS license catalog — all available licenses for this SaaS application.

groups
object[]
required

All groups available in this SaaS application. Use id when provisioning.

roles
object[]
required

All roles available in this SaaS application. Use id when provisioning.

organizationUnits
object[]
required

All organization units available in this SaaS application. Use id when provisioning.