SPsponsorunited
Organization

Get organization contract

Returns contract details for an organization including billing and subscription information

get/api/organization/{organizationId}/contract

Request

Path parameters

organizationIdinteger required

ID of the 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.