CommonPaper API Docs
Documentation

Template Parameters

When creating a template via POST /v1/templates, pass a type to select the agreement type (defaults to NDA). All other parameters are optional and set the defaults that will be pre-filled when agreements are created from the template.

Template Types

typeAgreement
NDAMutual Non-Disclosure Agreement
CSACloud Service Agreement
DPAData Processing Agreement
PSAProfessional Services Agreement
DesignDesign Partner Agreement
Software LicenseSoftware License Agreement
PilotPilot Agreement
PartnershipPartnership Agreement
BAABusiness Associate Agreement
LOILetter of Intent

Common Parameters

These parameters apply to all template types.

ParameterTypeDescription
namestringDisplay name for the template
governing_law_regionstringState or region whose laws govern the agreement (e.g. "Delaware")
governing_law_countrystringCountry whose laws govern the agreement (e.g. "United States of America")
chosen_courts_regionstringState or region where disputes are resolved
chosen_courts_countrystringCountry where disputes are resolved
district_or_countystringDistrict or county for dispute resolution (e.g. "Court of Chancery")
negotiations_allowedbooleanWhether counterparties can propose changes. Default: true
default_signer_emailstringEmail pre-filled as the sender signer when creating agreements
sender_rolestringLabel for the sending party (e.g. "Provider"). On PSA templates, set "Customer" when your company hires the recipient to provide the services, and send recipient_role as "Provider" with it.
recipient_rolestringLabel for the receiving party (e.g. "Customer"). On PSA templates, it must be the other role from sender_role.
sender_last_to_signbooleanWhen true, the sender signs after the recipient. Default: false
include_termsbooleanWhether to include standard terms. Default: true
include_additional_changesbooleanWhether to include a section for additional negotiated changes. Default: true
additional_changesstringPre-filled text for additional changes

NDA

Mutual Non-Disclosure Agreement.

ParameterTypeDescription
termintegerLength of the agreement term in years. Required. Default: 1
confidentiality_periodintegerDuration of confidentiality obligations in years. Required. Default: 2
confidentiality_period_perpetualbooleanWhen true, confidentiality obligations do not expire. Default: false
term_period_perpetualbooleanWhen true, the agreement term does not expire. Default: false
purposestringDescription of the business purpose for sharing confidential information. Required
effective_date_typestringHow the effective date is set: "signature" (default) or "date"
effective_datedateSpecific effective date. Required when effective_date_type is "date"
effective_date_of_confidentialitystringWhen confidentiality obligations begin: "Effective Date" (default) or "date of last disclosure"

CSA

Cloud Service Agreement.

ParameterTypeDescription
providerstringName of the service provider organization
customer_descriptionstringDescription of the customer or their use case
effective_date_typestringHow the effective date is set. One of: "signature", "date", "marketplace_acceptance". Default: "signature"
effective_datedatetimeRequired when effective_date_type is "date"
general_cap_amount_typestringLiability cap type. One of: "preceding", "base", "period". Default: "preceding"
general_cap_preceding_amountnumberNumber of preceding months for the liability cap. Required when general_cap_amount_type is "preceding"
general_cap_amountnumberFixed liability cap amount. Required when general_cap_amount_type is "base"
include_covered_claimsbooleanWhether to include a covered claims section. Default: false
include_increased_cap_amountbooleanWhether to include an increased cap for specific claim types. Default: false
increased_cap_amount_typestringType of increased cap. One of: "qty", "currency", "period". Default: "qty"
include_unlimited_claimsbooleanWhether certain claim types have no cap. Default: false
include_dpabooleanWhether to include a Data Processing Agreement. Default: false
include_dpa_typestringHow the DPA is referenced: "description" or "attachment"
include_dpa_locationstringURL or description of the DPA when include_dpa_type is "description"
include_dpa_attachment_iduuidAttachment ID of the DPA when include_dpa_type is "attachment"
include_ai_addendumbooleanWhether to include an AI addendum. Default: false
include_ai_addendum_attachment_iduuidRequired when include_ai_addendum is true
include_security_policybooleanWhether to include a security policy section. Default: false
include_security_policy_typestringHow the policy is referenced: "description" or "attachment"
include_acceptable_use_policybooleanWhether to include an acceptable use policy. Default: false
include_additional_warrantiesbooleanWhether to include additional warranties. Default: false
include_insurance_minimumsbooleanWhether to include insurance minimums. Default: false
include_publicity_rightsbooleanWhether to include publicity rights. Default: false
include_billing_workflowbooleanWhether to enable a billing workflow after signing. Default: false
billing_workflow_typestring"link" (payment URL) or "stripe" (Stripe-managed billing)
payment_link_urlstringPayment URL shown after signing. Used when billing_workflow_type is "link"
stripe_product_idstringStripe product ID. Used when billing_workflow_type is "stripe"
stripe_product_namestringStripe product name
stripe_invoice_deliverystring"automatic" (default) or "manual"
stripe_subsequent_bill_methodstringHow Stripe bills after the first invoice. One of: "automatic", "invoice". Default: "automatic"
template_csa_order_form_attributesobjectNested order form defaults. See CSA Order Form below.
attachment_idsarrayUUIDs of attachments to include with the template

CSA Order Form

Pass as template_csa_order_form_attributes: { ... }.

