Update a SaaS contract

curl --request PUT \
  --url https://api.getprimo.com/saas/{saasId}/contract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "flatRatePrice": 123,
  "unlicensedPricePerSeat": 123,
  "unlicensedMinimumSeatsBilled": 4503599627370495,
  "licenses": [
    {
      "id": "<string>",
      "pricePerSeat": 123,
      "minimumSeatsBilled": 4503599627370495
    }
  ]
}
'

{
  "contract": {
    "flatRatePrice": 123,
    "unlicensedPricePerSeat": 123,
    "unlicensedMinimumSeatsBilled": 4503599627370495,
    "licenses": [
      {
        "id": "<string>",
        "pricePerSeat": 123,
        "minimumSeatsBilled": 4503599627370495
      }
    ]
  },
  "finance": {
    "yearlyCost": 123,
    "unusedYearlyCost": 123,
    "unusedSeatsCount": 4503599627370495
  },
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

Saas

Update a SaaS contract

Replace the contract configuration for the given SaaS. All prices must be expressed for one billing period defined by billingFrequency (not annualized).

flat_rate mode — a single recurring amount covers the whole subscription:

flatRatePrice must be set.
unlicensedPricePerSeat, unlicensedMinimumSeatsBilled, licenses[].pricePerSeat and licenses[].minimumSeatsBilled must all be null.

per_licence mode — pricing is broken down per license type:

flatRatePrice must be null.
unlicensedPricePerSeat, unlicensedMinimumSeatsBilled, licenses[].pricePerSeat and licenses[].minimumSeatsBilled must all be set.

The licenses array must exactly match the licenses defined in the SaaS: every entry must have the same id as the corresponding SaaS license (retrieve them via getSaasById).

PUT

saas

{saasId}

contract

Update a SaaS contract

curl --request PUT \
  --url https://api.getprimo.com/saas/{saasId}/contract \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "flatRatePrice": 123,
  "unlicensedPricePerSeat": 123,
  "unlicensedMinimumSeatsBilled": 4503599627370495,
  "licenses": [
    {
      "id": "<string>",
      "pricePerSeat": 123,
      "minimumSeatsBilled": 4503599627370495
    }
  ]
}
'

{
  "contract": {
    "flatRatePrice": 123,
    "unlicensedPricePerSeat": 123,
    "unlicensedMinimumSeatsBilled": 4503599627370495,
    "licenses": [
      {
        "id": "<string>",
        "pricePerSeat": 123,
        "minimumSeatsBilled": 4503599627370495
      }
    ]
  },
  "finance": {
    "yearlyCost": 123,
    "unusedYearlyCost": 123,
    "unusedSeatsCount": 4503599627370495
  },
  "licenses": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "groups": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "roles": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>"
    }
  ],
  "organizationUnits": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ]
}

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

Show child attributes

Response

default - application/json

contract

object

required

Billing contract currently configured for this SaaS.

Show child attributes

finance

object

required

Derived financial metrics computed from the configured contract.

Show child attributes

licenses

object[]

required

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

Show child attributes

groups

object[]

required

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

Show child attributes

roles

object[]

required

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

Show child attributes

organizationUnits

object[]

required

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

Show child attributes

Get the issues flagged for a SaaS

Update a SaaS rule

Documentation Index

Authorizations

Path Parameters

Body

Response