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
| type | Agreement |
|---|---|
NDA | Mutual Non-Disclosure Agreement |
CSA | Cloud Service Agreement |
DPA | Data Processing Agreement |
PSA | Professional Services Agreement |
Design | Design Partner Agreement |
Software License | Software License Agreement |
Pilot | Pilot Agreement |
Partnership | Partnership Agreement |
BAA | Business Associate Agreement |
LOI | Letter of Intent |
Common Parameters
These parameters apply to all template types.
| Parameter | Type | Description |
|---|---|---|
name | string | Display name for the template |
governing_law_region | string | State or region whose laws govern the agreement (e.g. "Delaware") |
governing_law_country | string | Country whose laws govern the agreement (e.g. "United States of America") |
chosen_courts_region | string | State or region where disputes are resolved |
chosen_courts_country | string | Country where disputes are resolved |
district_or_county | string | District or county for dispute resolution (e.g. "Court of Chancery") |
negotiations_allowed | boolean | Whether counterparties can propose changes. Default: true |
default_signer_email | string | Email pre-filled as the sender signer when creating agreements |
sender_role | string | Label 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_role | string | Label for the receiving party (e.g. "Customer"). On PSA templates, it must be the other role from sender_role. |
sender_last_to_sign | boolean | When true, the sender signs after the recipient. Default: false |
include_terms | boolean | Whether to include standard terms. Default: true |
include_additional_changes | boolean | Whether to include a section for additional negotiated changes. Default: true |
additional_changes | string | Pre-filled text for additional changes |
NDA
Mutual Non-Disclosure Agreement.
| Parameter | Type | Description |
|---|---|---|
term | integer | Length of the agreement term in years. Required. Default: 1 |
confidentiality_period | integer | Duration of confidentiality obligations in years. Required. Default: 2 |
confidentiality_period_perpetual | boolean | When true, confidentiality obligations do not expire. Default: false |
term_period_perpetual | boolean | When true, the agreement term does not expire. Default: false |
purpose | string | Description of the business purpose for sharing confidential information. Required |
effective_date_type | string | How the effective date is set: "signature" (default) or "date" |
effective_date | date | Specific effective date. Required when effective_date_type is "date" |
effective_date_of_confidentiality | string | When confidentiality obligations begin: "Effective Date" (default) or "date of last disclosure" |
CSA
Cloud Service Agreement.
| Parameter | Type | Description |
|---|---|---|
provider | string | Name of the service provider organization |
customer_description | string | Description of the customer or their use case |
effective_date_type | string | How the effective date is set. One of: "signature", "date", "marketplace_acceptance". Default: "signature" |
effective_date | datetime | Required when effective_date_type is "date" |
general_cap_amount_type | string | Liability cap type. One of: "preceding", "base", "period". Default: "preceding" |
general_cap_preceding_amount | number | Number of preceding months for the liability cap. Required when general_cap_amount_type is "preceding" |
general_cap_amount | number | Fixed liability cap amount. Required when general_cap_amount_type is "base" |
include_covered_claims | boolean | Whether to include a covered claims section. Default: false |
include_increased_cap_amount | boolean | Whether to include an increased cap for specific claim types. Default: false |
increased_cap_amount_type | string | Type of increased cap. One of: "qty", "currency", "period". Default: "qty" |
include_unlimited_claims | boolean | Whether certain claim types have no cap. Default: false |
include_dpa | boolean | Whether to include a Data Processing Agreement. Default: false |
include_dpa_type | string | How the DPA is referenced: "description" or "attachment" |
include_dpa_location | string | URL or description of the DPA when include_dpa_type is "description" |
include_dpa_attachment_id | uuid | Attachment ID of the DPA when include_dpa_type is "attachment" |
include_ai_addendum | boolean | Whether to include an AI addendum. Default: false |
include_ai_addendum_attachment_id | uuid | Required when include_ai_addendum is true |
include_security_policy | boolean | Whether to include a security policy section. Default: false |
include_security_policy_type | string | How the policy is referenced: "description" or "attachment" |
include_acceptable_use_policy | boolean | Whether to include an acceptable use policy. Default: false |
include_additional_warranties | boolean | Whether to include additional warranties. Default: false |
include_insurance_minimums | boolean | Whether to include insurance minimums. Default: false |
include_publicity_rights | boolean | Whether to include publicity rights. Default: false |
include_billing_workflow | boolean | Whether to enable a billing workflow after signing. Default: false |
billing_workflow_type | string | "link" (payment URL) or "stripe" (Stripe-managed billing) |
payment_link_url | string | Payment URL shown after signing. Used when billing_workflow_type is "link" |
stripe_product_id | string | Stripe product ID. Used when billing_workflow_type is "stripe" |
stripe_product_name | string | Stripe product name |
stripe_invoice_delivery | string | "automatic" (default) or "manual" |
stripe_subsequent_bill_method | string | How Stripe bills after the first invoice. One of: "automatic", "invoice". Default: "automatic" |
template_csa_order_form_attributes | object | Nested order form defaults. See CSA Order Form below. |
attachment_ids | array | UUIDs of attachments to include with the template |
CSA Order Form
Pass as template_csa_order_form_attributes: { ... }.
| Parameter | Type | Description |
|---|---|---|
cloud_service_description | string | Description of the cloud service being provided. Required. |
subscription_period | integer | Length of the subscription. Default: 1 |
subscription_period_unit | string | Unit for subscription period (e.g. "year(s)"). Default: "year(s)" |
subscription_start_date_type | string | How the subscription start date is set. One of: "effective_date", "date". Default: "effective_date" |
subscription_start_date | datetime | Specific subscription start date |
include_subscription_start_date | boolean | Whether to include a subscription start date field. Default: false |
include_subscription_start_date_date | date | Specific start date when include_subscription_start_date is true |
subscription_auto_renew | string | Auto-renewal setting. One of: "days", "subscription_end". Default: "days" |
subscription_renewal_notice_days | integer | Days of notice required before renewal. Default: 30 |
order_date_type | string | How the order date is set: "signature", "date", or "other" |
order_date_date | datetime | Specific order date |
order_date_other | string | Custom order date description. Required when order_date_type is "other" |
affiliates_as_users | boolean | Whether customer affiliates may use the service. Default: false |
include_use_limitations | boolean | Whether to include use limitations. Default: false |
include_use_limitations_val | string | Description of use limitations |
include_max_users | boolean | Whether to cap the number of users. Default: false |
max_users | integer | Maximum number of users. Default: 10 |
include_consumption | boolean | Whether to include a consumption limit. Default: false |
max_consumption | integer | Maximum consumption amount |
consumption_units | string | Units for consumption (e.g. "API calls") |
include_additional_parameters_or_limitations | boolean | Whether to include additional use parameters. Default: false |
additional_parameters_or_limitations | string | Text describing additional parameters or limitations |
include_fees | boolean | Whether to include fees. Default: false |
include_fees_table | boolean | Whether fees are displayed as a table. Default: false |
include_fees_table_period | string | Billing period for the fees table. One of: "Subscription Period", "month", "year", "User" |
include_fees_other | boolean | Whether to include a custom fee description. Default: false |
include_fees_other_val | string | Custom fee description text |
include_fees_include_attachment | boolean | Whether to attach a fee schedule document. Default: false |
include_fees_attachment_id | uuid | Attachment ID for the fee schedule |
fees_currency | string | Currency for fees. One of: "USD", "EUR", "GBP", "CAD", "AUD", "SGD", "ILS", "JPY", "CHF", "HKD". Default: "USD" |
fees_inclusive_of_taxes | boolean | Whether fees are inclusive of taxes. Default: false |
fees_include_fee_increase_upon_renewal | boolean | Whether fees increase at renewal. Default: false |
fees_include_fee_increase_upon_renewal_fee | number | Fee increase percentage. Default: 5.0 |
fees_include_fee_increase_upon_renewal_type | string | Whether fees will or may increase on renewal. One of: "will", "may". Default: "will" |
fee_amount | number | Fixed fee amount |
fee_period | string | Billing period. One of: "Subscription Period", "month", "year", "User", "Custom unit". Default: "Subscription Period" |
fee_custom_unit | string | Custom billing unit description |
include_free_trial | boolean | Whether to include a free trial period. Default: false |
free_trial_days | integer | Length of the free trial in days |
payment_period | integer | Payment due period in days. Default: 30 |
payment_period_unit | string | Unit for payment period. One of: "day(s)", "week(s)", "month(s)", "marketplace_acceptance". Default: "day(s)" |
payment_period_timeframe | string | When the payment clock starts. One of: "Customer's receipt of invoice", "date of invoice" |
payment_process_type | string | Payment process. One of: "automatic", "invoice", "custom", "marketplace_acceptance". Default: "automatic" |
payment_process_automatic_frequency | string | Frequency for automatic billing. One of: "monthly", "quarterly", "semiannually", "annually". Default: "monthly" |
payment_process_type_invoice_amount | integer | Invoice payment due days |
payment_process_type_invoice_type | string | Invoice period type. One of: "monthly", "quarterly", "semiannually", "annually", "Custom unit". Default: "monthly" |
payment_process_type_invoice_duration | string | Invoice duration. One of: "day", "week", "month", "year", "day(s)", "week(s)", "month(s)", "year(s)" |
payment_process_type_invoice_duration_start | string | When the invoice duration starts. One of: "Customer's receipt of invoice", "date of invoice" |
payment_process_type_custom_val | string | Custom payment process description. Required when payment_process_type is "custom" |
invoice_period | string | Invoice period description. One of: "monthly", "quarterly", "semiannually", "annually", "Custom unit", "Monthly", "Quarterly", "Semiannually", "Annually". Default: "annually" |
include_sla | boolean | Whether to include a Service Level Agreement. Default: false |
include_sla_type | string | How the SLA is referenced: "description", "standard", or "attachment". Default: "description" |
include_sla_description | string | SLA description text |
include_sla_attachment_id | uuid | Attachment ID for the SLA document |
include_sla_include_target_uptime | boolean | Whether the SLA includes a target uptime commitment. Default: false |
include_sla_standard_target_uptime | number | Target uptime percentage (e.g. 99.9) |
include_sla_include_response_time | boolean | Whether the SLA includes response time SLOs. Default: false |
include_sla_include_response_time_amount | integer | Response time amount |
include_sla_include_response_time_duration | string | Response time unit. One of: "hour", "day", "week", "month", "hours". Default: "hours" |
include_sla_include_response_time_credit | number | Service credit percentage for response time breaches |
include_sla_include_response_time_support_channel | string | Support channel (e.g. "email") |
include_sla_maintenance_window | boolean | Whether to include a maintenance window |
include_sla_maintenance_window_type | string | Maintenance window type. One of: "standard", "none". Default: "standard" |
include_sla_standard_maintenance_window_start_time | string | Maintenance window start time |
include_sla_standard_maintenance_window_end_time | string | Maintenance window end time |
include_sla_standard_maintenance_window_monday | boolean | Monday maintenance window. Default: false |
include_sla_standard_maintenance_window_tuesday | boolean | Tuesday maintenance window. Default: false |
include_sla_standard_maintenance_window_wednesday | boolean | Wednesday maintenance window. Default: false |
include_sla_standard_maintenance_window_thursday | boolean | Thursday maintenance window. Default: false |
include_sla_standard_maintenance_window_friday | boolean | Friday maintenance window. Default: false |
include_sla_standard_maintenance_window_saturday | boolean | Saturday maintenance window. Default: false |
include_sla_standard_maintenance_window_sunday | boolean | Sunday maintenance window. Default: false |
include_sla_maintenance_notice | boolean | Whether to include maintenance notice requirements |
include_sla_standard_maintenance_notice_qty | number | Advance notice quantity |
include_sla_standard_maintenance_notice_unit | string | Advance notice unit. One of: "hour", "day", "week", "month". Default: "hour" |
include_sla_maintenance_custom | boolean | Whether 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_val | string | Custom 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_support | boolean | Whether to include a product support section. Default: false |
include_product_support_type | string | "description" (default) or "attachment" |
include_product_support_description | string | Product support description |
include_product_support_attachment_id | uuid | Attachment ID for the support policy |
include_professional_services | boolean | Whether to include professional services. Default: false |
include_professional_services_type | string | "description" (default) or "attachment" |
include_professional_services_description | string | Professional services description |
include_professional_services_custom_name | string | Custom name for the professional services section |
include_professional_services_include_end_date | boolean | Whether to include an end date for professional services. Default: false |
include_professional_services_end_date | datetime | End date for professional services |
include_professional_services_include_fees_description | boolean | Whether to include a fees description. Default: false |
include_professional_services_fees_description | string | Fees description for professional services |
include_professional_services_attachment_id | uuid | Attachment ID for professional services document |
include_pilot_period | boolean | Whether to include a pilot period before the subscription. Default: false |
include_pilot_period_duration_amount | integer | Length of the pilot period |
include_pilot_period_duration_type | string | Unit for pilot duration. One of: "day", "week", "month". Default: "day" |
include_pilot_period_include_fees | boolean | Whether the pilot period includes fees. Default: false |
include_pilot_period_include_fees_amount | number | Pilot period fee amount |
include_pilot_period_include_modifications | boolean | Whether modifications are allowed during the pilot. Default: false |
include_pilot_period_include_modifications_description | string | Description of allowed modifications |
include_billing_info | boolean | Whether to include billing contact information. Default: false |
include_usage_review | boolean | Whether to include a usage review clause. Default: false |
include_usage_review_val | string | Usage review description |
fees_attributes | array | Fees to include on the order form. See Fees below. |
service_credits_attributes | array | Service credits. Each item: { min, max, credit } |
use_limitations_attributes | array | Use 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.
| Parameter | Type | Description |
|---|---|---|
provider | string | Name of the data processor (service provider) |
customer_description | string | Description of the data controller (customer) |
underlying_agreement_val | string | Description of the agreement this DPA is attached to (e.g. "MSA dated January 1, 2026") |
approved_subprocessor_type | string | "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_location | string | Where the subprocessor list is posted, when approved_subprocessor_type is "external" |
security_policy_type | string | Where the Security Policy is defined: "defined in agreement", "provider service" (commercially reasonable efforts), or "external". Default: "defined in agreement" |
security_policy_available_at | string | Where the Security Policy is available, when security_policy_type is "external" |
include_security_policy | boolean | Whether 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_law | boolean | Whether to override the underlying agreement's governing law and chosen courts for this DPA. Default: false |
include_governing_law_country | string | Governing country when include_governing_law is true (e.g. "USA") |
include_governing_law_state | string | Governing state or region when include_governing_law is true |
include_governing_country_eu | boolean | Whether EU Standard Contractual Clauses apply. Default: true |
include_governing_country_eu_val | string | EU member state for SCCs. Default: "Netherlands" |
include_governing_country_uk | boolean | Whether UK GDPR addendum applies. Default: false |
include_governing_country_uk_val | string | UK territory designation. Default: "England and Wales" |
include_provider_security_contact_email | boolean | Whether to include a security contact email. Default: true |
include_provider_security_contact_email_val | string | Security contact email address |
include_provider_security_contact_address | boolean | Whether to include a security contact mailing address. Default: false |
include_provider_security_contact_address_street_address | string | Security contact street address. Also _city, _state, _zipcode, and _country |
include_covered_claim | boolean | Whether to include a covered claims / indemnification section. Default: false |
include_covered_claim_type | string | "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_val | string | Description of the internal covered claims |
include_covered_claim_external_val | string | Description of the external covered claims |
include_liability_cap | boolean | Whether to include a separate DPA liability cap. Default: false |
include_liability_cap_csa_type | string | "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_internal | number | Fixed cap amount for "internal". Default: 5000000 |
include_liability_cap_amount_constant_internal | string | Multiplier of the prior 12 months' fees for "internal". Default: "10" |
include_liability_cap_amount_currency_external | number | Fixed cap amount for "external". Default: 5000000 |
include_liability_cap_amount_constant_external | string | Multiplier of the prior 12 months' fees for "external". Default: "10" |
include_data_subjects_end_users | boolean | Whether end users are a covered data subject category. Default: true |
include_data_subjects_employees | boolean | Whether employees are a covered data subject category. Default: false |
include_data_subjects_custom | boolean | Whether to include a custom data subject category. Default: false |
include_data_subjects_custom_val | string | Description of the custom data subject category |
include_personal_data_name | boolean | Names included in personal data. Default: true |
include_personal_data_contact_info | boolean | Contact information included. Default: false |
include_personal_data_financial_info | boolean | Financial information included. Default: false |
include_personal_data_employment_info | boolean | Employment information included. Default: false |
include_personal_data_biographic_info | boolean | Biographic information included. Default: false |
include_personal_data_transactional_info | boolean | Transactional information included. Default: false |
include_personal_data_user_activity_info | boolean | User activity information included. Default: false |
include_personal_data_location | boolean | Location data included. Default: false |
include_personal_data_custom | boolean | Custom personal data category. Default: false |
include_personal_data_custom_val | string | Description of the custom personal data category |
include_special_category_data | boolean | Whether special category data (health, biometric, etc.) is processed. Default: false |
include_sensitive_data_restrictions_security_policy | boolean | Whether the Security Policy sets the restrictions on sensitive data. Default: true |
include_sensitive_data_restrictions_custom | boolean | Whether to describe the restrictions on sensitive data. Default: false |
include_sensitive_data_restrictions_custom_val | string | Description of the restrictions applied to sensitive data |
include_processing_purpose_receiving | boolean | Receiving is a purpose of processing. Default: true |
include_processing_purpose_holding | boolean | Holding is a purpose of processing. Default: false |
include_processing_purpose_using | boolean | Using is a purpose of processing. Default: false |
include_processing_purpose_updating | boolean | Updating is a purpose of processing. Default: false |
include_processing_purpose_protecting | boolean | Protecting is a purpose of processing. Default: false |
include_processing_purpose_sharing | boolean | Sharing is a purpose of processing. Default: false |
include_processing_purpose_returning | boolean | Returning is a purpose of processing. Default: false |
include_processing_purpose_erasing | boolean | Erasing is a purpose of processing. Default: false |
include_processing_purpose_custom | boolean | Whether to add a custom purpose of processing. Default: false |
include_processing_purpose_custom_val | string | Description of the custom purpose of processing |
include_frequency_of_transfer_continuous | boolean | Whether data transfers are continuous. Default: true |
include_frequency_of_transfer_custom | boolean | Whether to specify a custom transfer frequency. Default: false |
include_frequency_of_transfer_custom_val | string | Custom transfer frequency description |
duration_of_processing | string | Description of how long data is processed |
competent_supervisory_authority | string | Name of the competent supervisory authority |
include_service_provider_relationship | boolean | Whether to include the CCPA service provider clause. Default: true |
cloud_service_product_name | string | Description of the Service |
data_importer_contact_name | string | Data importer contact name. Also data_importer_contact_position and data_importer_contact_details |
data_importer_address_street_address | string | Data importer street address. Also _city, _state, and _zipcode |
data_importer_address_country | string | Data importer's country. Default: "USA" |
subprocessors_attributes | array | Subprocessors, 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.
| Parameter | Type | Description |
|---|---|---|
include_security_measures_security_policy | boolean | When true, the annex refers to the Security Policy instead of listing measures. Default: true |
include_security_measures_pseudonym_encryption | boolean | Include "Pseudonymization and encryption of personal data". Default: false |
include_security_measures_pseudonym_encryption_val | string | How pseudonymization and encryption are handled |
include_security_measures_confidentiality_integrity | boolean | Include "Ensuring ongoing confidentiality, integrity, availability, and resilience of processing systems and services". Default: false |
include_security_measures_confidentiality_integrity_val | string | How confidentiality, integrity, availability, and resilience are ensured |
include_security_measures_restore_data_access | boolean | Include "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_val | string | How availability and access are restored after an incident |
include_security_measures_testing_assessment | boolean | Include "Regular testing, assessment, and evaluation of the effectiveness of technical and organizational measures". Default: false |
include_security_measures_testing_assessment_val | string | How measures are tested, assessed, and evaluated |
include_security_measures_identity_auth | boolean | Include "User identification and authorization process and protection". Default: false |
include_security_measures_identity_auth_val | string | How users are identified and authorized |
include_security_measures_data_transmission | boolean | Include "Protecting Customer Personal Data during transmission (in transit)". Default: false |
include_security_measures_data_transmission_val | string | How data is protected in transit |
include_security_measures_data_at_rest | boolean | Include "Protecting Customer Personal Data during storage (at rest)". Default: false |
include_security_measures_data_at_rest_val | string | How data is protected at rest |
include_security_measures_physical_security | boolean | Include "Physical security where Customer Personal Data is processed". Default: false |
include_security_measures_physical_security_val | string | How the processing locations are physically secured |
include_security_measures_event_logging | boolean | Include "Events logging". Default: false |
include_security_measures_event_logging_val | string | How events are logged |
include_security_measures_system_configuration | boolean | Include "Systems configuration, including default configuration". Default: false |
include_security_measures_system_configuration_val | string | How systems are configured |
include_security_measures_it_security_governance | boolean | Include "Internal IT and IT security governance and management". Default: false |
include_security_measures_it_security_governance_val | string | How IT and IT security are governed |
include_security_measures_certification_or_assurance | boolean | Include "Certification or assurance of processes and products". Default: false |
include_security_measures_certification_or_assurance_val | string | Which certifications or assurances apply |
include_security_measures_data_minimization | boolean | Include "Ensuring data minimization". Default: false |
include_security_measures_data_minimization_val | string | How data minimization is ensured |
include_security_measures_data_quality | boolean | Include "Ensuring data quality". Default: false |
include_security_measures_data_quality_val | string | How data quality is ensured |
include_security_measures_data_retention | boolean | Include "Ensuring limited data retention". Default: false |
include_security_measures_data_retention_val | string | How data retention is limited |
include_security_measures_accountability | boolean | Include "Ensuring accountability". Default: false |
include_security_measures_accountability_val | string | How accountability is ensured |
include_security_measures_portability_and_erasure | boolean | Include "Allowing data portability and erasure". Default: false |
include_security_measures_portability_and_erasure_val | string | How data portability and erasure are allowed |
PSA
Professional Services Agreement.
| Parameter | Type | Description |
|---|---|---|
effective_date_type | string | "signature" or "date" |
effective_date | date | Required when effective_date_type is "date" |
general_cap_amount_type | string | Liability cap type. One of: "preceding", "base", "period". Default: "preceding" |
general_cap_preceding_amount | number | Preceding months for liability cap |
general_cap_amount | number | Fixed liability cap amount |
include_covered_claims | boolean | Whether to include covered claims. Default: false |
include_increased_claims | boolean | Whether certain claims have an elevated cap. Default: false |
include_unlimited_claims | boolean | Whether certain claims are uncapped. Default: false |
include_additional_warranties | boolean | Whether to include additional warranties. Default: false |
include_dpa | boolean | Whether to include a DPA. Default: false |
include_dpa_type | string | "description" or "attachment" |
include_dpa_location | string | URL or description of the DPA |
include_dpa_attachment_id | uuid | Attachment ID for the DPA |
include_security_policy | boolean | Whether to include a security policy. Default: false |
include_security_policy_type | string | "description" or "attachment" |
include_provider_insurance_min | boolean | Whether to include provider insurance minimums. Default: false |
include_customer_insurance_min | boolean | Whether to include customer insurance minimums. Default: false |
include_publicity_rights | boolean | Whether to include publicity rights. Default: false |
include_customer_policies | boolean | Whether to reference customer policies. Default: false |
template_psa_statement_of_work_attributes | object | Nested statement of work defaults. See PSA Statement of Work below. |
attachment_ids | array | UUIDs of attachments to include |
PSA Statement of Work
Pass as template_psa_statement_of_work_attributes: { ... }.
| Parameter | Type | Description |
|---|---|---|
services_description | string | Description of the services to be performed. Required. |
sow_date_type | string | How the SOW date is set: "signature" or "date" |
sow_date | date | Specific SOW effective date |
sow_term_type | string | How the SOW term is defined. One of: "deliverables", "period", "date". Default: "deliverables" |
sow_term_amount | integer | Length of the SOW term |
sow_term_unit | string | Unit for SOW term. One of: "month(s)", "quarter(s)", "year(s)". Default: "month(s)" |
sow_term_date | date | Specific SOW end date |
include_deliverables | boolean | Whether to include a deliverables section. Default: false |
include_deliverables_description | string | Description of deliverables |
include_deliverables_include_draft_deliverables | boolean | Whether to include a draft deliverables review process |
include_deliverables_include_acceptance | boolean | Whether to include a formal acceptance process. Default: false |
include_deliverables_rejection_amount | integer | Days to reject a deliverable |
include_deliverables_rejection_unit | string | Unit for rejection period. One of: "hours", "days", "weeks", "months". Default: "days" |
include_deliverables_resubmission_amount | integer | Days to resubmit a rejected deliverable |
include_deliverables_resubmission_unit | string | Unit for resubmission period. One of: "hours", "days", "weeks", "months". Default: "days" |
include_deliverables_include_attachment | boolean | Whether to attach a deliverables schedule. Default: false |
include_deliverables_attachment_id | uuid | Attachment ID for the deliverables schedule |
include_time_of_assignment | boolean | Whether to include time-of-assignment provisions. Default: false |
include_time_of_assignment_type | string | Type of time-of-assignment provision. One of: "created", "paid". Default: "paid" |
include_third_party_materials | boolean | Whether to include third-party materials provisions. Default: false |
include_third_party_provider | boolean | Whether the provider may use third-party materials. Default: false |
include_third_party_customer | boolean | Whether the customer may use third-party materials. Default: false |
include_third_party_include_description | boolean | Whether to describe the third-party materials. Default: false |
include_third_party_include_description_val | string | Description of third-party materials |
include_fees_table | boolean | Whether to include a fees table. Default: false |
include_fees_table_total | boolean | Whether to include a total row in the fees table |
include_fees_other | boolean | Whether to include a custom fee description. Default: false |
include_fees_other_val | string | Custom fee description |
include_fees_travel | boolean | Whether to include travel expense reimbursement. Default: false |
include_fees_travel_type | string | How travel reimbursement is defined: "description" or "attachment" |
include_fees_travel_val | string | Travel reimbursement description |
include_fees_travel_attachment_id | uuid | Attachment ID for travel policy |
payment_period_type | string | Payment due period type. One of: "standard", "other". Default: "standard" |
payment_period | integer | Payment due period amount |
payment_period_unit | string | Unit for payment period. One of: "day(s)", "week(s)", "month(s)", "quarter(s)", "year(s)". Default: "day(s)" |
payment_period_timeframe | string | When the payment clock starts. One of: "receipt", "invoice", "Customer's receipt of invoice", "date of invoice" |
payment_period_other | string | Custom payment period description |
invoice_period_description | string | Description of when invoices are issued |
include_customer_obligation | boolean | Whether to include a customer obligations section. Default: false |
include_customer_obligation_val | string | Description of customer obligations |
fees_attributes | array | Fees 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.
| Parameter | Type | Description |
|---|---|---|
product_description | string | Description of the product being piloted |
customer_description | string | Description of the design partner |
effective_date_type | string | "signature" (default) or "date" |
effective_date | date | Required when effective_date_type is "date" |
term_amount | integer | Length of the program. Default: 6 |
term_unit | string | Unit for the term. One of: "day(s)", "week(s)", "month(s)", "quarter(s)", "year(s)". Default: "month(s)" |
include_program_participation_feedback | boolean | Whether customer provides feedback. Default: true |
include_program_participation_feedback_amount | integer | Number of feedback sessions |
include_program_participation_feedback_unit | string | Unit for feedback sessions. One of: "month", "quarter", "year", "Term". Default: "month" |
include_program_appear_as_customer_private | boolean | Whether provider can reference customer privately. Default: true |
include_program_appear_as_customer_public | boolean | Whether provider can reference customer publicly. Default: true |
include_program_case_study | boolean | Whether a case study is included. Default: false |
include_program_reference | boolean | Whether the customer serves as a reference. Default: false |
include_program_discount | boolean | Whether a discount is offered. Default: true |
include_program_discount_amount | number | Discount amount. Default: 20 |
include_program_discount_unit | string | Discount unit. One of: "U.S. Dollars", "percent". Default: "percent" |
include_program_develop_functionality | boolean | Whether the provider develops custom functionality. Default: false |
include_fees | boolean | Whether the agreement includes fees. Default: false |
include_fees_type | string | Fee type. One of: "default_language", "description". Default: "default_language" |
include_fees_amount | number | Fee amount |
include_fees_unit | string | Fee unit. One of: "month", "quarter", "year", "Term" |
attachment_ids | array | UUIDs of attachments to include |
Software License
Software License Agreement.
| Parameter | Type | Description |
|---|---|---|
effective_date_type | string | "signature" or "date" |
effective_date | date | Required when effective_date_type is "date" |
general_cap_amount_type | string | Liability cap type. One of: "preceding", "base", "period". Default: "preceding" |
general_cap_preceding_amount | number | Preceding months for liability cap. Default: 1 |
general_cap_amount | number | Fixed liability cap amount |
include_covered_claims | boolean | Default: false |
include_increased_claims | boolean | Default: false |
include_unlimited_claims | boolean | Default: false |
include_additional_warranties | boolean | Default: false |
include_dpa | boolean | Default: false |
include_dpa_type | string | "description" or "attachment" |
include_dpa_attachment_id | uuid | Attachment ID for the DPA |
include_ai_addendum | boolean | Default: false |
include_ai_addendum_attachment_id | uuid | Required when include_ai_addendum is true |
include_billing_workflow | boolean | Default: false |
billing_workflow_type | string | "link" or "stripe" |
payment_link_url | string | Payment URL after signing |
stripe_product_id | string | Stripe product ID |
stripe_invoice_delivery | string | "automatic" (default) or "manual" |
template_software_license_order_form_attributes | object | Nested order form defaults. See Software License Order Form below. |
attachment_ids | array | UUIDs of attachments to include |
Software License Order Form
Pass as template_software_license_order_form_attributes: { ... }.
| Parameter | Type | Description |
|---|---|---|
software_description | string | Description of the software being licensed. Required. |
order_date_type | string | How the order date is set. One of: "signature", "date", "other". Default: "signature" |
order_date_date | date | Specific order date |
subscription_period | integer | Length of the subscription |
subscription_period_unit | string | Unit for subscription period (e.g. "year"). Default: "year" |
subscription_auto_renew | string | Auto-renewal setting. One of: "days", "subscription_end". Default: "days" |
subscription_renewal_notice_days | integer | Days of notice required before renewal |
fee_period | string | Billing period. One of: "Subscription Period", "month", "year", "Custom unit" |
fee_custom_unit | string | Custom billing unit description |
fees_currency | string | Currency for fees. One of: "USD", "EUR", "GBP", "CAD", "AUD", "SGD", "ILS", "JPY", "CHF", "HKD". Default: "USD" |
fees_inclusive_of_taxes | boolean | Whether fees are inclusive of taxes |
fees_include_fee_increase_upon_renewal | boolean | Whether fees increase at renewal |
fees_include_fee_increase_upon_renewal_fee | number | Fee increase percentage |
fees_include_fee_increase_upon_renewal_type | string | Whether fees will or may increase on renewal. One of: "will", "may". Default: "will" |
payment_process_type | string | Payment process: "invoice", "automatic", or "custom" |
payment_process_automatic_frequency | string | Frequency for automatic billing. One of: "monthly", "quarterly", "semiannually", "annually". Default: "monthly" |
payment_process_type_invoice_amount | integer | Invoice payment due days |
payment_process_type_invoice_type | string | Invoice period type. One of: "monthly", "quarterly", "semiannually", "annually", "Custom unit". Default: "monthly" |
payment_process_type_invoice_duration | string | Invoice duration. One of: "day", "week", "month", "year", "day(s)", "week(s)", "month(s)", "year(s)" |
payment_process_type_invoice_duration_start | string | When the invoice duration starts. One of: "Customer's receipt of invoice", "date of invoice" |
payment_process_type_custom_val | string | Custom payment process description. Required when payment_process_type is "custom" |
include_payment_process_include_billing_email | boolean | Whether to include a billing email field. Default: false |
permitted_uses_include_internal_business | boolean | Whether internal business use is permitted |
permitted_uses_include_customers_affiliates | boolean | Whether use by customer affiliates is permitted |
permitted_uses_include_custom | boolean | Whether a custom permitted use is defined |
permitted_uses_include_custom_description | string | Description of the custom permitted use |
include_license_limits | boolean | Whether to include license seat or usage limits |
include_license_limits_description | string | Description of license limits |
warranty_period_type | string | Warranty period type. One of: "description", "none". Default: "description" |
warranty_period_description_amount | integer | Warranty period length |
warranty_period_description_duration | string | Warranty period unit. One of: "day", "week", "month", "year". Default: "day" |
warranty_period_description_duration_start | string | When 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_disable | boolean | Whether provider disables access upon termination |
deletion_procedure_include_customer_disable | boolean | Whether customer must disable access upon termination |
deletion_procedure_include_customer_proof | boolean | Whether customer must provide proof of deletion |
deletion_procedure_include_custom | boolean | Whether to include a custom deletion procedure |
deletion_procedure_include_custom_description | string | Custom deletion procedure description |
include_license_compliance_verification | boolean | Whether to include license compliance verification |
include_license_compliance_verification_description | string | Compliance verification description |
include_services | boolean | Whether to include professional services |
include_services_description | string | Professional services description |
include_pilot_period | boolean | Whether to include a pilot period. Default: false |
include_pilot_period_duration_amount | integer | Length of the pilot period |
include_pilot_period_duration_type | string | Unit for pilot duration. One of: "day", "week", "month" |
include_pilot_period_include_fees | boolean | Whether the pilot period includes fees |
include_pilot_period_include_fees_amount | number | Pilot period fee amount |
include_pilot_period_include_modifications | boolean | Whether modifications are allowed during pilot |
include_pilot_period_include_modifications_description | string | Description of allowed modifications |
fees_attributes | array | Fees on the order form. See Fees below. |
Pilot
Pilot Agreement.
| Parameter | Type | Description |
|---|---|---|
product_description | string | Description of the product being piloted |
pilot_period_description | string | Description of the pilot period |
pilot_period_fees_description | string | Description of fees during the pilot |
effective_date_type | string | "signature" (default) or "date" |
effective_date | date | Required when effective_date_type is "date" |
fees_type | string | Whether the pilot is free or has fees. One of: "free", "pilot_period_fees". Default: "free" |
include_payment_process | boolean | Whether to specify a payment process. Default: false |
payment_process_type | string | Payment process type: "invoice" or "automatic" |
payment_process_invoice_days | integer | Net payment days. Default: 15 |
general_cap_amount_type | string | Liability cap type. One of: "preceding", "base", "period". Default: "base" |
general_cap_amount | number | Fixed liability cap. Default: 1000 |
include_dpa | boolean | Whether to include a DPA. Default: false |
include_dpa_type | string | How the DPA is provided. One of: "description", "attachment", "standard". Default: "standard" |
include_dpa_location | string | URL or description of the DPA |
include_technical_support | boolean | Whether technical support is included. Default: false |
technical_support_description | string | Description of technical support |
attachment_ids | array | UUIDs of attachments to include |
Partnership
Partnership Agreement.
| Parameter | Type | Description |
|---|---|---|
effective_date_type | string | "signature" (default) or "date" |
effective_date | date | Required when effective_date_type is "date" |
general_cap_amount_type | string | Liability cap type. One of: "multiple", "currency", "either", "base". Default: "multiple" |
general_cap_amount_multiple_val | number | Multiple of fees for the cap. Default: 1 |
general_cap_amount_currency_val | number | Fixed currency cap amount |
include_covered_claims | boolean | Default: false |
include_increased_claims | boolean | Default: false |
include_unlimited_claims | boolean | Default: false |
include_additional_warranties | boolean | Default: false |
include_dpa | boolean | Default: false |
include_dpa_type | string | "description" or "attachment" |
include_brand_guidelines | boolean | Whether to include brand guidelines. Default: false |
template_partnership_business_terms_attributes | object | Nested business terms defaults. See Partnership Business Terms below. |
attachment_ids | array | UUIDs of attachments to include |
Partnership Business Terms
Pass as template_partnership_business_terms_attributes: { ... }.
| Parameter | Type | Description |
|---|---|---|
territory_type | string | Geographic territory: "worldwide" (default) or "custom" |
territory_type_val | string | Custom territory description |
end_date_type | string | How the partnership end date is defined. One of: "date", "effective date". Default: "effective date" |
end_date_date | datetime | Specific end date |
end_date_after_effective_date_amount | integer | Duration amount when end_date_type is "effective date" |
end_date_after_effective_date_unit | string | Duration unit. One of: "month(s)", "quarter(s)", "year(s)". Default: "year(s)" |
include_obligations_company_brand | boolean | Whether the company has brand/logo obligations. Default: false |
include_obligations_company_referral | boolean | Whether the company has referral obligations. Default: false |
include_obligations_company_referral_include_criteria | boolean | Whether referral criteria are specified. Default: false |
include_obligations_company_referral_include_criteria_val | string | Referral criteria description |
include_obligations_company_referral_include_pay_sch | boolean | Whether a referral payment schedule is included. Default: false |
include_obligations_company_referral_include_pay_sch_amount | number | Referral payment amount |
include_obligations_company_referral_include_pay_sch_unit | string | Referral payment unit. One of: "U.S. Dollars", "percent" |
include_obligations_company_referral_include_pay_sch_custom | string | Custom referral payment description |
include_obligations_company_sponsorship | boolean | Whether the company has sponsorship obligations. Default: false |
include_obligations_company_sponsorship_include_benefits | boolean | Whether sponsorship benefits are specified. Default: false |
include_obligations_company_sponsorship_include_benefits_val | string | Sponsorship benefits description |
include_obligations_company_sponsorship_include_payments | boolean | Whether sponsorship payments are specified. Default: false |
include_obligations_company_sponsorship_include_payments_amount | number | Sponsorship payment amount |
include_obligations_company_sponsorship_include_payments_unit | string | Sponsorship payment unit. One of: "U.S. Dollars", "percent" |
include_obligations_company_promotion | boolean | Whether the company has promotion obligations. Default: false |
include_obligations_company_promotion_include_materials | boolean | Whether promotional materials are specified. Default: false |
include_obligations_company_promotion_include_materials_val | string | Promotional materials description |
include_obligations_company_promotion_include_activities | boolean | Whether promotional activities are specified. Default: false |
include_obligations_company_promotion_include_activities_val | string | Promotional activities description |
include_obligations_partner_brand | boolean | Whether the partner has brand/logo obligations. Default: false |
include_obligations_partner_referral | boolean | Whether the partner has referral obligations. Default: false |
include_obligations_partner_referral_include_criteria | boolean | Whether partner referral criteria are specified. Default: false |
include_obligations_partner_referral_include_criteria_val | string | Partner referral criteria description |
include_obligations_partner_referral_include_pay_sch | boolean | Whether a partner referral payment schedule is included. Default: false |
include_obligations_partner_referral_include_pay_sch_amount | number | Partner referral payment amount |
include_obligations_partner_referral_include_pay_sch_unit | string | Partner referral payment unit. One of: "U.S. Dollars", "percent" |
include_obligations_partner_referral_include_pay_sch_custom | string | Custom partner referral payment description |
include_obligations_partner_sponsorship | boolean | Whether the partner has sponsorship obligations. Default: false |
include_obligations_partner_sponsorship_include_benefits | boolean | Whether partner sponsorship benefits are specified. Default: false |
include_obligations_partner_sponsorship_include_benefits_val | string | Partner sponsorship benefits description |
include_obligations_partner_sponsorship_include_payments | boolean | Whether partner sponsorship payments are specified. Default: false |
include_obligations_partner_sponsorship_include_payments_amount | number | Partner sponsorship payment amount |
include_obligations_partner_sponsorship_include_payments_unit | string | Partner sponsorship payment unit. One of: "U.S. Dollars", "percent" |
include_obligations_partner_promotion | boolean | Whether the partner has promotion obligations. Default: false |
include_obligations_partner_promotion_include_materials | boolean | Whether partner promotional materials are specified. Default: false |
include_obligations_partner_promotion_include_materials_val | string | Partner promotional materials description |
include_obligations_partner_promotion_include_activities | boolean | Whether partner promotional activities are specified. Default: false |
include_obligations_partner_promotion_include_activities_val | string | Partner promotional activities description |
include_payment_process | boolean | Whether to include payment process details. Default: false |
include_payment_process_company | boolean | Whether to specify company payment details. Default: false |
include_payment_process_company_include_email | boolean | Whether to include the company's payment email. Default: false |
include_payment_process_company_include_email_val | string | Company payment email address |
include_payment_process_company_include_address | boolean | Whether to include the company's payment address |
include_payment_process_company_include_address_country | string | Company payment country |
include_payment_process_company_include_address_street_address | string | Company street address |
include_payment_process_company_include_address_city | string | Company city |
include_payment_process_company_include_address_state | string | Company state |
include_payment_process_company_include_address_zipcode | string | Company zip code |
include_payment_process_partner | boolean | Whether to specify partner payment details. Default: false |
include_payment_process_partner_include_email | boolean | Whether to include the partner's payment email. Default: false |
include_payment_process_partner_include_email_val | string | Partner payment email address |
include_payment_process_partner_include_address | boolean | Whether to include the partner's payment address |
include_payment_process_partner_include_address_country | string | Partner payment country |
include_payment_process_partner_include_address_street_address | string | Partner street address |
include_payment_process_partner_include_address_city | string | Partner city |
include_payment_process_partner_include_address_state | string | Partner state |
include_payment_process_partner_include_address_zipcode | string | Partner zip code |
include_payment_schedule | boolean | Whether to include a payment schedule. Default: false |
include_payment_schedule_type | string | Payment schedule type: "specified" (default) or "custom" |
include_payment_schedule_specified_amount | integer | Payment schedule amount |
include_payment_schedule_specified_unit | string | Payment schedule unit. One of: "day(s)", "week(s)", "month(s)", "quarter(s)", "year(s)". Default: "day(s)" |
include_payment_schedule_specified_timeframe | string | Payment schedule timeframe. One of: "receipt", "date" |
include_payment_schedule_custom | string | Custom payment schedule description |
BAA
Business Associate Agreement (HIPAA).
| Parameter | Type | Description |
|---|---|---|
effective_date_type | string | "signature" (default) or "date" |
effective_date | date | Required when effective_date_type is "date" |
business_associate_relationship_type | string | Nature of the business associate relationship. One of: "provider", "company". Default: "provider" |
breach_notification_val | integer | Number of days for breach notification. Default: 30 |
breach_notification_unit | string | Unit for breach notification period. One of: "hours", "business days", "calendar days". Default: "calendar days" |
include_limitations | boolean | Whether to include usage/disclosure limitations. Default: false |
include_subcontract_limitations | boolean | Whether to include subcontractor limitations. Default: false |
subcontract_limitations_permitted | boolean | Whether subcontracting is permitted. Default: false |
include_offshore_limitations | boolean | Whether to restrict offshore processing. Default: false |
offshore_limitations_permitted | boolean | Whether offshore processing is permitted. Default: false |
include_deidentification_limitations | boolean | Whether to include de-identification limitations. Default: false |
deidentification_limitations_permitted | boolean | Whether de-identification is permitted. Default: false |
include_aggregation_limitations | boolean | Whether to include aggregation limitations. Default: false |
aggregation_limitations_permitted | boolean | Whether data aggregation is permitted. Default: false |
designated_record_set_provider_maintains | boolean | Whether the provider maintains the designated record set. Default: false |
attachment_ids | array | UUIDs of attachments to include |
LOI
Letter of Intent.
| Parameter | Type | Description |
|---|---|---|
product_name | string | Name of the product or service |
include_functionality | boolean | Whether to describe planned functionality. Default: false |
include_functionality_val | string | Description of the functionality |
include_fees | boolean | Whether fees are included. Default: false |
include_fees_include_amount | boolean | Whether to specify a fee amount. Default: false |
include_fees_amount | number | Fee amount |
include_fees_amount_duration | string | Duration for which fees apply. One of: "month", "year", "quarter" |
include_launch_date | boolean | Whether to include a target launch date. Default: false |
include_launch_date_type | string | "date" (default) or "custom" |
include_launch_date_date | datetime | Specific launch date |
include_launch_date_custom | string | Custom launch date description |
include_custom_details | boolean | Whether to include custom details. Default: false |
include_custom_details_val | string | Custom details text |
confidentiality_type | string | Confidentiality terms. One of: "mutual", "nda", "provider", "custom". Default: "mutual" |
confidentiality_nda_type | string | How the NDA is provided when confidentiality_type is "nda". One of: "description", "attachment". Default: "attachment" |
confidentiality_nda_attachment_id | uuid | Attachment ID of an existing NDA |
confidentiality_nda_description | string | Description of the NDA when confidentiality_nda_type is "description" |
attachment_ids | array | UUIDs 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:
| Parameter | Type | Description |
|---|---|---|
type | string | Fee class. See fee types below. |
description | string | Display label for the fee |
quantity | integer | Quantity (for per-unit fees) |
cost | number | Fee 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_id | string | Stripe product ID (for Stripe-linked fees) |
discount_type | string | For Fees::Discount: "fixed_amount" (default) or "percentage" |
discount_duration_type | string | For Fees::Discount: "forever" (default), "once", or "multiple_months" |
discount_duration_amount | integer | For Fees::Discount with "multiple_months" duration: number of months |
attachment_id | uuid | For Fees::Attachment: the attachment UUID |
graduated_fee_tiers_attributes | array | For Fees::Graduated: array of tiers with upper_limit, price_per_unit, and flat_price |
id | uuid | ID of an existing fee to update or remove. Omit to add a new fee |
_destroy | boolean | Set to true with id to remove that fee |
Fee Types
| type | Description |
|---|---|
Fees::Flat | A fixed flat fee |
Fees::Discount | A discount applied to other fees |
Fees::Cost | A cost-based fee |
Fees::Attachment | A fee schedule provided as an attached document |
Fees::Graduated | A tiered/graduated fee structure |
Fees::Included | A fee described as included in the price |
Fees::Metered | A usage-based metered fee |
Fees::OneTime | A one-time fee |
Fees::Text | A text-only fee description (no amount) |