ParameterTypeDescription
cloud_service_descriptionstringDescription of the cloud service being provided. Required.
subscription_periodintegerLength of the subscription. Default: 1
subscription_period_unitstringUnit for subscription period (e.g. "year(s)"). Default: "year(s)"
subscription_start_date_typestringHow the subscription start date is set. One of: "effective_date", "date". Default: "effective_date"
subscription_start_datedatetimeSpecific subscription start date
include_subscription_start_datebooleanWhether to include a subscription start date field. Default: false
include_subscription_start_date_datedateSpecific start date when include_subscription_start_date is true
subscription_auto_renewstringAuto-renewal setting. One of: "days", "subscription_end". Default: "days"
subscription_renewal_notice_daysintegerDays of notice required before renewal. Default: 30
order_date_typestringHow the order date is set: "signature", "date", or "other"
order_date_datedatetimeSpecific order date
order_date_otherstringCustom order date description. Required when order_date_type is "other"
affiliates_as_usersbooleanWhether customer affiliates may use the service. Default: false
include_use_limitationsbooleanWhether to include use limitations. Default: false
include_use_limitations_valstringDescription of use limitations
include_max_usersbooleanWhether to cap the number of users. Default: false
max_usersintegerMaximum number of users. Default: 10
include_consumptionbooleanWhether to include a consumption limit. Default: false
max_consumptionintegerMaximum consumption amount
consumption_unitsstringUnits for consumption (e.g. "API calls")
include_additional_parameters_or_limitationsbooleanWhether to include additional use parameters. Default: false
additional_parameters_or_limitationsstringText describing additional parameters or limitations
include_feesbooleanWhether to include fees. Default: false
include_fees_tablebooleanWhether fees are displayed as a table. Default: false
include_fees_table_periodstringBilling period for the fees table. One of: "Subscription Period", "month", "year", "User"
include_fees_otherbooleanWhether to include a custom fee description. Default: false
include_fees_other_valstringCustom fee description text
include_fees_include_attachmentbooleanWhether to attach a fee schedule document. Default: false
include_fees_attachment_iduuidAttachment ID for the fee schedule
fees_currencystringCurrency for fees. One of: "USD", "EUR", "GBP", "CAD", "AUD", "SGD", "ILS", "JPY", "CHF", "HKD". Default: "USD"
fees_inclusive_of_taxesbooleanWhether fees are inclusive of taxes. Default: false
fees_include_fee_increase_upon_renewalbooleanWhether fees increase at renewal. Default: false
fees_include_fee_increase_upon_renewal_feenumberFee increase percentage. Default: 5.0
fees_include_fee_increase_upon_renewal_typestringWhether fees will or may increase on renewal. One of: "will", "may". Default: "will"
fee_amountnumberFixed fee amount
fee_periodstringBilling period. One of: "Subscription Period", "month", "year", "User", "Custom unit". Default: "Subscription Period"
fee_custom_unitstringCustom billing unit description
include_free_trialbooleanWhether to include a free trial period. Default: false
free_trial_daysintegerLength of the free trial in days
payment_periodintegerPayment due period in days. Default: 30
payment_period_unitstringUnit for payment period. One of: "day(s)", "week(s)", "month(s)", "marketplace_acceptance". Default: "day(s)"
payment_period_timeframestringWhen the payment clock starts. One of: "Customer's receipt of invoice", "date of invoice"
payment_process_typestringPayment process. One of: "automatic", "invoice", "custom", "marketplace_acceptance". Default: "automatic"
payment_process_automatic_frequencystringFrequency for automatic billing. One of: "monthly", "quarterly", "semiannually", "annually". Default: "monthly"
payment_process_type_invoice_amountintegerInvoice payment due days
payment_process_type_invoice_typestringInvoice period type. One of: "monthly", "quarterly", "semiannually", "annually", "Custom unit". Default: "monthly"
payment_process_type_invoice_durationstringInvoice duration. One of: "day", "week", "month", "year", "day(s)", "week(s)", "month(s)", "year(s)"
payment_process_type_invoice_duration_startstringWhen the invoice duration starts. One of: "Customer's receipt of invoice", "date of invoice"
payment_process_type_custom_valstringCustom payment process description. Required when payment_process_type is "custom"
invoice_periodstringInvoice period description. One of: "monthly", "quarterly", "semiannually", "annually", "Custom unit", "Monthly", "Quarterly", "Semiannually", "Annually". Default: "annually"
include_slabooleanWhether to include a Service Level Agreement. Default: false
include_sla_typestringHow the SLA is referenced: "description", "standard", or "attachment". Default: "description"
include_sla_descriptionstringSLA description text
include_sla_attachment_iduuidAttachment ID for the SLA document
include_sla_include_target_uptimebooleanWhether the SLA includes a target uptime commitment. Default: false
include_sla_standard_target_uptimenumberTarget uptime percentage (e.g. 99.9)
include_sla_include_response_timebooleanWhether the SLA includes response time SLOs. Default: false
include_sla_include_response_time_amountintegerResponse time amount
include_sla_include_response_time_durationstringResponse time unit. One of: "hour", "day", "week", "month", "hours". Default: "hours"
include_sla_include_response_time_creditnumberService credit percentage for response time breaches
include_sla_include_response_time_support_channelstringSupport channel (e.g. "email")
include_sla_maintenance_windowbooleanWhether to include a maintenance window
include_sla_maintenance_window_typestringMaintenance window type. One of: "standard", "none". Default: "standard"
include_sla_standard_maintenance_window_start_timestringMaintenance window start time
include_sla_standard_maintenance_window_end_timestringMaintenance window end time
include_sla_standard_maintenance_window_mondaybooleanMonday maintenance window. Default: false
include_sla_standard_maintenance_window_tuesdaybooleanTuesday maintenance window. Default: false
include_sla_standard_maintenance_window_wednesdaybooleanWednesday maintenance window. Default: false
include_sla_standard_maintenance_window_thursdaybooleanThursday maintenance window. Default: false
include_sla_standard_maintenance_window_fridaybooleanFriday maintenance window. Default: false
include_sla_standard_maintenance_window_saturdaybooleanSaturday maintenance window. Default: false
include_sla_standard_maintenance_window_sundaybooleanSunday maintenance window. Default: false
include_sla_maintenance_noticebooleanWhether to include maintenance notice requirements
include_sla_standard_maintenance_notice_qtynumberAdvance notice quantity
include_sla_standard_maintenance_notice_unitstringAdvance notice unit. One of: "hour", "day", "week", "month". Default: "hour"
include_sla_maintenance_custombooleanWhether to include a custom Scheduled Downtime description. With Target Uptime included, at least one of include_sla_maintenance_window, include_sla_maintenance_notice or include_sla_maintenance_custom must be true. CSA 2.x and 3.x only. Default: false
include_sla_maintenance_custom_valstringCustom Scheduled Downtime description (markdown). Shown on its own when it is the only Scheduled Downtime option, otherwise added as the last bullet of the Scheduled Downtime list. Blank renders nothing. CSA 2.x and 3.x only
include_product_supportbooleanWhether to include a product support section. Default: false
include_product_support_typestring"description" (default) or "attachment"
include_product_support_descriptionstringProduct support description
include_product_support_attachment_iduuidAttachment ID for the support policy
include_professional_servicesbooleanWhether to include professional services. Default: false
include_professional_services_typestring"description" (default) or "attachment"
include_professional_services_descriptionstringProfessional services description
include_professional_services_custom_namestringCustom name for the professional services section
include_professional_services_include_end_datebooleanWhether to include an end date for professional services. Default: false
include_professional_services_end_datedatetimeEnd date for professional services
include_professional_services_include_fees_descriptionbooleanWhether to include a fees description. Default: false
include_professional_services_fees_descriptionstringFees description for professional services
include_professional_services_attachment_iduuidAttachment ID for professional services document
include_pilot_periodbooleanWhether to include a pilot period before the subscription. Default: false
include_pilot_period_duration_amountintegerLength of the pilot period
include_pilot_period_duration_typestringUnit for pilot duration. One of: "day", "week", "month". Default: "day"
include_pilot_period_include_feesbooleanWhether the pilot period includes fees. Default: false
include_pilot_period_include_fees_amountnumberPilot period fee amount
include_pilot_period_include_modificationsbooleanWhether modifications are allowed during the pilot. Default: false
include_pilot_period_include_modifications_descriptionstringDescription of allowed modifications
include_billing_infobooleanWhether to include billing contact information. Default: false
include_usage_reviewbooleanWhether to include a usage review clause. Default: false
include_usage_review_valstringUsage review description
fees_attributesarrayFees to include on the order form. See Fees below.
service_credits_attributesarrayService credits. Each item: { min, max, credit }
use_limitations_attributesarrayUse limitations. Each item: { limitation_type, amount, unit }

