Organization

Update organization contract

Updates contract-related fields for an organization, including account limits, surface usage limits, subscription details, and Salesforce integration fields.

put/api/organization/{organizationId}/contract/update

Request

Path parameters

organizationIdinteger required

ID of the organization

Request body

account_manager_idinteger nullable
sales_user_idinteger nullable
contract_auto_renewboolean nullable
contract_start_datestring nullable
contract_end_datestring nullable
contract_file_urlstring nullable
contract_monthly_spendnumber nullable
contract_onboarding_datestring nullable
contract_payment_type_idinteger nullable
contract_status_idinteger nullable
max_user_seatsinteger nullable

Seat cap for org-admin user management. null disables the feature, -1 enables it with unlimited seats, 0 is normalized to null, and a positive value caps the organization at that many active users. Any other negative value is rejected.

default_user_subscription_cancel_datestring nullable
default_user_subscription_plan_idstring nullable
default_user_subscription_product_namestring nullable
user_email_domainstring nullable
subscription_plan_idstring nullable
subscription_product_namestring nullable
trial_ends_atstring nullable
salesforce_idstring nullable

Example request

{
  "contract_start_date": "2026-01-01",
  "contract_end_date": "2026-12-31",
  "max_user_seats": 25,
  "account_limit": {
    "organization": {
      "monthly": 500,
      "annual": 6000
    },
    "user": {
      "monthly": 100,
      "annual": 1200
    }
  },
  "surface_limit": {
    "monthly": 500,
    "type": "organization"
  }
}

Response

Successful operation

contract_status_idinteger
contract_payment_type_idinteger
contract_monthly_spendinteger
contract_file_urlstring
contract_onboarding_datestring
contract_start_datestring
contract_end_datestring
contract_auto_renewinteger
max_user_seatsinteger nullable

Seat cap for org-admin user management. null means the feature is disabled, -1 means unlimited seats, a positive value is the number of active users allowed.

sales_user_idinteger
salesforce_idstring
account_manager_idinteger
default_user_subscription_plan_idstring
default_user_subscription_product_namestring
default_user_subscription_cancel_datestring
user_email_domainstring
surface_monthly_limitinteger
surface_limit_type'user' | 'organization'
surface_monthly_balancestring

Example response

{
  "surface_monthly_limit": 500,
  "surface_limit_type": "organization",
  "surface_monthly_balance": "47/500"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.