DPA

Data Processing Agreement.

The common governing_law_*, chosen_courts_*, and district_or_county parameters do not apply to DPA templates and are ignored. Use include_governing_law, include_governing_law_country, and include_governing_law_state instead. DPA templates also default include_additional_changes to false, and provider defaults to your organization's name.

ParameterTypeDescription
providerstringName of the data processor (service provider)
customer_descriptionstringDescription of the data controller (customer)
underlying_agreement_valstringDescription of the agreement this DPA is attached to (e.g. "MSA dated January 1, 2026")
approved_subprocessor_typestring"internal" lists subprocessors on the Cover Page (subprocessors_attributes); "external" points to a list posted online (include_external_subprocessor_location). Default: "internal"
include_external_subprocessor_locationstringWhere the subprocessor list is posted, when approved_subprocessor_type is "external"
security_policy_typestringWhere the Security Policy is defined: "defined in agreement", "provider service" (commercially reasonable efforts), or "external". Default: "defined in agreement"
security_policy_available_atstringWhere the Security Policy is available, when security_policy_type is "external"
include_security_policybooleanWhether Provider maintains annual reports or certifications. Pick them with the include_security_policy_<name> booleans: iso27001, soc2, soc2_type2, hipaa, hitrust, penetration_testing, pci1, pci2, fedramp_auth, and include_other with include_security_policy_other (string). Default: false
include_governing_lawbooleanWhether to override the underlying agreement's governing law and chosen courts for this DPA. Default: false
include_governing_law_countrystringGoverning country when include_governing_law is true (e.g. "USA")
include_governing_law_statestringGoverning state or region when include_governing_law is true
include_governing_country_eubooleanWhether EU Standard Contractual Clauses apply. Default: true
include_governing_country_eu_valstringEU member state for SCCs. Default: "Netherlands"
include_governing_country_ukbooleanWhether UK GDPR addendum applies. Default: false
include_governing_country_uk_valstringUK territory designation. Default: "England and Wales"
include_provider_security_contact_emailbooleanWhether to include a security contact email. Default: true
include_provider_security_contact_email_valstringSecurity contact email address
include_provider_security_contact_addressbooleanWhether to include a security contact mailing address. Default: false
include_provider_security_contact_address_street_addressstringSecurity contact street address. Also _city, _state, _zipcode, and _country
include_covered_claimbooleanWhether to include a covered claims / indemnification section. Default: false
include_covered_claim_typestring"internal" (using a Common Paper CSA) or "external" (using a different agreement). Required when include_covered_claim is true. Default: "internal"
include_covered_claim_internal_valstringDescription of the internal covered claims
include_covered_claim_external_valstringDescription of the external covered claims
include_liability_capbooleanWhether to include a separate DPA liability cap. Default: false
include_liability_cap_csa_typestring"internal" (using a Common Paper CSA) or "external" (using a different agreement). Required when include_liability_cap is true. Default: "internal"
include_liability_cap_amount_currency_internalnumberFixed cap amount for "internal". Default: 5000000
include_liability_cap_amount_constant_internalstringMultiplier of the prior 12 months' fees for "internal". Default: "10"
include_liability_cap_amount_currency_externalnumberFixed cap amount for "external". Default: 5000000
include_liability_cap_amount_constant_externalstringMultiplier of the prior 12 months' fees for "external". Default: "10"
include_data_subjects_end_usersbooleanWhether end users are a covered data subject category. Default: true
include_data_subjects_employeesbooleanWhether employees are a covered data subject category. Default: false
include_data_subjects_custombooleanWhether to include a custom data subject category. Default: false
include_data_subjects_custom_valstringDescription of the custom data subject category
include_personal_data_namebooleanNames included in personal data. Default: true
include_personal_data_contact_infobooleanContact information included. Default: false
include_personal_data_financial_infobooleanFinancial information included. Default: false
include_personal_data_employment_infobooleanEmployment information included. Default: false
include_personal_data_biographic_infobooleanBiographic information included. Default: false
include_personal_data_transactional_infobooleanTransactional information included. Default: false
include_personal_data_user_activity_infobooleanUser activity information included. Default: false
include_personal_data_locationbooleanLocation data included. Default: false
include_personal_data_custombooleanCustom personal data category. Default: false
include_personal_data_custom_valstringDescription of the custom personal data category
include_special_category_databooleanWhether special category data (health, biometric, etc.) is processed. Default: false
include_sensitive_data_restrictions_security_policybooleanWhether the Security Policy sets the restrictions on sensitive data. Default: true
include_sensitive_data_restrictions_custombooleanWhether to describe the restrictions on sensitive data. Default: false
include_sensitive_data_restrictions_custom_valstringDescription of the restrictions applied to sensitive data
include_processing_purpose_receivingbooleanReceiving is a purpose of processing. Default: true
include_processing_purpose_holdingbooleanHolding is a purpose of processing. Default: false
include_processing_purpose_usingbooleanUsing is a purpose of processing. Default: false
include_processing_purpose_updatingbooleanUpdating is a purpose of processing. Default: false
include_processing_purpose_protectingbooleanProtecting is a purpose of processing. Default: false
include_processing_purpose_sharingbooleanSharing is a purpose of processing. Default: false
include_processing_purpose_returningbooleanReturning is a purpose of processing. Default: false
include_processing_purpose_erasingbooleanErasing is a purpose of processing. Default: false
include_processing_purpose_custombooleanWhether to add a custom purpose of processing. Default: false
include_processing_purpose_custom_valstringDescription of the custom purpose of processing
include_frequency_of_transfer_continuousbooleanWhether data transfers are continuous. Default: true
include_frequency_of_transfer_custombooleanWhether to specify a custom transfer frequency. Default: false
include_frequency_of_transfer_custom_valstringCustom transfer frequency description
duration_of_processingstringDescription of how long data is processed
competent_supervisory_authoritystringName of the competent supervisory authority
include_service_provider_relationshipbooleanWhether to include the CCPA service provider clause. Default: true
cloud_service_product_namestringDescription of the Service
data_importer_contact_namestringData importer contact name. Also data_importer_contact_position and data_importer_contact_details
data_importer_address_street_addressstringData importer street address. Also _city, _state, and _zipcode
data_importer_address_countrystringData importer's country. Default: "USA"
subprocessors_attributesarraySubprocessors, each with name, country, and processing_task. On update, an item without id adds a subprocessor; pass id to change one and id with _destroy: true to remove one

DPA Annex II Security Measures

The technical and organizational security measures listed in Annex II. Each measure is a pair: the include_security_measures_<measure> boolean adds the measure to the annex, and the matching _val string describes how the measure is met. The _val is free text and is rendered under the measure's heading.

ParameterTypeDescription
include_security_measures_security_policybooleanWhen true, the annex refers to the Security Policy instead of listing measures. Default: true
include_security_measures_pseudonym_encryptionbooleanInclude "Pseudonymization and encryption of personal data". Default: false
include_security_measures_pseudonym_encryption_valstringHow pseudonymization and encryption are handled
include_security_measures_confidentiality_integritybooleanInclude "Ensuring ongoing confidentiality, integrity, availability, and resilience of processing systems and services". Default: false
include_security_measures_confidentiality_integrity_valstringHow confidentiality, integrity, availability, and resilience are ensured
include_security_measures_restore_data_accessbooleanInclude "Ability to restore the availability of and access to Customer Personal Data in a timely manner following a physical or technical incident". Default: false
include_security_measures_restore_data_access_valstringHow availability and access are restored after an incident
include_security_measures_testing_assessmentbooleanInclude "Regular testing, assessment, and evaluation of the effectiveness of technical and organizational measures". Default: false
include_security_measures_testing_assessment_valstringHow measures are tested, assessed, and evaluated
include_security_measures_identity_authbooleanInclude "User identification and authorization process and protection". Default: false
include_security_measures_identity_auth_valstringHow users are identified and authorized
include_security_measures_data_transmissionbooleanInclude "Protecting Customer Personal Data during transmission (in transit)". Default: false
include_security_measures_data_transmission_valstringHow data is protected in transit
include_security_measures_data_at_restbooleanInclude "Protecting Customer Personal Data during storage (at rest)". Default: false
include_security_measures_data_at_rest_valstringHow data is protected at rest
include_security_measures_physical_securitybooleanInclude "Physical security where Customer Personal Data is processed". Default: false
include_security_measures_physical_security_valstringHow the processing locations are physically secured
include_security_measures_event_loggingbooleanInclude "Events logging". Default: false
include_security_measures_event_logging_valstringHow events are logged
include_security_measures_system_configurationbooleanInclude "Systems configuration, including default configuration". Default: false
include_security_measures_system_configuration_valstringHow systems are configured
include_security_measures_it_security_governancebooleanInclude "Internal IT and IT security governance and management". Default: false
include_security_measures_it_security_governance_valstringHow IT and IT security are governed
include_security_measures_certification_or_assurancebooleanInclude "Certification or assurance of processes and products". Default: false
include_security_measures_certification_or_assurance_valstringWhich certifications or assurances apply
include_security_measures_data_minimizationbooleanInclude "Ensuring data minimization". Default: false
include_security_measures_data_minimization_valstringHow data minimization is ensured
include_security_measures_data_qualitybooleanInclude "Ensuring data quality". Default: false
include_security_measures_data_quality_valstringHow data quality is ensured
include_security_measures_data_retentionbooleanInclude "Ensuring limited data retention". Default: false
include_security_measures_data_retention_valstringHow data retention is limited
include_security_measures_accountabilitybooleanInclude "Ensuring accountability". Default: false
include_security_measures_accountability_valstringHow accountability is ensured
include_security_measures_portability_and_erasurebooleanInclude "Allowing data portability and erasure". Default: false
include_security_measures_portability_and_erasure_valstringHow data portability and erasure are allowed

PSA

Professional Services Agreement.

ParameterTypeDescription
effective_date_typestring"signature" or "date"
effective_datedateRequired when effective_date_type is "date"
general_cap_amount_typestringLiability cap type. One of: "preceding", "base", "period". Default: "preceding"
general_cap_preceding_amountnumberPreceding months for liability cap
general_cap_amountnumberFixed liability cap amount
include_covered_claimsbooleanWhether to include covered claims. Default: false
include_increased_claimsbooleanWhether certain claims have an elevated cap. Default: false
include_unlimited_claimsbooleanWhether certain claims are uncapped. Default: false
include_additional_warrantiesbooleanWhether to include additional warranties. Default: false
include_dpabooleanWhether to include a DPA. Default: false
include_dpa_typestring"description" or "attachment"
include_dpa_locationstringURL or description of the DPA
include_dpa_attachment_iduuidAttachment ID for the DPA
include_security_policybooleanWhether to include a security policy. Default: false
include_security_policy_typestring"description" or "attachment"
include_provider_insurance_minbooleanWhether to include provider insurance minimums. Default: false
include_customer_insurance_minbooleanWhether to include customer insurance minimums. Default: false
include_publicity_rightsbooleanWhether to include publicity rights. Default: false
include_customer_policiesbooleanWhether to reference customer policies. Default: false
template_psa_statement_of_work_attributesobjectNested statement of work defaults. See PSA Statement of Work below.
attachment_idsarrayUUIDs of attachments to include

PSA Statement of Work

Pass as template_psa_statement_of_work_attributes: { ... }.

ParameterTypeDescription
services_descriptionstringDescription of the services to be performed. Required.
sow_date_typestringHow the SOW date is set: "signature" or "date"
sow_datedateSpecific SOW effective date
sow_term_typestringHow the SOW term is defined. One of: "deliverables", "period", "date". Default: "deliverables"
sow_term_amountintegerLength of the SOW term
sow_term_unitstringUnit for SOW term. One of: "month(s)", "quarter(s)", "year(s)". Default: "month(s)"
sow_term_datedateSpecific SOW end date
include_deliverablesbooleanWhether to include a deliverables section. Default: false
include_deliverables_descriptionstringDescription of deliverables
include_deliverables_include_draft_deliverablesbooleanWhether to include a draft deliverables review process
include_deliverables_include_acceptancebooleanWhether to include a formal acceptance process. Default: false
include_deliverables_rejection_amountintegerDays to reject a deliverable
include_deliverables_rejection_unitstringUnit for rejection period. One of: "hours", "days", "weeks", "months". Default: "days"
include_deliverables_resubmission_amountintegerDays to resubmit a rejected deliverable
include_deliverables_resubmission_unitstringUnit for resubmission period. One of: "hours", "days", "weeks", "months". Default: "days"
include_deliverables_include_attachmentbooleanWhether to attach a deliverables schedule. Default: false
include_deliverables_attachment_iduuidAttachment ID for the deliverables schedule
include_time_of_assignmentbooleanWhether to include time-of-assignment provisions. Default: false
include_time_of_assignment_typestringType of time-of-assignment provision. One of: "created", "paid". Default: "paid"
include_third_party_materialsbooleanWhether to include third-party materials provisions. Default: false
include_third_party_providerbooleanWhether the provider may use third-party materials. Default: false
include_third_party_customerbooleanWhether the customer may use third-party materials. Default: false
include_third_party_include_descriptionbooleanWhether to describe the third-party materials. Default: false
include_third_party_include_description_valstringDescription of third-party materials
include_fees_tablebooleanWhether to include a fees table. Default: false
include_fees_table_totalbooleanWhether to include a total row in the fees table
include_fees_otherbooleanWhether to include a custom fee description. Default: false
include_fees_other_valstringCustom fee description
include_fees_travelbooleanWhether to include travel expense reimbursement. Default: false
include_fees_travel_typestringHow travel reimbursement is defined: "description" or "attachment"
include_fees_travel_valstringTravel reimbursement description
include_fees_travel_attachment_iduuidAttachment ID for travel policy
payment_period_typestringPayment due period type. One of: "standard", "other". Default: "standard"
payment_periodintegerPayment due period amount
payment_period_unitstringUnit for payment period. One of: "day(s)", "week(s)", "month(s)", "quarter(s)", "year(s)". Default: "day(s)"
payment_period_timeframestringWhen the payment clock starts. One of: "receipt", "invoice", "Customer's receipt of invoice", "date of invoice"
payment_period_otherstringCustom payment period description
invoice_period_descriptionstringDescription of when invoices are issued
include_customer_obligationbooleanWhether to include a customer obligations section. Default: false
include_customer_obligation_valstringDescription of customer obligations
fees_attributesarrayFees for the statement of work. Each item: { fee_type, description, quantity, cost }. On update, an item without id adds a fee; pass id to change one and id with _destroy: true to remove one

Design

Design Partner Agreement.

ParameterTypeDescription
product_descriptionstringDescription of the product being piloted
customer_descriptionstringDescription of the design partner
effective_date_typestring"signature" (default) or "date"
effective_datedateRequired when effective_date_type is "date"
term_amountintegerLength of the program. Default: 6
term_unitstringUnit for the term. One of: "day(s)", "week(s)", "month(s)", "quarter(s)", "year(s)". Default: "month(s)"
include_program_participation_feedbackbooleanWhether customer provides feedback. Default: true
include_program_participation_feedback_amountintegerNumber of feedback sessions
include_program_participation_feedback_unitstringUnit for feedback sessions. One of: "month", "quarter", "year", "Term". Default: "month"
include_program_appear_as_customer_privatebooleanWhether provider can reference customer privately. Default: true
include_program_appear_as_customer_publicbooleanWhether provider can reference customer publicly. Default: true
include_program_case_studybooleanWhether a case study is included. Default: false
include_program_referencebooleanWhether the customer serves as a reference. Default: false
include_program_discountbooleanWhether a discount is offered. Default: true
include_program_discount_amountnumberDiscount amount. Default: 20
include_program_discount_unitstringDiscount unit. One of: "U.S. Dollars", "percent". Default: "percent"
include_program_develop_functionalitybooleanWhether the provider develops custom functionality. Default: false
include_feesbooleanWhether the agreement includes fees. Default: false
include_fees_typestringFee type. One of: "default_language", "description". Default: "default_language"
include_fees_amountnumberFee amount
include_fees_unitstringFee unit. One of: "month", "quarter", "year", "Term"
attachment_idsarrayUUIDs of attachments to include

Software License

Software License Agreement.

ParameterTypeDescription
effective_date_typestring"signature" or "date"
effective_datedateRequired when effective_date_type is "date"
general_cap_amount_typestringLiability cap type. One of: "preceding", "base", "period". Default: "preceding"
general_cap_preceding_amountnumberPreceding months for liability cap. Default: 1
general_cap_amountnumberFixed liability cap amount
include_covered_claimsbooleanDefault: false
include_increased_claimsbooleanDefault: false
include_unlimited_claimsbooleanDefault: false
include_additional_warrantiesbooleanDefault: false
include_dpabooleanDefault: false
include_dpa_typestring"description" or "attachment"
include_dpa_attachment_iduuidAttachment ID for the DPA
include_ai_addendumbooleanDefault: false
include_ai_addendum_attachment_iduuidRequired when include_ai_addendum is true
include_billing_workflowbooleanDefault: false
billing_workflow_typestring"link" or "stripe"
payment_link_urlstringPayment URL after signing
stripe_product_idstringStripe product ID
stripe_invoice_deliverystring"automatic" (default) or "manual"
template_software_license_order_form_attributesobjectNested order form defaults. See Software License Order Form below.
attachment_idsarrayUUIDs of attachments to include

Software License Order Form

Pass as template_software_license_order_form_attributes: { ... }.

ParameterTypeDescription
software_descriptionstringDescription of the software being licensed. Required.
order_date_typestringHow the order date is set. One of: "signature", "date", "other". Default: "signature"
order_date_datedateSpecific order date
subscription_periodintegerLength of the subscription
subscription_period_unitstringUnit for subscription period (e.g. "year"). Default: "year"
subscription_auto_renewstringAuto-renewal setting. One of: "days", "subscription_end". Default: "days"
subscription_renewal_notice_daysintegerDays of notice required before renewal
fee_periodstringBilling period. One of: "Subscription Period", "month", "year", "Custom unit"
fee_custom_unitstringCustom billing unit description
fees_currencystringCurrency for fees. One of: "USD", "EUR", "GBP", "CAD", "AUD", "SGD", "ILS", "JPY", "CHF", "HKD". Default: "USD"
fees_inclusive_of_taxesbooleanWhether fees are inclusive of taxes
fees_include_fee_increase_upon_renewalbooleanWhether fees increase at renewal
fees_include_fee_increase_upon_renewal_feenumberFee increase percentage
fees_include_fee_increase_upon_renewal_typestringWhether fees will or may increase on renewal. One of: "will", "may". Default: "will"
payment_process_typestringPayment process: "invoice", "automatic", or "custom"
payment_process_automatic_frequencystringFrequency for automatic billing. One of: "monthly", "quarterly", "semiannually", "annually". Default: "monthly"
payment_process_type_invoice_amountintegerInvoice payment due days
payment_process_type_invoice_typestringInvoice period type. One of: "monthly", "quarterly", "semiannually", "annually", "Custom unit". Default: "monthly"
payment_process_type_invoice_durationstringInvoice duration. One of: "day", "week", "month", "year", "day(s)", "week(s)", "month(s)", "year(s)"
payment_process_type_invoice_duration_startstringWhen the invoice duration starts. One of: "Customer's receipt of invoice", "date of invoice"
payment_process_type_custom_valstringCustom payment process description. Required when payment_process_type is "custom"
include_payment_process_include_billing_emailbooleanWhether to include a billing email field. Default: false
permitted_uses_include_internal_businessbooleanWhether internal business use is permitted
permitted_uses_include_customers_affiliatesbooleanWhether use by customer affiliates is permitted
permitted_uses_include_custombooleanWhether a custom permitted use is defined
permitted_uses_include_custom_descriptionstringDescription of the custom permitted use
include_license_limitsbooleanWhether to include license seat or usage limits
include_license_limits_descriptionstringDescription of license limits
warranty_period_typestringWarranty period type. One of: "description", "none". Default: "description"
warranty_period_description_amountintegerWarranty period length
warranty_period_description_durationstringWarranty period unit. One of: "day", "week", "month", "year". Default: "day"
warranty_period_description_duration_startstringWhen the warranty period begins. One of: "initial delivery of the Software", "delivery of the Software and each subsequent Update", "the Order Date". Default: "initial delivery of the Software"
deletion_procedure_include_provider_disablebooleanWhether provider disables access upon termination
deletion_procedure_include_customer_disablebooleanWhether customer must disable access upon termination
deletion_procedure_include_customer_proofbooleanWhether customer must provide proof of deletion
deletion_procedure_include_custombooleanWhether to include a custom deletion procedure
deletion_procedure_include_custom_descriptionstringCustom deletion procedure description
include_license_compliance_verificationbooleanWhether to include license compliance verification
include_license_compliance_verification_descriptionstringCompliance verification description
include_servicesbooleanWhether to include professional services
include_services_descriptionstringProfessional services description
include_pilot_periodbooleanWhether to include a pilot period. Default: false
include_pilot_period_duration_amountintegerLength of the pilot period
include_pilot_period_duration_typestringUnit for pilot duration. One of: "day", "week", "month"
include_pilot_period_include_feesbooleanWhether the pilot period includes fees
include_pilot_period_include_fees_amountnumberPilot period fee amount
include_pilot_period_include_modificationsbooleanWhether modifications are allowed during pilot
include_pilot_period_include_modifications_descriptionstringDescription of allowed modifications
fees_attributesarrayFees on the order form. See Fees below.

Pilot

Pilot Agreement.

ParameterTypeDescription
product_descriptionstringDescription of the product being piloted
pilot_period_descriptionstringDescription of the pilot period
pilot_period_fees_descriptionstringDescription of fees during the pilot
effective_date_typestring"signature" (default) or "date"
effective_datedateRequired when effective_date_type is "date"
fees_typestringWhether the pilot is free or has fees. One of: "free", "pilot_period_fees". Default: "free"
include_payment_processbooleanWhether to specify a payment process. Default: false
payment_process_typestringPayment process type: "invoice" or "automatic"
payment_process_invoice_daysintegerNet payment days. Default: 15
general_cap_amount_typestringLiability cap type. One of: "preceding", "base", "period". Default: "base"
general_cap_amountnumberFixed liability cap. Default: 1000
include_dpabooleanWhether to include a DPA. Default: false
include_dpa_typestringHow the DPA is provided. One of: "description", "attachment", "standard". Default: "standard"
include_dpa_locationstringURL or description of the DPA
include_technical_supportbooleanWhether technical support is included. Default: false
technical_support_descriptionstringDescription of technical support
attachment_idsarrayUUIDs of attachments to include

Partnership

Partnership Agreement.

ParameterTypeDescription
effective_date_typestring"signature" (default) or "date"
effective_datedateRequired when effective_date_type is "date"
general_cap_amount_typestringLiability cap type. One of: "multiple", "currency", "either", "base". Default: "multiple"
general_cap_amount_multiple_valnumberMultiple of fees for the cap. Default: 1
general_cap_amount_currency_valnumberFixed currency cap amount
include_covered_claimsbooleanDefault: false
include_increased_claimsbooleanDefault: false
include_unlimited_claimsbooleanDefault: false
include_additional_warrantiesbooleanDefault: false
include_dpabooleanDefault: false
include_dpa_typestring"description" or "attachment"
include_brand_guidelinesbooleanWhether to include brand guidelines. Default: false
template_partnership_business_terms_attributesobjectNested business terms defaults. See Partnership Business Terms below.
attachment_idsarrayUUIDs of attachments to include

Partnership Business Terms

Pass as template_partnership_business_terms_attributes: { ... }.

ParameterTypeDescription
territory_typestringGeographic territory: "worldwide" (default) or "custom"
territory_type_valstringCustom territory description
end_date_typestringHow the partnership end date is defined. One of: "date", "effective date". Default: "effective date"
end_date_datedatetimeSpecific end date
end_date_after_effective_date_amountintegerDuration amount when end_date_type is "effective date"
end_date_after_effective_date_unitstringDuration unit. One of: "month(s)", "quarter(s)", "year(s)". Default: "year(s)"
include_obligations_company_brandbooleanWhether the company has brand/logo obligations. Default: false
include_obligations_company_referralbooleanWhether the company has referral obligations. Default: false
include_obligations_company_referral_include_criteriabooleanWhether referral criteria are specified. Default: false
include_obligations_company_referral_include_criteria_valstringReferral criteria description
include_obligations_company_referral_include_pay_schbooleanWhether a referral payment schedule is included. Default: false
include_obligations_company_referral_include_pay_sch_amountnumberReferral payment amount
include_obligations_company_referral_include_pay_sch_unitstringReferral payment unit. One of: "U.S. Dollars", "percent"
include_obligations_company_referral_include_pay_sch_customstringCustom referral payment description
include_obligations_company_sponsorshipbooleanWhether the company has sponsorship obligations. Default: false
include_obligations_company_sponsorship_include_benefitsbooleanWhether sponsorship benefits are specified. Default: false
include_obligations_company_sponsorship_include_benefits_valstringSponsorship benefits description
include_obligations_company_sponsorship_include_paymentsbooleanWhether sponsorship payments are specified. Default: false
include_obligations_company_sponsorship_include_payments_amountnumberSponsorship payment amount
include_obligations_company_sponsorship_include_payments_unitstringSponsorship payment unit. One of: "U.S. Dollars", "percent"
include_obligations_company_promotionbooleanWhether the company has promotion obligations. Default: false
include_obligations_company_promotion_include_materialsbooleanWhether promotional materials are specified. Default: false
include_obligations_company_promotion_include_materials_valstringPromotional materials description
include_obligations_company_promotion_include_activitiesbooleanWhether promotional activities are specified. Default: false
include_obligations_company_promotion_include_activities_valstringPromotional activities description
include_obligations_partner_brandbooleanWhether the partner has brand/logo obligations. Default: false
include_obligations_partner_referralbooleanWhether the partner has referral obligations. Default: false
include_obligations_partner_referral_include_criteriabooleanWhether partner referral criteria are specified. Default: false
include_obligations_partner_referral_include_criteria_valstringPartner referral criteria description
include_obligations_partner_referral_include_pay_schbooleanWhether a partner referral payment schedule is included. Default: false
include_obligations_partner_referral_include_pay_sch_amountnumberPartner referral payment amount
include_obligations_partner_referral_include_pay_sch_unitstringPartner referral payment unit. One of: "U.S. Dollars", "percent"
include_obligations_partner_referral_include_pay_sch_customstringCustom partner referral payment description
include_obligations_partner_sponsorshipbooleanWhether the partner has sponsorship obligations. Default: false
include_obligations_partner_sponsorship_include_benefitsbooleanWhether partner sponsorship benefits are specified. Default: false
include_obligations_partner_sponsorship_include_benefits_valstringPartner sponsorship benefits description
include_obligations_partner_sponsorship_include_paymentsbooleanWhether partner sponsorship payments are specified. Default: false
include_obligations_partner_sponsorship_include_payments_amountnumberPartner sponsorship payment amount
include_obligations_partner_sponsorship_include_payments_unitstringPartner sponsorship payment unit. One of: "U.S. Dollars", "percent"
include_obligations_partner_promotionbooleanWhether the partner has promotion obligations. Default: false
include_obligations_partner_promotion_include_materialsbooleanWhether partner promotional materials are specified. Default: false
include_obligations_partner_promotion_include_materials_valstringPartner promotional materials description
include_obligations_partner_promotion_include_activitiesbooleanWhether partner promotional activities are specified. Default: false
include_obligations_partner_promotion_include_activities_valstringPartner promotional activities description
include_payment_processbooleanWhether to include payment process details. Default: false
include_payment_process_companybooleanWhether to specify company payment details. Default: false
include_payment_process_company_include_emailbooleanWhether to include the company's payment email. Default: false
include_payment_process_company_include_email_valstringCompany payment email address
include_payment_process_company_include_addressbooleanWhether to include the company's payment address
include_payment_process_company_include_address_countrystringCompany payment country
include_payment_process_company_include_address_street_addressstringCompany street address
include_payment_process_company_include_address_citystringCompany city
include_payment_process_company_include_address_statestringCompany state
include_payment_process_company_include_address_zipcodestringCompany zip code
include_payment_process_partnerbooleanWhether to specify partner payment details. Default: false
include_payment_process_partner_include_emailbooleanWhether to include the partner's payment email. Default: false
include_payment_process_partner_include_email_valstringPartner payment email address
include_payment_process_partner_include_addressbooleanWhether to include the partner's payment address
include_payment_process_partner_include_address_countrystringPartner payment country
include_payment_process_partner_include_address_street_addressstringPartner street address
include_payment_process_partner_include_address_citystringPartner city
include_payment_process_partner_include_address_statestringPartner state
include_payment_process_partner_include_address_zipcodestringPartner zip code
include_payment_schedulebooleanWhether to include a payment schedule. Default: false
include_payment_schedule_typestringPayment schedule type: "specified" (default) or "custom"
include_payment_schedule_specified_amountintegerPayment schedule amount
include_payment_schedule_specified_unitstringPayment schedule unit. One of: "day(s)", "week(s)", "month(s)", "quarter(s)", "year(s)". Default: "day(s)"
include_payment_schedule_specified_timeframestringPayment schedule timeframe. One of: "receipt", "date"
include_payment_schedule_customstringCustom payment schedule description

BAA

Business Associate Agreement (HIPAA).

ParameterTypeDescription
effective_date_typestring"signature" (default) or "date"
effective_datedateRequired when effective_date_type is "date"
business_associate_relationship_typestringNature of the business associate relationship. One of: "provider", "company". Default: "provider"
breach_notification_valintegerNumber of days for breach notification. Default: 30
breach_notification_unitstringUnit for breach notification period. One of: "hours", "business days", "calendar days". Default: "calendar days"
include_limitationsbooleanWhether to include usage/disclosure limitations. Default: false
include_subcontract_limitationsbooleanWhether to include subcontractor limitations. Default: false
subcontract_limitations_permittedbooleanWhether subcontracting is permitted. Default: false
include_offshore_limitationsbooleanWhether to restrict offshore processing. Default: false
offshore_limitations_permittedbooleanWhether offshore processing is permitted. Default: false
include_deidentification_limitationsbooleanWhether to include de-identification limitations. Default: false
deidentification_limitations_permittedbooleanWhether de-identification is permitted. Default: false
include_aggregation_limitationsbooleanWhether to include aggregation limitations. Default: false
aggregation_limitations_permittedbooleanWhether data aggregation is permitted. Default: false
designated_record_set_provider_maintainsbooleanWhether the provider maintains the designated record set. Default: false
attachment_idsarrayUUIDs of attachments to include

LOI

Letter of Intent.

ParameterTypeDescription
product_namestringName of the product or service
include_functionalitybooleanWhether to describe planned functionality. Default: false
include_functionality_valstringDescription of the functionality
include_feesbooleanWhether fees are included. Default: false
include_fees_include_amountbooleanWhether to specify a fee amount. Default: false
include_fees_amountnumberFee amount
include_fees_amount_durationstringDuration for which fees apply. One of: "month", "year", "quarter"
include_launch_datebooleanWhether to include a target launch date. Default: false
include_launch_date_typestring"date" (default) or "custom"
include_launch_date_datedatetimeSpecific launch date
include_launch_date_customstringCustom launch date description
include_custom_detailsbooleanWhether to include custom details. Default: false
include_custom_details_valstringCustom details text
confidentiality_typestringConfidentiality terms. One of: "mutual", "nda", "provider", "custom". Default: "mutual"
confidentiality_nda_typestringHow the NDA is provided when confidentiality_type is "nda". One of: "description", "attachment". Default: "attachment"
confidentiality_nda_attachment_iduuidAttachment ID of an existing NDA
confidentiality_nda_descriptionstringDescription of the NDA when confidentiality_nda_type is "description"
attachment_idsarrayUUIDs of attachments to include

Fees

The fees_attributes array is supported on CSA, Software License, and PSA order forms. On update, an item without id adds a fee; pass id to change one and id with _destroy: true to remove one. Template responses list each fee with its id. Each fee object has the following fields:

ParameterTypeDescription
typestringFee class. See fee types below.
descriptionstringDisplay label for the fee
quantityintegerQuantity (for per-unit fees)
costnumberFee amount in the order form's fees_currency, as a plain amount, not cents (20 means 20.00). For a percentage Fees::Discount, the percentage (10 means 10%)
stripe_product_idstringStripe product ID (for Stripe-linked fees)
discount_typestringFor Fees::Discount: "fixed_amount" (default) or "percentage"
discount_duration_typestringFor Fees::Discount: "forever" (default), "once", or "multiple_months"
discount_duration_amountintegerFor Fees::Discount with "multiple_months" duration: number of months
attachment_iduuidFor Fees::Attachment: the attachment UUID
graduated_fee_tiers_attributesarrayFor Fees::Graduated: array of tiers with upper_limit, price_per_unit, and flat_price
iduuidID of an existing fee to update or remove. Omit to add a new fee
_destroybooleanSet to true with id to remove that fee

Fee Types

typeDescription
Fees::FlatA fixed flat fee
Fees::DiscountA discount applied to other fees
Fees::CostA cost-based fee
Fees::AttachmentA fee schedule provided as an attached document
Fees::GraduatedA tiered/graduated fee structure
Fees::IncludedA fee described as included in the price
Fees::MeteredA usage-based metered fee
Fees::OneTimeA one-time fee
Fees::TextA text-only fee description (no amount)
Last modified on